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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, May 04, 2022 at 06:12:09AM -0700, John Hubbard wrote:
> This needs to be properly merged with the existing index. Otherwise
> the result here is very confusing because there are two summaries
> and no explanation of what is going on here.
> 
> If I get a moment today, I'll take a quick shot at at merging them,
> and post some suggestions here, but just wanted to point that out
> before this goes in as-is.

John and I have chatted to understand what he was getting at here,
but haven't had a chance to review this change in-person yet.

+++ b/Documentation/vm/index.rst
@@ -2,6 +2,9 @@
 Linux Memory Management Documentation
 =====================================

+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,
@@ -24,10 +27,14 @@ see the :doc:`admin guide <../admin-guide/mm/index>`.
    shmfs
    oom
 
-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.
+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
+structures and algorithms.  It should all be integrated nicely into the
+above structured documentation, or deleted if it has served its purpose.
 
 .. toctree::
    :maxdepth: 1




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux