linux-kernel - [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>] [day] [month] [year] [list]

Message-ID: <20251017070802.1639215-1-rdunlap@infradead.org>
Date: Fri, 17 Oct 2025 00:08:02 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Luis Chamberlain <mcgrof@...nel.org>,
	Kees Cook <kees@...nel.org>,
	Joel Granados <joel.granados@...nel.org>,
	linux-fsdevel@...r.kernel.org
Subject: [PATCH] sysctl: fix kernel-doc format warning

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