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 6f8269c..45d89f8 100644 (file)
@@ -1,5 +1,3 @@
-.. _active_mm:
-
 =========
 Active MM
 =========
index fd2a19d..30d9a09 100644 (file)
@@ -1,7 +1,5 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-.. _arch_page_table_helpers:
-
 ===============================
 Architecture Page Table Helpers
 ===============================
index 6a1fadf..6cd0127 100644 (file)
@@ -1,5 +1,3 @@
-.. _balance:
-
 ================
 Memory Balancing
 ================
index 8c05e62..1468f71 100644 (file)
@@ -1,5 +1,3 @@
-.. _free_page_reporting:
-
 =====================
 Free Page Reporting
 =====================
index feecc5e..c892412 100644 (file)
@@ -1,5 +1,3 @@
-.. _frontswap:
-
 =========
 Frontswap
 =========
index 0f731d9..bb3f90e 100644 (file)
@@ -1,5 +1,3 @@
-.. _highmem:
-
 ====================
 High Memory Handling
 ====================
index f2a59ed..9aa512c 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 f143954..05a4476 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 b9d5253..ba48a44 100644 (file)
@@ -1,5 +1,3 @@
-.. hwpoison:
-
 ========
 hwpoison
 ========
index f83cfbc..2806e3e 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 3779e56..5f3eafb 100644 (file)
@@ -1,7 +1,5 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-.. _physical_memory_model:
-
 =====================
 Physical Memory Model
 =====================
index df5d777..c687bea 100644 (file)
@@ -1,5 +1,3 @@
-.. _mmu_notifier:
-
 When do you need to notify inside page table lock ?
 ===================================================
 
index e141097..0f1b568 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 7d6f938..a81617e 100644 (file)
@@ -1,5 +1,3 @@
-.. _page_frags:
-
 ==============
 Page fragments
 ==============
index 11493ba..313dce1 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 0f4cb59..e8d5090 100644 (file)
@@ -1,5 +1,3 @@
-.. _page_owner:
-
 ==================================================
 page owner: Tracking about who allocated each page
 ==================================================
index 1a09472..cfd8f41 100644 (file)
@@ -1,7 +1,5 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-.. _page_table_check:
-
 ================
 Page Table Check
 ================
index 7bef671..297091c 100644 (file)
@@ -1,5 +1,3 @@
-.. _remap_file_pages:
-
 ==============================
 remap_file_pages() system call
 ==============================
index 7f65221..fa01cdf 100644 (file)
@@ -1,5 +1,3 @@
-.. _slub:
-
 ==========================
 Short users guide for SLUB
 ==========================
index c089196..50ee0df 100644 (file)
@@ -1,5 +1,3 @@
-.. _split_page_table_lock:
-
 =====================
 Split page table lock
 =====================
index ec3dc5b..9d924b6 100644 (file)
@@ -1,5 +1,3 @@
-.. _transhuge:
-
 ============================
 Transparent Hugepage Support
 ============================
index 4a0e158..b5dc98c 100644 (file)
@@ -1,5 +1,3 @@
-.. _unevictable_lru:
-
 ==============================
 Unevictable LRU Infrastructure
 ==============================
index 224e3c6..25b5935 100644 (file)
@@ -1,5 +1,3 @@
-.. _z3fold:
-
 ======
 z3fold
 ======
index 6e79893..24616a7 100644 (file)
@@ -1,5 +1,3 @@
-.. _zsmalloc:
-
 ========
 zsmalloc
 ========
index 5024a8a..babbbe7 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 752e569..80787af 100644 (file)
@@ -15,7 +15,7 @@ Hugetlbfs 预留
 概述
 ====
 
-:ref:`hugetlbpage` 中描述的巨页通常是预先分配给应用程序使用的。如果VMA指
+Documentation/mm/hugetlbpage.rst 中描述的巨页通常是预先分配给应用程序使用的。如果VMA指
 示要使用巨页,这些巨页会在缺页异常时被实例化到任务的地址空间。如果在缺页异常
 时没有巨页存在,任务就会被发送一个SIGBUS,并经常不高兴地死去。在加入巨页支
 持后不久,人们决定,在mmap()时检测巨页的短缺情况会更好。这个想法是,如果
index b15cfee..61fad89 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]