Re: [PATCH v2] mm,doc: Add new documentation structure

[Mike Rapoport <rppt@kernel.org>]

On Sat, May 07, 2022 at 02:49:47PM +0100, Matthew Wilcox (Oracle) wrote:
> Closely following the outline of Mel Gorman's book "Understanding the
> Linux Virtual Memory Manager", add a new outline.  Preserve the current
> contents of the mm underneath the new outline so we can transition those
> documents to a more sensible place later.
> 
> Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
> Reviewed-by: John Hubbard <jhubbard@nvidia.com>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Acked-by: Johannes Weiner <hannes@cmpxchg.org>

Small nit below, otherwise

Reviewed-by: Mike Rapoport <rppt@linux.ibm.com>

> ---
>  Documentation/vm/bootmem.rst         |  5 ++++
>  Documentation/vm/index.rst           | 40 +++++++++++++++++++++++-----
>  Documentation/vm/oom.rst             |  5 ++++
>  Documentation/vm/page_allocation.rst |  5 ++++
>  Documentation/vm/page_cache.rst      |  5 ++++
>  Documentation/vm/page_reclaim.rst    |  5 ++++
>  Documentation/vm/page_tables.rst     |  5 ++++
>  Documentation/vm/physical_memory.rst |  5 ++++
>  Documentation/vm/process_addrs.rst   |  5 ++++
>  Documentation/vm/shmfs.rst           |  5 ++++
>  Documentation/vm/slab.rst            |  5 ++++
>  Documentation/vm/swap.rst            |  5 ++++
>  Documentation/vm/vmalloc.rst         |  5 ++++
>  13 files changed, 93 insertions(+), 7 deletions(-)
>  create mode 100644 Documentation/vm/bootmem.rst
>  create mode 100644 Documentation/vm/oom.rst
>  create mode 100644 Documentation/vm/page_allocation.rst
>  create mode 100644 Documentation/vm/page_cache.rst
>  create mode 100644 Documentation/vm/page_reclaim.rst
>  create mode 100644 Documentation/vm/page_tables.rst
>  create mode 100644 Documentation/vm/physical_memory.rst
>  create mode 100644 Documentation/vm/process_addrs.rst
>  create mode 100644 Documentation/vm/shmfs.rst
>  create mode 100644 Documentation/vm/slab.rst
>  create mode 100644 Documentation/vm/swap.rst
>  create mode 100644 Documentation/vm/vmalloc.rst
> 
> diff --git a/Documentation/vm/bootmem.rst b/Documentation/vm/bootmem.rst
> new file mode 100644
> index 000000000000..eb2b31eedfa1
> --- /dev/null
> +++ b/Documentation/vm/bootmem.rst
> @@ -0,0 +1,5 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +===========
> +Boot Memory
> +===========
> diff --git a/Documentation/vm/index.rst b/Documentation/vm/index.rst
> index 44365c4574a3..e72736d53604 100644
> --- a/Documentation/vm/index.rst
> +++ b/Documentation/vm/index.rst
> @@ -2,12 +2,39 @@
>  Linux Memory Management Documentation
>  =====================================
>  
> -This is a collection of documents about the Linux memory management (mm)
> -subsystem internals with different level of details ranging from notes and
> -mailing list responses for elaborating descriptions of data structures and
> -algorithms.  If you are looking for advice on simply allocating memory, see the
> -:ref:`memory_allocation`.  For controlling and tuning guides, see the
> -:doc:`admin guide <../admin-guide/mm/index>`.
> +Memory Management Guide
> +=======================
> +
> +This is a guide to understanding the memory management subsystem
> +of Linux.  If you are looking for advice on simply allocating memory,
> +see the :ref:`memory_allocation`.  For controlling and tuning guides,
> +see the :doc:`admin guide <../admin-guide/mm/index>`.
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   physical_memory
> +   page_tables
> +   process_addrs
> +   bootmem
> +   page_allocation
> +   vmalloc
> +   slab
> +   highmem
> +   page_reclaim
> +   swap
> +   page_cache
> +   shmfs
> +   oom
> +
> +Legacy Documentation
> +====================
> +
> +This is a collection of older documents about the Linux memory management
> +(MM) subsystem internals with different level of details ranging from
> +notes and mailing list responses for elaborating descriptions of data

"... ranging from notes and mailing list responses to elaborate description
of data structures ..."

> +structures and algorithms.  It should all be integrated nicely into the
> +above structured documentation, or deleted if it has served its purpose.

-- 
Sincerely yours,
Mike.