docs/mm: remove useless markup
authorMike Rapoport (IBM) <rppt@kernel.org>
Wed, 1 Feb 2023 09:41:55 +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-3-rppt@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
27 files changed:
Documentation/mm/active_mm.rst
Documentation/mm/arch_pgtable_helpers.rst
Documentation/mm/balance.rst
Documentation/mm/free_page_reporting.rst
Documentation/mm/frontswap.rst
Documentation/mm/highmem.rst
Documentation/mm/hmm.rst
Documentation/mm/hugetlbfs_reserv.rst
Documentation/mm/hwpoison.rst
Documentation/mm/ksm.rst
Documentation/mm/memory-model.rst
Documentation/mm/mmu_notifier.rst
Documentation/mm/numa.rst
Documentation/mm/page_frags.rst
Documentation/mm/page_migration.rst
Documentation/mm/page_owner.rst
Documentation/mm/page_table_check.rst
Documentation/mm/remap_file_pages.rst
Documentation/mm/slub.rst
Documentation/mm/split_page_table_lock.rst
Documentation/mm/transhuge.rst
Documentation/mm/unevictable-lru.rst
Documentation/mm/z3fold.rst
Documentation/mm/zsmalloc.rst
Documentation/translations/zh_CN/mm/hmm.rst
Documentation/translations/zh_CN/mm/hugetlbfs_reserv.rst
Documentation/translations/zh_CN/mm/numa.rst

index 6f8269c284eda0a450fe4d40ec0c2bd88d1200bb..45d89f8fb3a80b48e403922b11c1e8ca03476b11 100644 (file)
@@ -1,5 +1,3 @@
-.. _active_mm:
-
 =========
 Active MM
 =========
index fd2a19df884ed38c95913cf5e532c15f252ce412..30d9a09f01f4404e66f1a40726b5a8d1bb8b8bcc 100644 (file)
@@ -1,7 +1,5 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-.. _arch_page_table_helpers:
-
 ===============================
 Architecture Page Table Helpers
 ===============================
index 6a1fadf3e1735eb5b01837290730525c2d2a172d..6cd0127154ac467b665d4ce6fb33c98c0fc92282 100644 (file)
@@ -1,5 +1,3 @@
-.. _balance:
-
 ================
 Memory Balancing
 ================
index 8c05e62d8b2b6ae4da2cd0c193eb21c35161d95a..1468f71c261f841fa07f39617abb1ce9da1dbb6d 100644 (file)
@@ -1,5 +1,3 @@
-.. _free_page_reporting:
-
 =====================
 Free Page Reporting
 =====================
index feecc5e2447780c2edb7e5c28cf7f5178ff925c2..c892412988af264d34d39a98b31f719ad84aabda 100644 (file)
@@ -1,5 +1,3 @@
-.. _frontswap:
-
 =========
 Frontswap
 =========
index 0f731d9196b010c85d940234fbb1554924320224..bb3f90e195fa580ec329a6bf2a6aef402fb80b96 100644 (file)
@@ -1,5 +1,3 @@
-.. _highmem:
-
 ====================
 High Memory Handling
 ====================
index f2a59ed82ed374c14c1a9b55d630436d60529748..9aa512c3a12c6cda16cf37da3420f8cc941d5077 100644 (file)
@@ -1,5 +1,3 @@
-.. _hmm:
-
 =====================================
 Heterogeneous Memory Management (HMM)
 =====================================
@@ -304,7 +302,7 @@ devm_memunmap_pages(), and devm_release_mem_region() when the resources can
 be tied to a ``struct device``.
 
 The overall migration steps are similar to migrating NUMA pages within system
-memory (see :ref:`Page migration <page_migration>`) but the steps are split
+memory (see Documentation/mm/page_migration.rst) but the steps are split
 between device driver specific code and shared common code:
 
 1. ``mmap_read_lock()``
index f143954e0d05682e8282b5f8bf1018f9e7f61e70..05a44760da323b376447e9747546969c15b4d05b 100644 (file)
@@ -1,5 +1,3 @@
-.. _hugetlbfs_reserve:
-
 =====================
 Hugetlbfs Reservation
 =====================
@@ -7,7 +5,7 @@ Hugetlbfs Reservation
 Overview
 ========
 
-Huge pages as described at :ref:`hugetlbpage` are typically
+Huge pages as described at Documentation/mm/hugetlbpage.rst are typically
 preallocated for application use.  These huge pages are instantiated in a
 task's address space at page fault time if the VMA indicates huge pages are
 to be used.  If no huge page exists at page fault time, the task is sent
index b9d5253c1305762248c35be3d3512904c99a0ff0..ba48a441feed854cd16431cb50c816eb6d0c8971 100644 (file)
@@ -1,5 +1,3 @@
-.. hwpoison:
-
 ========
 hwpoison
 ========
index f83cfbc12f4ca9be68958fe7b76b5b41996a05e4..2806e3e4a10e56b20357233baa99d7119db7facb 100644 (file)
@@ -1,5 +1,3 @@
-.. _ksm:
-
 =======================
 Kernel Samepage Merging
 =======================
@@ -8,7 +6,7 @@ KSM is a memory-saving de-duplication feature, enabled by CONFIG_KSM=y,
 added to the Linux kernel in 2.6.32.  See ``mm/ksm.c`` for its implementation,
 and http://lwn.net/Articles/306704/ and https://lwn.net/Articles/330589/
 
-The userspace interface of KSM is described in :ref:`Documentation/admin-guide/mm/ksm.rst <admin_guide_ksm>`
+The userspace interface of KSM is described in Documentation/admin-guide/mm/ksm.rst
 
 Design
 ======
index 3779e562dc76e4e14dd7d127ec17fb842d71cbe9..5f3eafbbc52034f66579ddf7876f1f3640ba5fcf 100644 (file)
@@ -1,7 +1,5 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-.. _physical_memory_model:
-
 =====================
 Physical Memory Model
 =====================
index df5d7777fc6b53c49bb2d6b7bf16b51c5d110235..c687bea4922fca14579890201eace79a108d5539 100644 (file)
@@ -1,5 +1,3 @@
-.. _mmu_notifier:
-
 When do you need to notify inside page table lock ?
 ===================================================
 
index e1410974c9412ede7e65d8dde6a4e15a099ea079..0f1b56809dcab493dc9c4f9e85e17283bcd3acf9 100644 (file)
@@ -1,5 +1,3 @@
-.. _numa:
-
 Started Nov 1999 by Kanoj Sarcar <kanoj@sgi.com>
 
 =============
@@ -110,7 +108,7 @@ to improve NUMA locality using various CPU affinity command line interfaces,
 such as taskset(1) and numactl(1), and program interfaces such as
 sched_setaffinity(2).  Further, one can modify the kernel's default local
 allocation behavior using Linux NUMA memory policy. [see
-:ref:`Documentation/admin-guide/mm/numa_memory_policy.rst <numa_memory_policy>`].
+Documentation/admin-guide/mm/numa_memory_policy.rst].
 
 System administrators can restrict the CPUs and nodes' memories that a non-
 privileged user can specify in the scheduling or NUMA commands and functions
index 7d6f9385d129eb730094b87b18f14f879ab23c77..a81617e688a84fa063ffec59308a3c1a221112a2 100644 (file)
@@ -1,5 +1,3 @@
-.. _page_frags:
-
 ==============
 Page fragments
 ==============
index 11493bad71125207aa7412e4831861b66e4a4eb8..313dce18893e918e6bd45400ae477051c48dbdb2 100644 (file)
@@ -1,5 +1,3 @@
-.. _page_migration:
-
 ==============
 Page migration
 ==============
@@ -9,8 +7,8 @@ nodes in a NUMA system while the process is running. This means that the
 virtual addresses that the process sees do not change. However, the
 system rearranges the physical location of those pages.
 
-Also see :ref:`Heterogeneous Memory Management (HMM) <hmm>`
-for migrating pages to or from device private memory.
+Also see Documentation/mm/hmm.rst for migrating pages to or from device
+private memory.
 
 The main intent of page migration is to reduce the latency of memory accesses
 by moving pages near to the processor where the process accessing that memory
index 0f4cb59bcaf4d4701c3b9ecf46fbc7b6912e1d6f..e8d5090a9e6b9a8a9c8287e6019928065fa3efa5 100644 (file)
@@ -1,5 +1,3 @@
-.. _page_owner:
-
 ==================================================
 page owner: Tracking about who allocated each page
 ==================================================
index 1a09472f10a3c8a1c1b031df75084f46667f2bcc..cfd8f4117cf3e9a1ef4800653b19d3711fe069d7 100644 (file)
@@ -1,7 +1,5 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-.. _page_table_check:
-
 ================
 Page Table Check
 ================
index 7bef6718e3a90e7fc80b31d6c121e870e9bbda16..297091ce257c3b4567349cdbfb0cb7ceeb38fe68 100644 (file)
@@ -1,5 +1,3 @@
-.. _remap_file_pages:
-
 ==============================
 remap_file_pages() system call
 ==============================
index 7f652216dabe3ba5b9342167547dc681678a6cf7..fa01cdfd7d3a4219a2e9fa5109bba96d5349607b 100644 (file)
@@ -1,5 +1,3 @@
-.. _slub:
-
 ==========================
 Short users guide for SLUB
 ==========================
index c089196627045181b07b2df41ec823e4d6a60d15..50ee0dfc95be6ef3c298d7ddc1544870546f158e 100644 (file)
@@ -1,5 +1,3 @@
-.. _split_page_table_lock:
-
 =====================
 Split page table lock
 =====================
index ec3dc5b042260be66a96277905ba108ff0e2d252..9d924b651c61d1d3ea0cacbd26eaa1d9690a2795 100644 (file)
@@ -1,5 +1,3 @@
-.. _transhuge:
-
 ============================
 Transparent Hugepage Support
 ============================
index 4a0e158aa9ce155320dbedad559c79575b7470c0..b5dc98cd1ba822206ad0b94e55ce3efd17226675 100644 (file)
@@ -1,5 +1,3 @@
-.. _unevictable_lru:
-
 ==============================
 Unevictable LRU Infrastructure
 ==============================
index 224e3c61d6863919b537da7b67286bec0759c819..25b5935d06c7da31381fe39ba678908c5dbe3525 100644 (file)
@@ -1,5 +1,3 @@
-.. _z3fold:
-
 ======
 z3fold
 ======
index 6e79893d61326bb73808d64c847b631a0e1b1eca..24616a7c115aaa20b92ea04990afb40f35453e7d 100644 (file)
@@ -1,5 +1,3 @@
-.. _zsmalloc:
-
 ========
 zsmalloc
 ========
index 5024a8a1551641ffe1c849ae604d8185a68864c5..babbbe756c0feac83fcc6e166e9868b65887c113 100644 (file)
@@ -248,7 +248,7 @@ migrate_vma_finalize() 函数旨在使驱动程序更易于编写并集中跨驱
 还有devm_request_free_mem_region(), devm_memremap_pages(),
 devm_memunmap_pages() 和 devm_release_mem_region() 当资源可以绑定到 ``struct device``.
 
-整体迁移步骤类似于在系统内存中迁移 NUMA 页面(see :ref:`Page migration <page_migration>`) ,
+整体迁移步骤类似于在系统内存中迁移 NUMA 页面(see Documentation/mm/page_migration.rst) ,
 但这些步骤分为设备驱动程序特定代码和共享公共代码:
 
 1. ``mmap_read_lock()``
index 752e5696cd4768be3d3e702f7eda9ced3a9cbb46..80787af29222381ef8b2e88c4e6748335428f866 100644 (file)
@@ -15,7 +15,7 @@ Hugetlbfs 预留
 概述
 ====
 
-:ref:`hugetlbpage` 中描述的巨页通常是预先分配给应用程序使用的。如果VMA指
+Documentation/mm/hugetlbpage.rst 中描述的巨页通常是预先分配给应用程序使用的。如果VMA指
 示要使用巨页,这些巨页会在缺页异常时被实例化到任务的地址空间。如果在缺页异常
 时没有巨页存在,任务就会被发送一个SIGBUS,并经常不高兴地死去。在加入巨页支
 持后不久,人们决定,在mmap()时检测巨页的短缺情况会更好。这个想法是,如果
index b15cfeeb6dfbb54913906e3750240773706b26b1..61fad89272fa5221986401e7b504517007e64ded 100644 (file)
@@ -76,7 +76,7 @@ Linux将系统的硬件资源划分为多个软件抽象,称为“节点”。
 系统管理员和应用程序设计者可以使用各种CPU亲和命令行接口,如taskset(1)和numactl(1),以及程
 序接口,如sched_setaffinity(2),来限制任务的迁移,以改善NUMA定位。此外,人们可以使用
 Linux NUMA内存策略修改内核的默认本地分配行为。 [见
-:ref:`Documentation/admin-guide/mm/numa_memory_policy.rst <numa_memory_policy>`].
+Documentation/admin-guide/mm/numa_memory_policy.rst].
 
 系统管理员可以使用控制组和CPUsets限制非特权用户在调度或NUMA命令和功能中可以指定的CPU和节点
 的内存。 [见 Documentation/admin-guide/cgroup-v1/cpusets.rst]