Re: [PATCH 2/2] docs/vm: split memory hotplug notifier description to Documentation/core-api
On Sun, Oct 07, 2018 at 08:46:40AM -0600, Jonathan Corbet wrote: > On Fri, 5 Oct 2018 01:11:01 +0300 > Mike Rapoport wrote: > > > The memory hotplug notifier description is about kernel internals rather > > than admin/user visible API. Place it appropriately. > > > > Signed-off-by: Mike Rapoport > > One little nit... > > > Documentation/admin-guide/mm/memory-hotplug.rst| 83 > > - > > Documentation/core-api/index.rst | 2 + > > Documentation/core-api/memory-hotplug-notifier.rst | 84 > > ++ > > 3 files changed, 86 insertions(+), 83 deletions(-) > > create mode 100644 Documentation/core-api/memory-hotplug-notifier.rst > > > > diff --git a/Documentation/admin-guide/mm/memory-hotplug.rst > > b/Documentation/admin-guide/mm/memory-hotplug.rst > > index a33090c..0b9c83e 100644 > > --- a/Documentation/admin-guide/mm/memory-hotplug.rst > > +++ b/Documentation/admin-guide/mm/memory-hotplug.rst > > @@ -31,7 +31,6 @@ be changed often. > > 6.1 Memory offline and ZONE_MOVABLE > > 6.2. How to offline memory > >7. Physical memory remove > > - 8. Memory hotplug event notifier > >9. Future Work List > > That leaves a gap in the numbering here. > > In general, the best solution to this sort of issue is to take the TOC out > entirely and let Sphinx worry about generating it. People tend not to > think about updating the TOC when they make changes elsewhere, so it often > goes out of sync with the rest of the document anyway. > > I'll apply these, but please feel free to send a patch to fix this up. Sure, below > Thanks, > > jon > >From 45ef951bd04e9d440a0158f991a188fc8ca6e7d4 Mon Sep 17 00:00:00 2001 From: Mike Rapoport Date: Sun, 7 Oct 2018 19:29:00 +0300 Subject: [PATCH] docs/admin-guide: memory-hotplug: remove table of contents Remove "manual" table of contents and leave only the ReST tag so that Sphinx will take care of TOC generation. Signed-off-by: Mike Rapoport --- Documentation/admin-guide/mm/memory-hotplug.rst | 21 - 1 file changed, 21 deletions(-) diff --git a/Documentation/admin-guide/mm/memory-hotplug.rst b/Documentation/admin-guide/mm/memory-hotplug.rst index 0b9c83e..25157ae 100644 --- a/Documentation/admin-guide/mm/memory-hotplug.rst +++ b/Documentation/admin-guide/mm/memory-hotplug.rst @@ -13,27 +13,6 @@ be changed often. .. contents:: :local: -.. CONTENTS - - 1. Introduction -1.1 Purpose of memory hotplug -1.2. Phases of memory hotplug -1.3. Unit of Memory online/offline operation - 2. Kernel Configuration - 3. sysfs files for memory hotplug - 4. Physical memory hot-add phase -4.1 Hardware(Firmware) Support -4.2 Notify memory hot-add event by hand - 5. Logical Memory hot-add phase -5.1. State of memory -5.2. How to online memory - 6. Logical memory remove -6.1 Memory offline and ZONE_MOVABLE -6.2. How to offline memory - 7. Physical memory remove - 9. Future Work List - - .. note:: (1) x86_64's has special implementation for memory hotplug. -- 2.7.4
Re: [PATCH] docs: improve readability for people with poorer eyesight
On Thu, 4 Oct 2018 18:06:03 -0700 "Darrick J. Wong" wrote: > o my eyesight still hasn't fully recovered, so in the meantime it's > been difficult to read the online documentation. Here's some stylesheet > overrides I've been using to make it easier for me to read them: > https://djwong.org/docs/kdoc/index.html > > --- > From: Darrick J. Wong > > My eyesight is not in good shape, which means that I have difficulty > reading the online Linux documentation. Specifically, body text is > oddly small compared to list items and the contrast of various text > elements is too low for me to be able to see easily. > > Therefore, alter the HTML theme overrides to make the text larger and > increase the contrast for better visibility, and trust the typeface > choices of the reader's browser. > > For the PDF output, increase the text size, use a sans-serif typeface > for sans-serif text, and use a serif typeface for "roman" serif text. > > Signed-off-by: Darrick J. Wong I've been wanting to find some time to work on our stylesheets for years; what we have now is far from ideal (or attractive) IMO. This is a good step in the right direction - applied, thanks. jon
Re: [PATCH 2/2] docs/vm: split memory hotplug notifier description to Documentation/core-api
On Fri, 5 Oct 2018 01:11:01 +0300 Mike Rapoport wrote: > The memory hotplug notifier description is about kernel internals rather > than admin/user visible API. Place it appropriately. > > Signed-off-by: Mike Rapoport One little nit... > Documentation/admin-guide/mm/memory-hotplug.rst| 83 - > Documentation/core-api/index.rst | 2 + > Documentation/core-api/memory-hotplug-notifier.rst | 84 > ++ > 3 files changed, 86 insertions(+), 83 deletions(-) > create mode 100644 Documentation/core-api/memory-hotplug-notifier.rst > > diff --git a/Documentation/admin-guide/mm/memory-hotplug.rst > b/Documentation/admin-guide/mm/memory-hotplug.rst > index a33090c..0b9c83e 100644 > --- a/Documentation/admin-guide/mm/memory-hotplug.rst > +++ b/Documentation/admin-guide/mm/memory-hotplug.rst > @@ -31,7 +31,6 @@ be changed often. > 6.1 Memory offline and ZONE_MOVABLE > 6.2. How to offline memory >7. Physical memory remove > - 8. Memory hotplug event notifier >9. Future Work List That leaves a gap in the numbering here. In general, the best solution to this sort of issue is to take the TOC out entirely and let Sphinx worry about generating it. People tend not to think about updating the TOC when they make changes elsewhere, so it often goes out of sync with the rest of the document anyway. I'll apply these, but please feel free to send a patch to fix this up. Thanks, jon
Re: [PATCH 2/2] docs: promote the ext4 data structures book to top level
On Fri, 5 Oct 2018 19:49:52 -0400 "Theodore Y. Ts'o" wrote: > On Thu, Oct 04, 2018 at 05:59:44PM -0700, Darrick J. Wong wrote: > > From: Darrick J. Wong > > > > Move the ext4 data structures book to Documentation/filesystems/ext4/ > > since the administrative information moved elsewhere. > > > > Signed-off-by: Darrick J. Wong > > Thanks, applied and pushed out to the ext4.git tree. > > Randy, Jon: the original patch didn't make it past vger.kernel.org > because it was too large (it was moving a lot of files around). It > looked fine to me, but if you want to take a look it should be on the > dev branch of the ext4.git tree. FWIW, from a quick look it seems fine to me. Acked-by: Jonathan Corbet (though I expect it's too late to add that). jon
