linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] mm: leafops.h: correct kernel-doc function param. names
@ 2025-12-14 20:15 Randy Dunlap
  2025-12-15  5:57 ` Lorenzo Stoakes
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2025-12-14 20:15 UTC (permalink / raw)
  To: linux-mm
  Cc: Randy Dunlap, Andrew Morton, David Hildenbrand, Lorenzo Stoakes,
	Liam R. Howlett, Vlastimil Babka, Mike Rapoport,
	Suren Baghdasaryan, Michal Hocko

Modify the kernel-doc function parameter names to prevent kernel-doc
warnings:

Warning: include/linux/leafops.h:135 function parameter 'entry' not
 described in 'leafent_type'
Warning: include/linux/leafops.h:540 function parameter 'pte' not
 described in 'pte_is_uffd_marker'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: David Hildenbrand <david@kernel.org>
Cc: Lorenzo Stoakes <lorenzo.stoakes@oracle.com>
Cc: Liam R. Howlett <Liam.Howlett@oracle.com>
Cc: Vlastimil Babka <vbabka@suse.cz>
Cc: Mike Rapoport <rppt@kernel.org>
Cc: Suren Baghdasaryan <surenb@google.com>
Cc: Michal Hocko <mhocko@suse.com>
---
 include/linux/leafops.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20251201.orig/include/linux/leafops.h
+++ linux-next-20251201/include/linux/leafops.h
@@ -133,7 +133,7 @@ static inline bool softleaf_is_none(soft
 
 /**
  * softleaf_type() - Identify the type of leaf entry.
- * @enntry: Leaf entry.
+ * @entry: Leaf entry.
  *
  * Returns: the leaf entry type associated with @entry.
  */
@@ -534,7 +534,7 @@ static inline bool pte_is_uffd_wp_marker
 /**
  * pte_is_uffd_marker() - Does this PTE entry encode a userfault-specific marker
  * leaf entry?
- * @entry: Leaf entry.
+ * @pte: PTE entry.
  *
  * It's useful to be able to determine which leaf entries encode UFFD-specific
  * markers so we can handle these correctly.


^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] mm: leafops.h: correct kernel-doc function param. names
  2025-12-14 20:15 [PATCH] mm: leafops.h: correct kernel-doc function param. names Randy Dunlap
@ 2025-12-15  5:57 ` Lorenzo Stoakes
  0 siblings, 0 replies; 2+ messages in thread
From: Lorenzo Stoakes @ 2025-12-15  5:57 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-mm, Andrew Morton, David Hildenbrand, Liam R. Howlett,
	Vlastimil Babka, Mike Rapoport, Suren Baghdasaryan, Michal Hocko

On Sun, Dec 14, 2025 at 12:15:17PM -0800, Randy Dunlap wrote:
> Modify the kernel-doc function parameter names to prevent kernel-doc
> warnings:
>
> Warning: include/linux/leafops.h:135 function parameter 'entry' not
>  described in 'leafent_type'
> Warning: include/linux/leafops.h:540 function parameter 'pte' not
>  described in 'pte_is_uffd_marker'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Yikes my bad, thanks for fixing this! :)

Reviewed-by: Lorenzo Stoakes <lorenzo.stoakes@oracle.com>

> ---
> Cc: Andrew Morton <akpm@linux-foundation.org>
> Cc: David Hildenbrand <david@kernel.org>
> Cc: Lorenzo Stoakes <lorenzo.stoakes@oracle.com>
> Cc: Liam R. Howlett <Liam.Howlett@oracle.com>
> Cc: Vlastimil Babka <vbabka@suse.cz>
> Cc: Mike Rapoport <rppt@kernel.org>
> Cc: Suren Baghdasaryan <surenb@google.com>
> Cc: Michal Hocko <mhocko@suse.com>
> ---
>  include/linux/leafops.h |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> --- linux-next-20251201.orig/include/linux/leafops.h
> +++ linux-next-20251201/include/linux/leafops.h
> @@ -133,7 +133,7 @@ static inline bool softleaf_is_none(soft
>
>  /**
>   * softleaf_type() - Identify the type of leaf entry.
> - * @enntry: Leaf entry.
> + * @entry: Leaf entry.
>   *
>   * Returns: the leaf entry type associated with @entry.
>   */
> @@ -534,7 +534,7 @@ static inline bool pte_is_uffd_wp_marker
>  /**
>   * pte_is_uffd_marker() - Does this PTE entry encode a userfault-specific marker
>   * leaf entry?
> - * @entry: Leaf entry.
> + * @pte: PTE entry.
>   *
>   * It's useful to be able to determine which leaf entries encode UFFD-specific
>   * markers so we can handle these correctly.
>


^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2025-12-15  5:58 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-12-14 20:15 [PATCH] mm: leafops.h: correct kernel-doc function param. names Randy Dunlap
2025-12-15  5:57 ` Lorenzo Stoakes

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox