On Sun, Oct 07, 2018 at 08:46:40AM -0600, Jonathan Corbet wrote:
> On Fri, 5 Oct 2018 01:11:01 +0300
> Mike Rapoport <rppt@xxxxxxxxxxxxxxxxxx> wrote:
>
> > The memory hotplug notifier description is about kernel internals rather
> > than admin/user visible API. Place it appropriately.
> >
> > Signed-off-by: Mike Rapoport <rppt@xxxxxxxxxxxxxxxxxx>
>
> 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 <rppt@xxxxxxxxxxxxxxxxxx>
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 <rppt@xxxxxxxxxxxxxxxxxx>
---
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
