diff options
| author | Mike Rapoport <rppt@linux.vnet.ibm.com> | 2018-03-21 21:22:48 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2018-04-16 14:18:15 -0600 |
| commit | 82381918c4712ba107d3e4ff7117751f396018f7 (patch) | |
| tree | 510451564073399d8b3bcfb495ac1482ab0bccfe | |
| parent | ad56b738c5dd223a2f66685830f82194025a6138 (diff) | |
| download | linux-82381918c4712ba107d3e4ff7117751f396018f7.tar.bz2 | |
docs/vm: add index.rst and link MM documentation to top level index
Signed-off-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/index.rst | 3 | ||||
| -rw-r--r-- | Documentation/vm/conf.py | 10 | ||||
| -rw-r--r-- | Documentation/vm/index.rst | 56 |
3 files changed, 68 insertions, 1 deletions
diff --git a/Documentation/index.rst b/Documentation/index.rst index 3b99ab931d41..fdc585703498 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -45,7 +45,7 @@ the kernel interface as seen by application developers. .. toctree:: :maxdepth: 2 - userspace-api/index + userspace-api/index Introduction to kernel development @@ -89,6 +89,7 @@ needed). sound/index crypto/index filesystems/index + vm/index Architecture-specific documentation ----------------------------------- diff --git a/Documentation/vm/conf.py b/Documentation/vm/conf.py new file mode 100644 index 000000000000..3b0b601af558 --- /dev/null +++ b/Documentation/vm/conf.py @@ -0,0 +1,10 @@ +# -*- coding: utf-8; mode: python -*- + +project = "Linux Memory Management Documentation" + +tags.add("subproject") + +latex_documents = [ + ('index', 'memory-management.tex', project, + 'The kernel development community', 'manual'), +] diff --git a/Documentation/vm/index.rst b/Documentation/vm/index.rst new file mode 100644 index 000000000000..6c451421a01e --- /dev/null +++ b/Documentation/vm/index.rst @@ -0,0 +1,56 @@ +===================================== +Linux Memory Management Documentation +===================================== + +This is a collection of documents about Linux memory management (mm) subsystem. + +User guides for MM features +=========================== + +The following documents provide guides for controlling and tuning +various features of the Linux memory management + +.. toctree:: + :maxdepth: 1 + + hugetlbpage + idle_page_tracking + ksm + numa_memory_policy + pagemap + transhuge + soft-dirty + swap_numa + userfaultfd + zswap + +Kernel developers MM documentation +================================== + +The below documents describe MM internals with different level of +details ranging from notes and mailing list responses to elaborate +descriptions of data structures and algorithms. + +.. toctree:: + :maxdepth: 1 + + active_mm + balance + cleancache + frontswap + highmem + hmm + hwpoison + hugetlbfs_reserv + mmu_notifier + numa + overcommit-accounting + page_migration + page_frags + page_owner + remap_file_pages + slub + split_page_table_lock + unevictable-lru + z3fold + zsmalloc |