Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: 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>

authored by

Mike Rapoport (IBM) and committed by
Jonathan Corbet
00cba6b6 ee865889

+14 -46
+5 -8
Documentation/admin-guide/mm/concepts.rst
··· 1 - .. _mm_concepts: 2 - 3 1 ================= 4 2 Concepts overview 5 3 ================= ··· 84 86 hugetlbfs. It is a pseudo filesystem that uses RAM as its backing 85 87 store. For the files created in this filesystem the data resides in 86 88 the memory and mapped using huge pages. The hugetlbfs is described at 87 - :ref:`Documentation/admin-guide/mm/hugetlbpage.rst <hugetlbpage>`. 89 + Documentation/admin-guide/mm/hugetlbpage.rst. 88 90 89 91 Another, more recent, mechanism that enables use of the huge pages is 90 92 called `Transparent HugePages`, or THP. Unlike the hugetlbfs that 91 93 requires users and/or system administrators to configure what parts of 92 94 the system memory should and can be mapped by the huge pages, THP 93 95 manages such mappings transparently to the user and hence the 94 - name. See 95 - :ref:`Documentation/admin-guide/mm/transhuge.rst <admin_guide_transhuge>` 96 - for more details about THP. 96 + name. See Documentation/admin-guide/mm/transhuge.rst for more details 97 + about THP. 97 98 98 99 Zones 99 100 ===== ··· 122 125 constructs an independent memory management subsystem. A node has its 123 126 own set of zones, lists of free and used pages and various statistics 124 127 counters. You can find more details about NUMA in 125 - :ref:`Documentation/mm/numa.rst <numa>` and in 126 - :ref:`Documentation/admin-guide/mm/numa_memory_policy.rst <numa_memory_policy>`. 128 + Documentation/mm/numa.rst` and in 129 + Documentation/admin-guide/mm/numa_memory_policy.rst. 127 130 128 131 Page cache 129 132 ==========
+1 -3
Documentation/admin-guide/mm/hugetlbpage.rst
··· 1 - .. _hugetlbpage: 2 - 3 1 ============= 4 2 HugeTLB Pages 5 3 ============= ··· 311 313 resulting effect on persistent huge page allocation is as follows: 312 314 313 315 #. Regardless of mempolicy mode [see 314 - :ref:`Documentation/admin-guide/mm/numa_memory_policy.rst <numa_memory_policy>`], 316 + Documentation/admin-guide/mm/numa_memory_policy.rst], 315 317 persistent huge pages will be distributed across the node or nodes 316 318 specified in the mempolicy as if "interleave" had been specified. 317 319 However, if a node in the policy does not contain sufficient contiguous
+2 -5
Documentation/admin-guide/mm/idle_page_tracking.rst
··· 1 - .. _idle_page_tracking: 2 - 3 1 ================== 4 2 Idle Page Tracking 5 3 ================== ··· 68 70 queried pages as idle. Subsequent runs of the tool can then show which pages have 69 71 their idle flag cleared in the interim. 70 72 71 - See :ref:`Documentation/admin-guide/mm/pagemap.rst <pagemap>` for more 72 - information about ``/proc/pid/pagemap``, ``/proc/kpageflags``, and 73 - ``/proc/kpagecgroup``. 73 + See Documentation/admin-guide/mm/pagemap.rst for more information about 74 + ``/proc/pid/pagemap``, ``/proc/kpageflags``, and ``/proc/kpagecgroup``. 74 75 75 76 .. _impl_details: 76 77
+1 -2
Documentation/admin-guide/mm/index.rst
··· 16 16 .. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html 17 17 18 18 Linux memory management has its own jargon and if you are not yet 19 - familiar with it, consider reading 20 - :ref:`Documentation/admin-guide/mm/concepts.rst <mm_concepts>`. 19 + familiar with it, consider reading Documentation/admin-guide/mm/concepts.rst. 21 20 22 21 Here we document in detail how to interact with various mechanisms in 23 22 the Linux memory management.
-2
Documentation/admin-guide/mm/ksm.rst
··· 1 - .. _admin_guide_ksm: 2 - 3 1 ======================= 4 2 Kernel Samepage Merging 5 3 =======================
-2
Documentation/admin-guide/mm/memory-hotplug.rst
··· 1 - .. _admin_guide_memory_hotplug: 2 - 3 1 ================== 4 2 Memory Hot(Un)Plug 5 3 ==================
-2
Documentation/admin-guide/mm/numa_memory_policy.rst
··· 1 - .. _numa_memory_policy: 2 - 3 1 ================== 4 2 NUMA Memory Policy 5 3 ==================
-2
Documentation/admin-guide/mm/numaperf.rst
··· 1 - .. _numaperf: 2 - 3 1 ============= 4 2 NUMA Locality 5 3 =============
+4 -7
Documentation/admin-guide/mm/pagemap.rst
··· 1 - .. _pagemap: 2 - 3 1 ============================= 4 2 Examining Process Page Tables 5 3 ============================= ··· 17 19 * Bits 0-4 swap type if swapped 18 20 * Bits 5-54 swap offset if swapped 19 21 * Bit 55 pte is soft-dirty (see 20 - :ref:`Documentation/admin-guide/mm/soft-dirty.rst <soft_dirty>`) 22 + Documentation/admin-guide/mm/soft-dirty.rst) 21 23 * Bit 56 page exclusively mapped (since 4.2) 22 24 * Bit 57 pte is uffd-wp write-protected (since 5.13) (see 23 - :ref:`Documentation/admin-guide/mm/userfaultfd.rst <userfaultfd>`) 25 + Documentation/admin-guide/mm/userfaultfd.rst) 24 26 * Bits 58-60 zero 25 27 * Bit 61 page is file-page or shared-anon (since 3.5) 26 28 * Bit 62 page swapped ··· 103 105 A compound page with order N consists of 2^N physically contiguous pages. 104 106 A compound page with order 2 takes the form of "HTTT", where H donates its 105 107 head page and T donates its tail page(s). The major consumers of compound 106 - pages are hugeTLB pages 107 - (:ref:`Documentation/admin-guide/mm/hugetlbpage.rst <hugetlbpage>`), 108 + pages are hugeTLB pages (Documentation/admin-guide/mm/hugetlbpage.rst), 108 109 the SLUB etc. memory allocators and various device drivers. 109 110 However in this interface, only huge/giga pages are made visible 110 111 to end users. ··· 125 128 Zero page for pfn_zero or huge_zero page. 126 129 25 - IDLE 127 130 The page has not been accessed since it was marked idle (see 128 - :ref:`Documentation/admin-guide/mm/idle_page_tracking.rst <idle_page_tracking>`). 131 + Documentation/admin-guide/mm/idle_page_tracking.rst). 129 132 Note that this flag may be stale in case the page was accessed via 130 133 a PTE. To make sure the flag is up-to-date one has to read 131 134 ``/sys/kernel/mm/page_idle/bitmap`` first.
-2
Documentation/admin-guide/mm/shrinker_debugfs.rst
··· 1 - .. _shrinker_debugfs: 2 - 3 1 ========================== 4 2 Shrinker Debugfs Interface 5 3 ==========================
-2
Documentation/admin-guide/mm/soft-dirty.rst
··· 1 - .. _soft_dirty: 2 - 3 1 =============== 4 2 Soft-Dirty PTEs 5 3 ===============
-2
Documentation/admin-guide/mm/swap_numa.rst
··· 1 - .. _swap_numa: 2 - 3 1 =========================================== 4 2 Automatically bind swap device to numa node 5 3 ===========================================
-2
Documentation/admin-guide/mm/transhuge.rst
··· 1 - .. _admin_guide_transhuge: 2 - 3 1 ============================ 4 2 Transparent Hugepage Support 5 3 ============================
-2
Documentation/admin-guide/mm/userfaultfd.rst
··· 1 - .. _userfaultfd: 2 - 3 1 =========== 4 2 Userfaultfd 5 3 ===========
-2
Documentation/admin-guide/mm/zswap.rst
··· 1 - .. _zswap: 2 - 3 1 ===== 4 2 zswap 5 3 =====
+1 -1
Documentation/translations/zh_CN/admin-guide/mm/index.rst
··· 22 22 .. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html 23 23 24 24 Linux内存管理有它自己的术语,如果你还不熟悉它,请考虑阅读下面参考: 25 - :ref:`Documentation/admin-guide/mm/concepts.rst <mm_concepts>`. 25 + Documentation/admin-guide/mm/concepts.rst. 26 26 27 27 在此目录下,我们详细描述了如何与Linux内存管理中的各种机制交互。 28 28