linux-kernel - Re: [PATCH] sysctl: fix kernel-doc format warning

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <kyn7q3tjjxg45am326ykx4hbnqzffl2nkt77vl65qxa4p3kpz2@ysgkf3j3ch4m>
Date: Fri, 24 Oct 2025 15:03:17 +0200
From: Joel Granados <joel.granados@...nel.org>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, Luis Chamberlain <mcgrof@...nel.org>, 
	Kees Cook <kees@...nel.org>, linux-fsdevel@...r.kernel.org
Subject: Re: [PATCH] sysctl: fix kernel-doc format warning

On Fri, Oct 17, 2025 at 12:08:02AM -0700, Randy Dunlap wrote:
> Describe the "type" struct member using '@...e' to avoid a kernel-doc
> warning:
> 
> Warning: include/linux/sysctl.h:178 Incorrect use of kernel-doc format:
>  * enum type - Enumeration to differentiate between ctl target types
> 
> Fixes: 2f2665c13af4 ("sysctl: replace child with an enumeration")
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> ---
> Cc: Luis Chamberlain <mcgrof@...nel.org>
> Cc: Kees Cook <kees@...nel.org>
> Cc: Joel Granados <joel.granados@...nel.org>
> Cc: linux-fsdevel@...r.kernel.org
> ---
>  include/linux/sysctl.h |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- linux-next-20251016.orig/include/linux/sysctl.h
> +++ linux-next-20251016/include/linux/sysctl.h
> @@ -176,7 +176,7 @@ struct ctl_table_header {
>  	struct ctl_node *node;
>  	struct hlist_head inodes; /* head for proc_inode->sysctl_inodes */
>  	/**
> -	 * enum type - Enumeration to differentiate between ctl target types
> +	 * @type: Enumeration to differentiate between ctl target types
>  	 * @SYSCTL_TABLE_TYPE_DEFAULT: ctl target with no special considerations
>  	 * @SYSCTL_TABLE_TYPE_PERMANENTLY_EMPTY: Used to identify a permanently
>  	 *                                       empty directory target to serve

Yes! I'll push it through with a little tweek by putting it together
with the general documentation for the ctl_table_header. That is the way
it is supposed to be (according to Documentation/doc-guide/kernel-doc.rst)

Best
-- 

Joel Granados

Download attachment "signature.asc" of type "application/pgp-signature" (660 bytes)