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

[Joel Granados]

On Fri, Oct 17, 2025 at 12:08:02AM -0700, Randy Dunlap wrote:
> Describe the "type" struct member using '@type' 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@xxxxxxxxxxxxx>
> ---
> Cc: Luis Chamberlain <mcgrof@xxxxxxxxxx>
> Cc: Kees Cook <kees@xxxxxxxxxx>
> Cc: Joel Granados <joel.granados@xxxxxxxxxx>
> Cc: linux-fsdevel@xxxxxxxxxxxxxxx
> ---
>  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

Attachment: signature.asc
Description: PGP signature