Commit 00cba6b6 authored by Mike Rapoport (IBM)'s avatar Mike Rapoport (IBM) Committed by Jonathan Corbet

docs/admin-guide/mm: remove useless markup

It is enough to use a file name to cross-reference another rst document.

Jon says:
  The right things will happen in the HTML output, readers of the
  plain-text will know immediately where to go, and we don't have to add
  the label clutter.

Drop reference markup and unnecessary labels and use plain file names.
Signed-off-by: default avatarMike Rapoport (IBM) <rppt@kernel.org>
Link: https://lore.kernel.org/r/20230201094156.991542-4-rppt@kernel.orgSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent ee865889
.. _mm_concepts:
================= =================
Concepts overview Concepts overview
================= =================
...@@ -86,16 +84,15 @@ memory with the huge pages. The first one is `HugeTLB filesystem`, or ...@@ -86,16 +84,15 @@ memory with the huge pages. The first one is `HugeTLB filesystem`, or
hugetlbfs. It is a pseudo filesystem that uses RAM as its backing hugetlbfs. It is a pseudo filesystem that uses RAM as its backing
store. For the files created in this filesystem the data resides in store. For the files created in this filesystem the data resides in
the memory and mapped using huge pages. The hugetlbfs is described at the memory and mapped using huge pages. The hugetlbfs is described at
:ref:`Documentation/admin-guide/mm/hugetlbpage.rst <hugetlbpage>`. Documentation/admin-guide/mm/hugetlbpage.rst.
Another, more recent, mechanism that enables use of the huge pages is Another, more recent, mechanism that enables use of the huge pages is
called `Transparent HugePages`, or THP. Unlike the hugetlbfs that called `Transparent HugePages`, or THP. Unlike the hugetlbfs that
requires users and/or system administrators to configure what parts of requires users and/or system administrators to configure what parts of
the system memory should and can be mapped by the huge pages, THP the system memory should and can be mapped by the huge pages, THP
manages such mappings transparently to the user and hence the manages such mappings transparently to the user and hence the
name. See name. See Documentation/admin-guide/mm/transhuge.rst for more details
:ref:`Documentation/admin-guide/mm/transhuge.rst <admin_guide_transhuge>` about THP.
for more details about THP.
Zones Zones
===== =====
...@@ -125,8 +122,8 @@ processor. Each bank is referred to as a `node` and for each node Linux ...@@ -125,8 +122,8 @@ processor. Each bank is referred to as a `node` and for each node Linux
constructs an independent memory management subsystem. A node has its constructs an independent memory management subsystem. A node has its
own set of zones, lists of free and used pages and various statistics own set of zones, lists of free and used pages and various statistics
counters. You can find more details about NUMA in counters. You can find more details about NUMA in
:ref:`Documentation/mm/numa.rst <numa>` and in Documentation/mm/numa.rst` and in
:ref:`Documentation/admin-guide/mm/numa_memory_policy.rst <numa_memory_policy>`. Documentation/admin-guide/mm/numa_memory_policy.rst.
Page cache Page cache
========== ==========
......
.. _hugetlbpage:
============= =============
HugeTLB Pages HugeTLB Pages
============= =============
...@@ -313,7 +311,7 @@ memory policy mode--bind, preferred, local or interleave--may be used. The ...@@ -313,7 +311,7 @@ memory policy mode--bind, preferred, local or interleave--may be used. The
resulting effect on persistent huge page allocation is as follows: resulting effect on persistent huge page allocation is as follows:
#. Regardless of mempolicy mode [see #. Regardless of mempolicy mode [see
:ref:`Documentation/admin-guide/mm/numa_memory_policy.rst <numa_memory_policy>`], Documentation/admin-guide/mm/numa_memory_policy.rst],
persistent huge pages will be distributed across the node or nodes persistent huge pages will be distributed across the node or nodes
specified in the mempolicy as if "interleave" had been specified. specified in the mempolicy as if "interleave" had been specified.
However, if a node in the policy does not contain sufficient contiguous However, if a node in the policy does not contain sufficient contiguous
......
.. _idle_page_tracking:
================== ==================
Idle Page Tracking Idle Page Tracking
================== ==================
...@@ -70,9 +68,8 @@ If the tool is run initially with the appropriate option, it will mark all the ...@@ -70,9 +68,8 @@ If the tool is run initially with the appropriate option, it will mark all the
queried pages as idle. Subsequent runs of the tool can then show which pages have queried pages as idle. Subsequent runs of the tool can then show which pages have
their idle flag cleared in the interim. their idle flag cleared in the interim.
See :ref:`Documentation/admin-guide/mm/pagemap.rst <pagemap>` for more See Documentation/admin-guide/mm/pagemap.rst for more information about
information about ``/proc/pid/pagemap``, ``/proc/kpageflags``, and ``/proc/pid/pagemap``, ``/proc/kpageflags``, and ``/proc/kpagecgroup``.
``/proc/kpagecgroup``.
.. _impl_details: .. _impl_details:
......
...@@ -16,8 +16,7 @@ are described in Documentation/admin-guide/sysctl/vm.rst and in `man 5 proc`_. ...@@ -16,8 +16,7 @@ are described in Documentation/admin-guide/sysctl/vm.rst and in `man 5 proc`_.
.. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html .. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html
Linux memory management has its own jargon and if you are not yet Linux memory management has its own jargon and if you are not yet
familiar with it, consider reading familiar with it, consider reading Documentation/admin-guide/mm/concepts.rst.
:ref:`Documentation/admin-guide/mm/concepts.rst <mm_concepts>`.
Here we document in detail how to interact with various mechanisms in Here we document in detail how to interact with various mechanisms in
the Linux memory management. the Linux memory management.
......
.. _admin_guide_ksm:
======================= =======================
Kernel Samepage Merging Kernel Samepage Merging
======================= =======================
......
.. _admin_guide_memory_hotplug:
================== ==================
Memory Hot(Un)Plug Memory Hot(Un)Plug
================== ==================
......
.. _numa_memory_policy:
================== ==================
NUMA Memory Policy NUMA Memory Policy
================== ==================
......
.. _numaperf:
============= =============
NUMA Locality NUMA Locality
============= =============
......
.. _pagemap:
============================= =============================
Examining Process Page Tables Examining Process Page Tables
============================= =============================
...@@ -19,10 +17,10 @@ There are four components to pagemap: ...@@ -19,10 +17,10 @@ There are four components to pagemap:
* Bits 0-4 swap type if swapped * Bits 0-4 swap type if swapped
* Bits 5-54 swap offset if swapped * Bits 5-54 swap offset if swapped
* Bit 55 pte is soft-dirty (see * Bit 55 pte is soft-dirty (see
:ref:`Documentation/admin-guide/mm/soft-dirty.rst <soft_dirty>`) Documentation/admin-guide/mm/soft-dirty.rst)
* Bit 56 page exclusively mapped (since 4.2) * Bit 56 page exclusively mapped (since 4.2)
* Bit 57 pte is uffd-wp write-protected (since 5.13) (see * Bit 57 pte is uffd-wp write-protected (since 5.13) (see
:ref:`Documentation/admin-guide/mm/userfaultfd.rst <userfaultfd>`) Documentation/admin-guide/mm/userfaultfd.rst)
* Bits 58-60 zero * Bits 58-60 zero
* Bit 61 page is file-page or shared-anon (since 3.5) * Bit 61 page is file-page or shared-anon (since 3.5)
* Bit 62 page swapped * Bit 62 page swapped
...@@ -105,8 +103,7 @@ Short descriptions to the page flags ...@@ -105,8 +103,7 @@ Short descriptions to the page flags
A compound page with order N consists of 2^N physically contiguous pages. A compound page with order N consists of 2^N physically contiguous pages.
A compound page with order 2 takes the form of "HTTT", where H donates its A compound page with order 2 takes the form of "HTTT", where H donates its
head page and T donates its tail page(s). The major consumers of compound head page and T donates its tail page(s). The major consumers of compound
pages are hugeTLB pages pages are hugeTLB pages (Documentation/admin-guide/mm/hugetlbpage.rst),
(:ref:`Documentation/admin-guide/mm/hugetlbpage.rst <hugetlbpage>`),
the SLUB etc. memory allocators and various device drivers. the SLUB etc. memory allocators and various device drivers.
However in this interface, only huge/giga pages are made visible However in this interface, only huge/giga pages are made visible
to end users. to end users.
...@@ -128,7 +125,7 @@ Short descriptions to the page flags ...@@ -128,7 +125,7 @@ Short descriptions to the page flags
Zero page for pfn_zero or huge_zero page. Zero page for pfn_zero or huge_zero page.
25 - IDLE 25 - IDLE
The page has not been accessed since it was marked idle (see The page has not been accessed since it was marked idle (see
:ref:`Documentation/admin-guide/mm/idle_page_tracking.rst <idle_page_tracking>`). Documentation/admin-guide/mm/idle_page_tracking.rst).
Note that this flag may be stale in case the page was accessed via Note that this flag may be stale in case the page was accessed via
a PTE. To make sure the flag is up-to-date one has to read a PTE. To make sure the flag is up-to-date one has to read
``/sys/kernel/mm/page_idle/bitmap`` first. ``/sys/kernel/mm/page_idle/bitmap`` first.
......
.. _shrinker_debugfs:
========================== ==========================
Shrinker Debugfs Interface Shrinker Debugfs Interface
========================== ==========================
......
.. _soft_dirty:
=============== ===============
Soft-Dirty PTEs Soft-Dirty PTEs
=============== ===============
......
.. _swap_numa:
=========================================== ===========================================
Automatically bind swap device to numa node Automatically bind swap device to numa node
=========================================== ===========================================
......
.. _admin_guide_transhuge:
============================ ============================
Transparent Hugepage Support Transparent Hugepage Support
============================ ============================
......
.. _userfaultfd:
=========== ===========
Userfaultfd Userfaultfd
=========== ===========
......
.. _zswap:
===== =====
zswap zswap
===== =====
......
...@@ -22,7 +22,7 @@ Linux内存管理是一个具有许多可配置设置的复杂系统, 且这些 ...@@ -22,7 +22,7 @@ Linux内存管理是一个具有许多可配置设置的复杂系统, 且这些
.. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html .. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html
Linux内存管理有它自己的术语,如果你还不熟悉它,请考虑阅读下面参考: Linux内存管理有它自己的术语,如果你还不熟悉它,请考虑阅读下面参考:
:ref:`Documentation/admin-guide/mm/concepts.rst <mm_concepts>`. Documentation/admin-guide/mm/concepts.rst.
在此目录下,我们详细描述了如何与Linux内存管理中的各种机制交互。 在此目录下,我们详细描述了如何与Linux内存管理中的各种机制交互。
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment