tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

sysctl: fix kernel-doc format warning

Describe the "type" struct member using '@type' and move it together
with the rest of the doc for ctl_table_header 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@infradead.org>
Signed-off-by: Joel Granados <joel.granados@kernel.org>

authored by

Randy Dunlap and committed by
Joel Granados 74a7b4f1 18c4e028

+4 -7
+4 -7
include/linux/sysctl.h
··· 156 156 * @nreg: When nreg drops to 0 the ctl_table_header will be unregistered. 157 157 * @rcu: Delays the freeing of the inode. Introduced with "unfuck proc_sysctl ->d_compare()" 158 158 * 159 + * @type: Enumeration to differentiate between ctl target types 160 + * @type.SYSCTL_TABLE_TYPE_DEFAULT: ctl target with no special considerations 161 + * @type.SYSCTL_TABLE_TYPE_PERMANENTLY_EMPTY: Identifies a permanently empty dir 162 + * target to serve as a mount point 159 163 */ 160 164 struct ctl_table_header { 161 165 union { ··· 179 175 struct ctl_dir *parent; 180 176 struct ctl_node *node; 181 177 struct hlist_head inodes; /* head for proc_inode->sysctl_inodes */ 182 - /** 183 - * enum type - Enumeration to differentiate between ctl target types 184 - * @SYSCTL_TABLE_TYPE_DEFAULT: ctl target with no special considerations 185 - * @SYSCTL_TABLE_TYPE_PERMANENTLY_EMPTY: Used to identify a permanently 186 - * empty directory target to serve 187 - * as mount point. 188 - */ 189 178 enum { 190 179 SYSCTL_TABLE_TYPE_DEFAULT, 191 180 SYSCTL_TABLE_TYPE_PERMANENTLY_EMPTY,