Commit 00cba6b6 authored by Mike Rapoport (IBM)'s avatar Mike Rapoport (IBM) Committed by Jonathan Corbet
Browse files

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: default avatarMike Rapoport (IBM) <rppt@kernel.org>
Link: https://lore.kernel.org/r/20230201094156.991542-4-rppt@kernel.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent ee865889

Documentation/admin-guide/mm/concepts.rst

+5 −8
Original line number Diff line number Diff line 
.. _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

==========

Documentation/admin-guide/mm/hugetlbpage.rst

+1 −3
Original line number Diff line number Diff line 
.. _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

Documentation/admin-guide/mm/idle_page_tracking.rst

+2 −5
Original line number Diff line number Diff line 
.. _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:

Documentation/admin-guide/mm/index.rst

+1 −2
Original line number Diff line number Diff line
@@ -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.

Documentation/admin-guide/mm/ksm.rst

+0 −2
Original line number Diff line number Diff line 
.. _admin_guide_ksm:



=======================

Kernel Samepage Merging

=======================