linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Mike Rapoport <rppt@kernel.org>, Jonathan Corbet <corbet@lwn.net>
Cc: Andrew Morton <akpm@linux-foundation.org>,
	David Hildenbrand <david@redhat.com>,
	Johannes Weiner <hannes@cmpxchg.org>,
	Lorenzo Stoakes <lstoakes@gmail.com>,
	"Matthew Wilcox (Oracle)" <willy@infradead.org>,
	Mel Gorman <mgorman@suse.de>, Michal Hocko <mhocko@kernel.org>,
	Vlastimil Babka <vbabka@suse.cz>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-mm@kvack.org
Subject: Re: [PATCH] docs/mm: Physical Memory: remove useless markup
Date: Sat, 28 Jan 2023 09:19:34 +0700	[thread overview]
Message-ID: <Y9SGNlU88EkNY/zW@debian.me> (raw)
In-Reply-To: <20230127080352.177185-1-rppt@kernel.org>

[-- Attachment #1: Type: text/plain, Size: 3153 bytes --]

On Fri, Jan 27, 2023 at 10:03:52AM +0200, Mike Rapoport wrote:
> From: "Mike Rapoport (IBM)" <rppt@kernel.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@lwn.net>
> Signed-off-by: Mike Rapoport (IBM) <rppt@kernel.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@gmail.com>

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

      reply	other threads:[~2023-01-28  2:19 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-27  8:03 [PATCH] docs/mm: Physical Memory: remove useless markup Mike Rapoport
2023-01-28  2:19 ` Bagas Sanjaya [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=Y9SGNlU88EkNY/zW@debian.me \
    --to=bagasdotme@gmail.com \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=david@redhat.com \
    --cc=hannes@cmpxchg.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=lstoakes@gmail.com \
    --cc=mgorman@suse.de \
    --cc=mhocko@kernel.org \
    --cc=rppt@kernel.org \
    --cc=vbabka@suse.cz \
    --cc=willy@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).