linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: "Lorenzo Stoakes (Oracle)" <ljs@kernel.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org,
	 Andrew Morton <akpm@linux-foundation.org>,
	linux-mm@kvack.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH] Docs: mmap_prepare: don't italicize structs
Date: Mon, 16 Mar 2026 07:10:36 +0000	[thread overview]
Message-ID: <2ae64217-ae32-4a4e-9c23-6809582ca7bc@lucifer.local> (raw)
In-Reply-To: <20260315224506.1973566-1-rdunlap@infradead.org>

On Sun, Mar 15, 2026 at 03:45:06PM -0700, Randy Dunlap wrote:
> Using a single quote mark `struct xyz` causes the html output to be
> produced as italic. Omit the quote marks so that kernel-doc's automarkup
> can make the "struct xyz" bold monospace ("code" style") in the
> generated html.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

This is fine, though given this series is still in-flight we should just
fold this in no?

Anyway, LGTM so:

Reviewed-by: Lorenzo Stoakes (Oracle) <ljs@kernel.org>

> ---
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: Lorenzo Stoakes <ljs@kernel.org>
> Cc: linux-mm@kvack.org
> Cc: linux-doc@vger.kernel.org
>
>  Documentation/filesystems/mmap_prepare.rst |    6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> --- linux-next.orig/Documentation/filesystems/mmap_prepare.rst
> +++ linux-next/Documentation/filesystems/mmap_prepare.rst
> @@ -129,11 +129,11 @@ pointer. These are:
>  * mmap_action_simple_ioremap() - Sets up an I/O remap from a specified
>    physical address and over a specified length.
>
> -* mmap_action_map_kernel_pages() - Maps a specified array of `struct page`
> +* mmap_action_map_kernel_pages() - Maps a specified array of struct page
>    pointers in the VMA from a specific offset.
>
> -* mmap_action_map_kernel_pages_full() - Maps a specified array of `struct
> -  page` pointers over the entire VMA. The caller must ensure there are
> +* mmap_action_map_kernel_pages_full() - Maps a specified array of struct
> +  page pointers over the entire VMA. The caller must ensure there are
>    sufficient entries in the page array to cover the entire range of the
>    described VMA.
>

Cheers, Lorenzo


  parent reply	other threads:[~2026-03-16  7:10 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-15 22:45 Randy Dunlap
2026-03-16  6:38 ` Bagas Sanjaya
2026-03-16  7:10 ` Lorenzo Stoakes (Oracle) [this message]
2026-03-16 18:45   ` Randy Dunlap

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=2ae64217-ae32-4a4e-9c23-6809582ca7bc@lucifer.local \
    --to=ljs@kernel.org \
    --cc=akpm@linux-foundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=rdunlap@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