Re: [PATCH 2/2] docs/vm: split memory hotplug notifier description to Documentation/core-api

[Jonathan Corbet <corbet@lwn.net>]

On Fri,  5 Oct 2018 01:11:01 +0300
Mike Rapoport <rppt@linux.vnet.ibm.com> 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@linux.vnet.ibm.com>

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