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

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

[Randy Dunlap]

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>
Acked-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Lorenzo Stoakes <ljs@kernel.org>
---
v2: fix one more instance of unneeded single quotes

Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Lorenzo Stoakes <ljs@kernel.org>
Cc: linux-mm@kvack.org
Cc: linux-doc@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>

 Documentation/filesystems/mmap_prepare.rst |    8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

--- linux-next-20261030.orig/Documentation/filesystems/mmap_prepare.rst
+++ linux-next-20261030/Documentation/filesystems/mmap_prepare.rst
@@ -156,16 +156,16 @@ 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.
 
 * mmap_action_map_discontig_kernel_pages() - Maps a discontiguous range of
-  `struct page` pointers over the VMA. They must span from the start of the VMA,
+  struct page pointers over the VMA. They must span from the start of the VMA,
   but may terminate prior to the end (leaving the remainder unmapped).
 
 **NOTE:** The ``action`` field should never normally be manipulated directly,

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

[Jonathan Corbet]

Randy Dunlap <rdunlap@infradead.org> writes:

> 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>
> Acked-by: Bagas Sanjaya <bagasdotme@gmail.com>
> Reviewed-by: Lorenzo Stoakes <ljs@kernel.org>
> ---
> v2: fix one more instance of unneeded single quotes
>
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: Lorenzo Stoakes <ljs@kernel.org>
> Cc: linux-mm@kvack.org
> Cc: linux-doc@vger.kernel.org
> Cc: Jonathan Corbet <corbet@lwn.net>
>
>  Documentation/filesystems/mmap_prepare.rst |    8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)

Applied, thanks.

jon