linux-kernel - Re: [PATCH] docs/mm: Physical Memory: remove useless markup

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Sat, 28 Jan 2023 09:19:34 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     Mike Rapoport <rppt@...nel.org>, Jonathan Corbet <corbet@....net>
Cc:     Andrew Morton <akpm@...ux-foundation.org>,
        David Hildenbrand <david@...hat.com>,
        Johannes Weiner <hannes@...xchg.org>,
        Lorenzo Stoakes <lstoakes@...il.com>,
        "Matthew Wilcox (Oracle)" <willy@...radead.org>,
        Mel Gorman <mgorman@...e.de>, Michal Hocko <mhocko@...nel.org>,
        Vlastimil Babka <vbabka@...e.cz>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, linux-mm@...ck.org
Subject: Re: [PATCH] docs/mm: Physical Memory: remove useless markup

On Fri, Jan 27, 2023 at 10:03:52AM +0200, Mike Rapoport wrote:
> From: "Mike Rapoport (IBM)" <rppt@...nel.org>
> 
> Jon says:
> 
>   > +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 <corbet@....net>
> Signed-off-by: Mike Rapoport (IBM) <rppt@...nel.org>
> ---
>  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(-)
> 
> diff --git a/Documentation/core-api/dma-api.rst b/Documentation/core-api/dma-api.rst
> index c847a5b0a0d3..829f20a193ca 100644
> --- a/Documentation/core-api/dma-api.rst
> +++ b/Documentation/core-api/dma-api.rst
> @@ -1,5 +1,3 @@
> -.. _dma_api:
> -
>  ============================================
>  Dynamic DMA mapping using the generic device
>  ============================================
> diff --git a/Documentation/mm/page_reclaim.rst b/Documentation/mm/page_reclaim.rst
> index 3fccde066436..50a30b7f8ac3 100644
> --- a/Documentation/mm/page_reclaim.rst
> +++ b/Documentation/mm/page_reclaim.rst
> @@ -1,7 +1,5 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
> -.. _page_reclaim:
> -
>  ============
>  Page Reclaim
>  ============
> diff --git a/Documentation/mm/physical_memory.rst b/Documentation/mm/physical_memory.rst
> index d24220d62475..120d54ba6ea7 100644
> --- a/Documentation/mm/physical_memory.rst
> +++ b/Documentation/mm/physical_memory.rst
> @@ -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.

Seems like I always forget to keep crossrefs uncluttered, thanks!

Acked-by: Bagas Sanjaya <bagasdotme@...il.com>

-- 
An old man doll... just what I always wanted! - Clara

Download attachment "signature.asc" of type "application/pgp-signature" (229 bytes)