Skip to content

Commit 8c96b70

Browse files
committed
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/[email protected]/ Link: https://lore.kernel.org/linux-trace-kernel/[email protected] Cc: Mark Rutland <[email protected]> Reported-by: Matthew Wilcox (Oracle) <[email protected]> Reviewed-by: Masami Hiramatsu (Google) <[email protected]> Signed-off-by: Steven Rostedt (Google) <[email protected]>
1 parent 0866297 commit 8c96b70

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

fs/tracefs/event_inode.c

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ struct eventfs_inode {
2727
struct list_head e_top_files;
2828
};
2929

30-
/**
30+
/*
3131
* struct eventfs_file - hold the properties of the eventfs files and
3232
* directories.
3333
* @name: the name of the file or directory to create
@@ -48,10 +48,16 @@ struct eventfs_file {
4848
struct eventfs_inode *ei;
4949
const struct file_operations *fop;
5050
const struct inode_operations *iop;
51+
/*
52+
* Union - used for deletion
53+
* @del_list: list of eventfs_file to delete
54+
* @rcu: eventfs_file to delete in RCU
55+
* @is_freed: node is freed if one of the above is set
56+
*/
5157
union {
52-
struct list_head del_list; /* list of eventfs_file to delete */
53-
struct rcu_head rcu; /* eventfs_file to delete */
54-
unsigned long is_freed; /* Freed if one of the above is set */
58+
struct list_head del_list;
59+
struct rcu_head rcu;
60+
unsigned long is_freed;
5561
};
5662
void *data;
5763
umode_t mode;

0 commit comments

Comments
 (0)