aboutsummaryrefslogtreecommitdiff
path: root/Documentation/vm/index.rst
diff options
context:
space:
mode:
authorGravatar Jonathan Corbet <corbet@lwn.net> 2018-04-16 14:25:08 -0600
committerGravatar Jonathan Corbet <corbet@lwn.net> 2018-04-16 14:25:08 -0600
commit24844fd33945470942c954324ad2c655929000cc (patch)
tree391b2999f1900e0ca93349000fd8b334a77615c7 /Documentation/vm/index.rst
parentDocumentation: ftrace: clarify filters with dynamic ftrace and graph (diff)
parentdocs/vm: add index.rst and link MM documentation to top level index (diff)
downloadlinux-24844fd33945470942c954324ad2c655929000cc.tar.gz
linux-24844fd33945470942c954324ad2c655929000cc.tar.bz2
linux-24844fd33945470942c954324ad2c655929000cc.zip
Merge branch 'mm-rst' into docs-next
Mike Rapoport says: These patches convert files in Documentation/vm to ReST format, add an initial index and link it to the top level documentation. There are no contents changes in the documentation, except few spelling fixes. The relatively large diffstat stems from the indentation and paragraph wrapping changes. I've tried to keep the formatting as consistent as possible, but I could miss some places that needed markup and add some markup where it was not necessary. [jc: significant conflicts in vm/hmm.rst]
Diffstat (limited to 'Documentation/vm/index.rst')
-rw-r--r--Documentation/vm/index.rst56
1 files changed, 56 insertions, 0 deletions
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