diff options
| author | Matthew Wilcox (Oracle) <willy@infradead.org> | 2022-05-07 14:49:47 +0100 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2022-05-09 16:41:24 -0600 |
| commit | 481cc97349d694e3211e14a886ad2b7ef55b5a2c (patch) | |
| tree | fd1518e58c9ef17267f294a3d6a29ae50d8fc3f0 /Documentation/vm/index.rst | |
| parent | 4a840d5fdcfcfff55b8b22896c1193a9b26405aa (diff) | |
mm,doc: Add new documentation structure
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>
Link: https://lore.kernel.org/r/20220507134947.444287-1-willy@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/vm/index.rst')
| -rw-r--r-- | Documentation/vm/index.rst | 40 |
1 files changed, 33 insertions, 7 deletions
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 +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 @@ -18,7 +45,6 @@ algorithms. If you are looking for advice on simply allocating memory, see the damon/index free_page_reporting frontswap - highmem hmm hwpoison hugetlbfs_reserv |