Commit 8c96b701 authored by Steven Rostedt (Google)'s avatar Steven Rostedt (Google)
Browse files

tracefs: Remove kerneldoc from struct eventfs_file 

The struct eventfs_file is a local structure and should not be parsed by
kernel doc. It also does not fully follow the kerneldoc format and is
causing kerneldoc to spit out errors. Replace the /** to /* so that
kerneldoc no longer processes this structure.

Also format the comments of the delete union of the structure to be a bit
better.

Link: https://lore.kernel.org/linux-trace-kernel/20230818201414.2729745-1-willy@infradead.org/
Link: https://lore.kernel.org/linux-trace-kernel/20230822053313.77aa3397@rorschach.local.home



Cc: Mark Rutland <mark.rutland@arm.com>
Reported-by: default avatarMatthew Wilcox (Oracle) <willy@infradead.org>
Reviewed-by: default avatarMasami Hiramatsu (Google) <mhiramat@kernel.org>
Signed-off-by: default avatarSteven Rostedt (Google) <rostedt@goodmis.org>
parent 08662977

fs/tracefs/event_inode.c

+10 −4
Original line number Diff line number Diff line
@@ -27,7 +27,7 @@ struct eventfs_inode { 
	struct list_head	e_top_files;

};



/**

/*

 * struct eventfs_file - hold the properties of the eventfs files and

 *                       directories.

 * @name:	the name of the file or directory to create
@@ -48,10 +48,16 @@ struct eventfs_file { 
	struct eventfs_inode		*ei;

	const struct file_operations	*fop;

	const struct inode_operations	*iop;

	/*

	 * Union - used for deletion

	 * @del_list:	list of eventfs_file to delete

	 * @rcu:	eventfs_file to delete in RCU

	 * @is_freed:	node is freed if one of the above is set

	 */

	union {

		struct list_head	del_list; /* list of eventfs_file to delete */

		struct rcu_head		rcu; /* eventfs_file to delete */

		unsigned long		is_freed; /* Freed if one of the above is set */

		struct list_head	del_list;

		struct rcu_head		rcu;

		unsigned long		is_freed;

	};

	void				*data;

	umode_t				mode;