public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH] docs: xforms_lists: allow __maybe_unused in func parameters
@ 2026-04-11 23:35 Randy Dunlap
  2026-04-13 23:36 ` Bart Van Assche
  2026-04-27 10:07 ` Jonathan Corbet
  0 siblings, 2 replies; 3+ messages in thread
From: Randy Dunlap @ 2026-04-11 23:35 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, kernel test robot, Bart Van Assche, Jonathan Corbet,
	Shuah Khan, linux-doc, Mauro Carvalho Chehab

Bart has a patch (not yet merged) that causes kernel-doc warnings:

WARNING: ./include/linux/highmem.h:235 function parameter '__maybe_unused' not described in 'clear_user_pages'
Documentation/mm/highmem:211: ./include/linux/highmem.h:222: WARNING: Error in declarator or parameters

Handle this by adding "__maybe_unused" to the list of known function
parameter modifiers.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202604120025.jtlnpWff-lkp@intel.com/
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Bart Van Assche <bvanassche@acm.org>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: linux-doc@vger.kernel.org
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>

 tools/lib/python/kdoc/xforms_lists.py |    1 +
 1 file changed, 1 insertion(+)

--- linext-2026-0410.orig/tools/lib/python/kdoc/xforms_lists.py
+++ linext-2026-0410/tools/lib/python/kdoc/xforms_lists.py
@@ -93,6 +93,7 @@ class CTransforms:
         (CMatch("__weak"), ""),
         (CMatch("__sched"), ""),
         (CMatch("__always_unused"), ""),
+        (CMatch("__maybe_unused"), ""),
         (CMatch("__printf"), ""),
         (CMatch("__(?:re)?alloc_size"), ""),
         (CMatch("__diagnose_as"), ""),

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

* Re: [PATCH] docs: xforms_lists: allow __maybe_unused in func parameters
  2026-04-11 23:35 [PATCH] docs: xforms_lists: allow __maybe_unused in func parameters Randy Dunlap
@ 2026-04-13 23:36 ` Bart Van Assche
  2026-04-27 10:07 ` Jonathan Corbet
  1 sibling, 0 replies; 3+ messages in thread
From: Bart Van Assche @ 2026-04-13 23:36 UTC (permalink / raw)
  To: Randy Dunlap, linux-kernel
  Cc: kernel test robot, Jonathan Corbet, Shuah Khan, linux-doc,
	Mauro Carvalho Chehab

On 4/11/26 4:35 PM, Randy Dunlap wrote:
> --- linext-2026-0410.orig/tools/lib/python/kdoc/xforms_lists.py
> +++ linext-2026-0410/tools/lib/python/kdoc/xforms_lists.py
> @@ -93,6 +93,7 @@ class CTransforms:
>           (CMatch("__weak"), ""),
>           (CMatch("__sched"), ""),
>           (CMatch("__always_unused"), ""),
> +        (CMatch("__maybe_unused"), ""),
>           (CMatch("__printf"), ""),
>           (CMatch("__(?:re)?alloc_size"), ""),
>           (CMatch("__diagnose_as"), ""),

Thanks!

Reviewed-by: Bart Van Assche <bvanassche@acm.org>


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

* Re: [PATCH] docs: xforms_lists: allow __maybe_unused in func parameters
  2026-04-11 23:35 [PATCH] docs: xforms_lists: allow __maybe_unused in func parameters Randy Dunlap
  2026-04-13 23:36 ` Bart Van Assche
@ 2026-04-27 10:07 ` Jonathan Corbet
  1 sibling, 0 replies; 3+ messages in thread
From: Jonathan Corbet @ 2026-04-27 10:07 UTC (permalink / raw)
  To: Randy Dunlap, linux-kernel
  Cc: Randy Dunlap, kernel test robot, Bart Van Assche, Shuah Khan,
	linux-doc, Mauro Carvalho Chehab

Randy Dunlap <rdunlap@infradead.org> writes:

> Bart has a patch (not yet merged) that causes kernel-doc warnings:
>
> WARNING: ./include/linux/highmem.h:235 function parameter '__maybe_unused' not described in 'clear_user_pages'
> Documentation/mm/highmem:211: ./include/linux/highmem.h:222: WARNING: Error in declarator or parameters
>
> Handle this by adding "__maybe_unused" to the list of known function
> parameter modifiers.
>
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202604120025.jtlnpWff-lkp@intel.com/
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Bart Van Assche <bvanassche@acm.org>
> ---
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Shuah Khan <skhan@linuxfoundation.org>
> Cc: linux-doc@vger.kernel.org
> Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
>
>  tools/lib/python/kdoc/xforms_lists.py |    1 +
>  1 file changed, 1 insertion(+)
>
> --- linext-2026-0410.orig/tools/lib/python/kdoc/xforms_lists.py
> +++ linext-2026-0410/tools/lib/python/kdoc/xforms_lists.py
> @@ -93,6 +93,7 @@ class CTransforms:
>          (CMatch("__weak"), ""),
>          (CMatch("__sched"), ""),
>          (CMatch("__always_unused"), ""),
> +        (CMatch("__maybe_unused"), ""),
>          (CMatch("__printf"), ""),

Applied, thanks.

jon

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

end of thread, other threads:[~2026-04-27 10:07 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-04-11 23:35 [PATCH] docs: xforms_lists: allow __maybe_unused in func parameters Randy Dunlap
2026-04-13 23:36 ` Bart Van Assche
2026-04-27 10:07 ` Jonathan Corbet

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