Re: [PATCH] Docs: mmap_prepare: don't italicize structs

From: Lorenzo Stoakes (Oracle)

Date: Mon Mar 16 2026 - 03:10:43 EST


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@xxxxxxxxxxxxx>

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@xxxxxxxxxx>

> ---
> Cc: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
> Cc: Lorenzo Stoakes <ljs@xxxxxxxxxx>
> Cc: linux-mm@xxxxxxxxx
> Cc: linux-doc@xxxxxxxxxxxxxxx
>
> 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