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>
This commit is contained in:
parent
4a840d5fdc
commit
481cc97349
|
@ -0,0 +1,5 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
===========
|
||||
Boot Memory
|
||||
===========
|
|
@ -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
|
||||
|
|
|
@ -0,0 +1,5 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
======================
|
||||
Out Of Memory Handling
|
||||
======================
|
|
@ -0,0 +1,5 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
===============
|
||||
Page Allocation
|
||||
===============
|
|
@ -0,0 +1,5 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
==========
|
||||
Page Cache
|
||||
==========
|
|
@ -0,0 +1,5 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
============
|
||||
Page Reclaim
|
||||
============
|
|
@ -0,0 +1,5 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
===========
|
||||
Page Tables
|
||||
===========
|
|
@ -0,0 +1,5 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
===============
|
||||
Physical Memory
|
||||
===============
|
|
@ -0,0 +1,5 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
=================
|
||||
Process Addresses
|
||||
=================
|
|
@ -0,0 +1,5 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
========================
|
||||
Shared Memory Filesystem
|
||||
========================
|
|
@ -0,0 +1,5 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
===============
|
||||
Slab Allocation
|
||||
===============
|
|
@ -0,0 +1,5 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
====
|
||||
Swap
|
||||
====
|
|
@ -0,0 +1,5 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
======================================
|
||||
Virtually Contiguous Memory Allocation
|
||||
======================================
|
Loading…
Reference in New Issue