docs/mm: Physical Memory: remove useless markup
Subsystems (3)
Mike Rapoport
reviewerPATCH 1/1 docs/mm: Physical Memory: remove useless markup
From: "Mike Rapoport (IBM)" <[email protected]>
Jon says:
Quoted 1 line
+See also :ref:
Page Reclaim <page_reclaim>.
Can also just be "See also Documentation/mm/page_reclaim.rst". 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.
Remove reference markup and unnecessary labes and use plain file names.
--- Documentation/core-api/dma-api.rst | 2 -- Documentation/mm/page_reclaim.rst | 2 -- Documentation/mm/physical_memory.rst | 6 +++--- 3 files changed, 3 insertions(+), 7 deletions(-)
Documentation/core-api/dma-api.rst +0 -2
@@ -1,5 +1,3 @@ -.. _dma_api: - ============================================ Dynamic DMA mapping using the generic device ============================================
Documentation/mm/page_reclaim.rst +0 -2
@@ -1,7 +1,5 @@ .. SPDX-License-Identifier: GPL-2.0 -.. _page_reclaim: - ============ Page Reclaim ============
Documentation/mm/physical_memory.rst +3 -3
@@ -39,8 +39,8 @@ one of the types described below. * ``ZONE_DMA`` and ``ZONE_DMA32`` historically represented memory suitable for DMA by peripheral devices that cannot access all of the addressable memory. For many years there are better more and robust interfaces to get - memory with DMA specific requirements (:ref:`DMA API <dma_api>`), but - ``ZONE_DMA`` and ``ZONE_DMA32`` still represent memory ranges that have + memory with DMA specific requirements (Documentation/core-api/dma-api.rst), + but ``ZONE_DMA`` and ``ZONE_DMA32`` still represent memory ranges that have restrictions on how they can be accessed. Depending on the architecture, either of these zone types or even they both can be disabled at build time using ``CONFIG_ZONE_DMA`` and
@@ -252,7 +252,7 @@ General Reclaim control ~~~~~~~~~~~~~~~ -See also :ref:`Page Reclaim <page_reclaim>`. +See also Documentation/mm/page_reclaim.rst. ``kswapd`` Per-node instance of kswapd kernel thread.
Signature · 1 line
2.35.1
Quoted 60 lines · Mike Rapoport
From: "Mike Rapoport (IBM)" <[email protected]>
Jon says:
Quoted 1 line
+See also :ref:
Page Reclaim <page_reclaim>.Can also just be "See also
Documentation/mm/page_reclaim.rst". 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.Remove reference markup and unnecessary labes and use plain file names.
Fixes 5d8c5e430a63 ("docs/mm: Physical Memory: add structure, introduction and nodes description")Suggested-by Jonathan Corbet <[email protected]>Signed-off-by Mike Rapoport (IBM) <[email protected]>--- Documentation/core-api/dma-api.rst | 2 -- Documentation/mm/page_reclaim.rst | 2 -- Documentation/mm/physical_memory.rst | 6 +++--- 3 files changed, 3 insertions(+), 7 deletions(-)Documentation/core-api/dma-api.rst +0
-2@@ -1,5 +1,3 @@ -.. _dma_api: - ============================================ Dynamic DMA mapping using the generic device ============================================Documentation/mm/page_reclaim.rst +0
-2@@ -1,7 +1,5 @@ .. SPDX-License-Identifier: GPL-2.0 -.. _page_reclaim: - ============ Page Reclaim ============Documentation/mm/physical_memory.rst +2
-2@@ -39,8 +39,8 @@ one of the types described below. * ``ZONE_DMA`` and ``ZONE_DMA32`` historically represented memory suitable for DMA by peripheral devices that cannot access all of the addressable memory. For many years there are better more and robust interfaces to get - memory with DMA specific requirements (:ref:`DMA API <dma_api>`), but - ``ZONE_DMA`` and ``ZONE_DMA32`` still represent memory ranges that have + memory with DMA specific requirements (Documentation/core-api/dma-api.rst), + but ``ZONE_DMA`` and ``ZONE_DMA32`` still represent memory ranges that have restrictions on how they can be accessed. Depending on the architecture, either of these zone types or even they both can be disabled at build time using ``CONFIG_ZONE_DMA`` and
Documentation/mm/physical_memory.rst General · line 258
Quoted 8 lines
Documentation/mm/physical_memory.rst +1
-1@@ -252,7 +252,7 @@ General Reclaim control ~~~~~~~~~~~~~~~ -See also :ref:`Page Reclaim <page_reclaim>`. +See also Documentation/mm/page_reclaim.rst. ``kswapd`` Per-node instance of kswapd kernel thread.
Seems like I always forget to keep crossrefs uncluttered, thanks!
Signature · 1 line
An old man doll... just what I always wanted! - Clara