Commit 74a7b4f1 authored by Randy Dunlap's avatar Randy Dunlap Committed by Joel Granados
Browse files

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: 2f2665c1 ("sysctl: replace child with an enumeration")
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarJoel Granados <joel.granados@kernel.org>
parent 18c4e028

include/linux/sysctl.h

+4 −7
Original line number Diff line number Diff line
@@ -156,6 +156,10 @@ struct ctl_node { 
 * @nreg: When nreg drops to 0 the ctl_table_header will be unregistered.

 * @rcu: Delays the freeing of the inode. Introduced with "unfuck proc_sysctl ->d_compare()"

 *

 * @type: Enumeration to differentiate between ctl target types

 * @type.SYSCTL_TABLE_TYPE_DEFAULT: ctl target with no special considerations

 * @type.SYSCTL_TABLE_TYPE_PERMANENTLY_EMPTY: Identifies a permanently empty dir

 *                                            target to serve as a mount point

 */

struct ctl_table_header {

	union {
@@ -175,13 +179,6 @@ struct ctl_table_header { 
	struct ctl_dir *parent;

	struct ctl_node *node;

	struct hlist_head inodes; /* head for proc_inode->sysctl_inodes */

	/**

	 * enum 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

	 *                                       as mount point.

	 */

	enum {

		SYSCTL_TABLE_TYPE_DEFAULT,

		SYSCTL_TABLE_TYPE_PERMANENTLY_EMPTY,