tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs/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-3-rppt@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
authored by
Mike Rapoport (IBM)
and committed by
Jonathan Corbet
ee865889
353c7dd6
+9
-57
-2
Documentation/mm/active_mm.rst
-2
Documentation/mm/active_mm.rst
-2
Documentation/mm/arch_pgtable_helpers.rst
-2
Documentation/mm/arch_pgtable_helpers.rst
-2
Documentation/mm/balance.rst
-2
Documentation/mm/balance.rst
-2
Documentation/mm/free_page_reporting.rst
-2
Documentation/mm/free_page_reporting.rst
-2
Documentation/mm/frontswap.rst
-2
Documentation/mm/frontswap.rst
-2
Documentation/mm/highmem.rst
-2
Documentation/mm/highmem.rst
+1
-3
Documentation/mm/hmm.rst
+1
-3
Documentation/mm/hmm.rst
···
1
-
.. _hmm:
2
-
3
1
=====================================
4
2
Heterogeneous Memory Management (HMM)
5
3
=====================================
···
302
304
be tied to a ``struct device``.
303
305
304
306
The overall migration steps are similar to migrating NUMA pages within system
305
-
memory (see :ref:`Page migration <page_migration>`) but the steps are split
307
+
memory (see Documentation/mm/page_migration.rst) but the steps are split
306
308
between device driver specific code and shared common code:
307
309
308
310
1. ``mmap_read_lock()``
+1
-3
Documentation/mm/hugetlbfs_reserv.rst
+1
-3
Documentation/mm/hugetlbfs_reserv.rst
···
1
-
.. _hugetlbfs_reserve:
2
-
3
1
=====================
4
2
Hugetlbfs Reservation
5
3
=====================
···
5
7
Overview
6
8
========
7
9
8
-
Huge pages as described at :ref:`hugetlbpage` are typically
10
+
Huge pages as described at Documentation/mm/hugetlbpage.rst are typically
9
11
preallocated for application use. These huge pages are instantiated in a
10
12
task's address space at page fault time if the VMA indicates huge pages are
11
13
to be used. If no huge page exists at page fault time, the task is sent
+1
-3
Documentation/mm/ksm.rst
+1
-3
Documentation/mm/ksm.rst
···
1
-
.. _ksm:
2
-
3
1
=======================
4
2
Kernel Samepage Merging
5
3
=======================
···
6
8
added to the Linux kernel in 2.6.32. See ``mm/ksm.c`` for its implementation,
7
9
and http://lwn.net/Articles/306704/ and https://lwn.net/Articles/330589/
8
10
9
-
The userspace interface of KSM is described in :ref:`Documentation/admin-guide/mm/ksm.rst <admin_guide_ksm>`
11
+
The userspace interface of KSM is described in Documentation/admin-guide/mm/ksm.rst
10
12
11
13
Design
12
14
======
-2
Documentation/mm/memory-model.rst
-2
Documentation/mm/memory-model.rst
-2
Documentation/mm/mmu_notifier.rst
-2
Documentation/mm/mmu_notifier.rst
+1
-3
Documentation/mm/numa.rst
+1
-3
Documentation/mm/numa.rst
···
1
-
.. _numa:
2
-
3
1
Started Nov 1999 by Kanoj Sarcar <kanoj@sgi.com>
4
2
5
3
=============
···
108
110
such as taskset(1) and numactl(1), and program interfaces such as
109
111
sched_setaffinity(2). Further, one can modify the kernel's default local
110
112
allocation behavior using Linux NUMA memory policy. [see
111
-
:ref:`Documentation/admin-guide/mm/numa_memory_policy.rst <numa_memory_policy>`].
113
+
Documentation/admin-guide/mm/numa_memory_policy.rst].
112
114
113
115
System administrators can restrict the CPUs and nodes' memories that a non-
114
116
privileged user can specify in the scheduling or NUMA commands and functions
-2
Documentation/mm/page_frags.rst
-2
Documentation/mm/page_frags.rst
+2
-4
Documentation/mm/page_migration.rst
+2
-4
Documentation/mm/page_migration.rst
···
1
-
.. _page_migration:
2
-
3
1
==============
4
2
Page migration
5
3
==============
···
7
9
virtual addresses that the process sees do not change. However, the
8
10
system rearranges the physical location of those pages.
9
11
10
-
Also see :ref:`Heterogeneous Memory Management (HMM) <hmm>`
11
-
for migrating pages to or from device private memory.
12
+
Also see Documentation/mm/hmm.rst for migrating pages to or from device
13
+
private memory.
12
14
13
15
The main intent of page migration is to reduce the latency of memory accesses
14
16
by moving pages near to the processor where the process accessing that memory
-2
Documentation/mm/page_owner.rst
-2
Documentation/mm/page_owner.rst
-2
Documentation/mm/page_table_check.rst
-2
Documentation/mm/page_table_check.rst
-2
Documentation/mm/remap_file_pages.rst
-2
Documentation/mm/remap_file_pages.rst
-2
Documentation/mm/slub.rst
-2
Documentation/mm/slub.rst
-2
Documentation/mm/split_page_table_lock.rst
-2
Documentation/mm/split_page_table_lock.rst
-2
Documentation/mm/transhuge.rst
-2
Documentation/mm/transhuge.rst
-2
Documentation/mm/unevictable-lru.rst
-2
Documentation/mm/unevictable-lru.rst
+1
-1
Documentation/translations/zh_CN/mm/hmm.rst
+1
-1
Documentation/translations/zh_CN/mm/hmm.rst
···
248
248
还有devm_request_free_mem_region(), devm_memremap_pages(),
249
249
devm_memunmap_pages() 和 devm_release_mem_region() 当资源可以绑定到 ``struct device``.
250
250
251
-
整体迁移步骤类似于在系统内存中迁移 NUMA 页面(see :ref:`Page migration <page_migration>`) ，
251
+
整体迁移步骤类似于在系统内存中迁移 NUMA 页面(see Documentation/mm/page_migration.rst) ，
252
252
但这些步骤分为设备驱动程序特定代码和共享公共代码:
253
253
254
254
1. ``mmap_read_lock()``
+1
-1
Documentation/translations/zh_CN/mm/hugetlbfs_reserv.rst
+1
-1
Documentation/translations/zh_CN/mm/hugetlbfs_reserv.rst
+1
-1
Documentation/translations/zh_CN/mm/numa.rst
+1
-1
Documentation/translations/zh_CN/mm/numa.rst
···
76
76
系统管理员和应用程序设计者可以使用各种CPU亲和命令行接口，如taskset(1)和numactl(1)，以及程
77
77
序接口，如sched_setaffinity(2)，来限制任务的迁移，以改善NUMA定位。此外，人们可以使用
78
78
Linux NUMA内存策略修改内核的默认本地分配行为。 [见
79
-
:ref:`Documentation/admin-guide/mm/numa_memory_policy.rst <numa_memory_policy>`].
79
+
Documentation/admin-guide/mm/numa_memory_policy.rst].
80
80
81
81
系统管理员可以使用控制组和CPUsets限制非特权用户在调度或NUMA命令和功能中可以指定的CPU和节点
82
82
的内存。 [见 Documentation/admin-guide/cgroup-v1/cpusets.rst]