docs/admin-guide/mm: remove useless markup
authorMike Rapoport (IBM) <rppt@kernel.org>
Wed, 1 Feb 2023 09:41:56 +0000 (11:41 +0200)
committerJonathan Corbet <corbet@lwn.net>
Thu, 2 Feb 2023 17:18:05 +0000 (10:18 -0700)
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: Mike Rapoport (IBM) <rppt@kernel.org>
Link: https://lore.kernel.org/r/20230201094156.991542-4-rppt@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
16 files changed:
Documentation/admin-guide/mm/concepts.rst
Documentation/admin-guide/mm/hugetlbpage.rst
Documentation/admin-guide/mm/idle_page_tracking.rst
Documentation/admin-guide/mm/index.rst
Documentation/admin-guide/mm/ksm.rst
Documentation/admin-guide/mm/memory-hotplug.rst
Documentation/admin-guide/mm/numa_memory_policy.rst
Documentation/admin-guide/mm/numaperf.rst
Documentation/admin-guide/mm/pagemap.rst
Documentation/admin-guide/mm/shrinker_debugfs.rst
Documentation/admin-guide/mm/soft-dirty.rst
Documentation/admin-guide/mm/swap_numa.rst
Documentation/admin-guide/mm/transhuge.rst
Documentation/admin-guide/mm/userfaultfd.rst
Documentation/admin-guide/mm/zswap.rst
Documentation/translations/zh_CN/admin-guide/mm/index.rst

index c79f1e336222029b21732c23c95daa58d88f9e49..e796b0a7e4a51c14ff6f1345ae6ba2218d6cd5f3 100644 (file)
@@ -1,5 +1,3 @@
-.. _mm_concepts:
-
 =================
 Concepts overview
 =================
@@ -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
 store. For the files created in this filesystem the data resides in
 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
 called `Transparent HugePages`, or THP. Unlike the hugetlbfs that
 requires users and/or system administrators to configure what parts of
 the system memory should and can be mapped by the huge pages, THP
 manages such mappings transparently to the user and hence the
-name. See
-:ref:`Documentation/admin-guide/mm/transhuge.rst <admin_guide_transhuge>`
-for more details about THP.
+name. See Documentation/admin-guide/mm/transhuge.rst for more details
+about THP.
 
 Zones
 =====
@@ -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
 own set of zones, lists of free and used pages and various statistics
 counters. You can find more details about NUMA in
-:ref:`Documentation/mm/numa.rst <numa>` and in
-:ref:`Documentation/admin-guide/mm/numa_memory_policy.rst <numa_memory_policy>`.
+Documentation/mm/numa.rst` and in
+Documentation/admin-guide/mm/numa_memory_policy.rst.
 
 Page cache
 ==========
index 19f27c0d92e074a7e829ed0eb1d403fe9bb65709..5f9121b287d915a3efb3082b898893417ac0d14e 100644 (file)
@@ -1,5 +1,3 @@
-.. _hugetlbpage:
-
 =============
 HugeTLB Pages
 =============
@@ -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:
 
 #. 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
    specified in the mempolicy as if "interleave" had been specified.
    However, if a node in the policy does not contain sufficient contiguous
index df9394fb39c2a1f7afb96c8d2825a21e41f08f21..b5a285bd73fd376eefc6dd53cc776a989eaa40d4 100644 (file)
@@ -1,5 +1,3 @@
-.. _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
 queried pages as idle.  Subsequent runs of the tool can then show which pages have
 their idle flag cleared in the interim.
 
-See :ref:`Documentation/admin-guide/mm/pagemap.rst <pagemap>` for more
-information about ``/proc/pid/pagemap``, ``/proc/kpageflags``, and
-``/proc/kpagecgroup``.
+See Documentation/admin-guide/mm/pagemap.rst for more information about
+``/proc/pid/pagemap``, ``/proc/kpageflags``, and ``/proc/kpagecgroup``.
 
 .. _impl_details:
 
index d1064e0ba34a295cd678ab0e00f021445af3220d..1f883abf3f00fa7311b0d16081039c74dfcf2919 100644 (file)
@@ -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
 
 Linux memory management has its own jargon and if you are not yet
-familiar with it, consider reading
-:ref:`Documentation/admin-guide/mm/concepts.rst <mm_concepts>`.
+familiar with it, consider reading Documentation/admin-guide/mm/concepts.rst.
 
 Here we document in detail how to interact with various mechanisms in
 the Linux memory management.
index fb6ba2002a4b2aaa73e20b7203578366ff8d472a..eed51a910c940e19b295eeb3825422a29f6aa39d 100644 (file)
@@ -1,5 +1,3 @@
-.. _admin_guide_ksm:
-
 =======================
 Kernel Samepage Merging
 =======================
index a3c9e8ad8fa0d83f0c30372958539c724aa0d86f..1b02fe5807cc6c67c52da9da4592d488918db3f5 100644 (file)
@@ -1,5 +1,3 @@
-.. _admin_guide_memory_hotplug:
-
 ==================
 Memory Hot(Un)Plug
 ==================
index 5a6afecbb0d070c05b86e4bbdb760a8dbb6554f5..f5cc2a368dac0e665086d6d8a839683bf126f12b 100644 (file)
@@ -1,5 +1,3 @@
-.. _numa_memory_policy:
-
 ==================
 NUMA Memory Policy
 ==================
index 1666973259479b0b945c18a3eec901c78db2d61d..24e63e740420c34c9832dcd7bd53b0de4c0dcd63 100644 (file)
@@ -1,5 +1,3 @@
-.. _numaperf:
-
 =============
 NUMA Locality
 =============
index 6e2e416af78380cea2cdd5d0fa6f9a86d175b49e..1a22674ab18ea50dd1099507d51689e0b2308227 100644 (file)
@@ -1,5 +1,3 @@
-.. _pagemap:
-
 =============================
 Examining Process Page Tables
 =============================
@@ -19,10 +17,10 @@ There are four components to pagemap:
     * Bits 0-4   swap type if swapped
     * Bits 5-54  swap offset if swapped
     * 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  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
     * Bit  61    page is file-page or shared-anon (since 3.5)
     * Bit  62    page swapped
@@ -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 2 takes the form of "HTTT", where H donates its
     head page and T donates its tail page(s).  The major consumers of compound
-    pages are hugeTLB pages
-    (:ref:`Documentation/admin-guide/mm/hugetlbpage.rst <hugetlbpage>`),
+    pages are hugeTLB pages (Documentation/admin-guide/mm/hugetlbpage.rst),
     the SLUB etc.  memory allocators and various device drivers.
     However in this interface, only huge/giga pages are made visible
     to end users.
@@ -128,7 +125,7 @@ Short descriptions to the page flags
     Zero page for pfn_zero or huge_zero page.
 25 - IDLE
     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
     a PTE. To make sure the flag is up-to-date one has to read
     ``/sys/kernel/mm/page_idle/bitmap`` first.
index 3887f0b294fe881017a37e4868a96c5579546d26..c582033bd11382fe6c32aaaa0f5459a85711262b 100644 (file)
@@ -1,5 +1,3 @@
-.. _shrinker_debugfs:
-
 ==========================
 Shrinker Debugfs Interface
 ==========================
index cb0cfd6672fa79186b5818425e605cf03e904e0e..aeea936caa44580ba23b3dfd45f1b07543287e2a 100644 (file)
@@ -1,5 +1,3 @@
-.. _soft_dirty:
-
 ===============
 Soft-Dirty PTEs
 ===============
index e0466f2db8fa0541d2c79f70ca0d9c69c95d443b..2e630627bceec00ddab4be1955f39963ba28cbcb 100644 (file)
@@ -1,5 +1,3 @@
-.. _swap_numa:
-
 ===========================================
 Automatically bind swap device to numa node
 ===========================================
index 8ee78ec232ebcf73228abb95c308c0eaac3fc3b0..b0cc8243e0934096508e984fa16ebc27c940277d 100644 (file)
@@ -1,5 +1,3 @@
-.. _admin_guide_transhuge:
-
 ============================
 Transparent Hugepage Support
 ============================
index 83f31919ebb3cd298aeb7e7dd94858579626778f..7dc823b56ca43948e6312482588602ae2ebafd8b 100644 (file)
@@ -1,5 +1,3 @@
-.. _userfaultfd:
-
 ===========
 Userfaultfd
 ===========
index f67de481c7f60559c169ac0ba7e8dcaff24b5da9..fa5f6c9c78f35226f0857c8d060b17ffe1b3025c 100644 (file)
@@ -1,5 +1,3 @@
-.. _zswap:
-
 =====
 zswap
 =====
index 702271c5b6839fd896bd1529998ef1be0cf8c8a0..a8fd2c4a8796ce4ffcbaa437e0fe425c23aae429 100644 (file)
@@ -22,7 +22,7 @@ Linux内存管理是一个具有许多可配置设置的复杂系统, 且这些
 .. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html
 
 Linux内存管理有它自己的术语,如果你还不熟悉它,请考虑阅读下面参考:
-:ref:`Documentation/admin-guide/mm/concepts.rst <mm_concepts>`.
+Documentation/admin-guide/mm/concepts.rst.
 
 在此目录下,我们详细描述了如何与Linux内存管理中的各种机制交互。