tracefs: Remove kerneldoc from struct eventfs_file
Steven Rostedt
maintainerPATCH 1/1 tracefs: Remove kerneldoc from struct eventfs_file
From d0d094090c093499380049c413b8f1c5b995ff52 Mon Sep 17 00:00:00 2001
From: "Steven Rostedt (Google)" <[email protected]>
Date: Tue, 22 Aug 2023 05:29:22 -0400
Subject: [PATCH] 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.
--- fs/tracefs/event_inode.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
fs/tracefs/event_inode.c +10 -4
@@ -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;
Signature · 1 line
2.40.1
Quoted 5 lines · On Tue, 22 Aug 2023 05:33:13 -0400 Steven Rostedt <[email protected]> wrote:
From
d0d094090c093499380049c413b8f1c5b995ff52Mon Sep 17 00:00:00 2001
From: "Steven Rostedt (Google)" <[email protected]>
Date: Tue, 22 Aug 2023 05:29:22 -0400
Subject: [PATCH] tracefs: Remove kerneldoc from structeventfs_file
Quoted 7 lines
The struct
eventfs_fileis 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.
Looks good to me.
Thanks,
Quoted 45 lines
Reported-by Matthew Wilcox (Oracle) <[email protected]>Signed-off-by Steven Rostedt (Google) <[email protected]>--- fs/tracefs/event_inode.c | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)fs/tracefs/event_inode.c +10
-4@@ -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;Signature · 1 line
2.40.1
Signature · 1 line
Masami Hiramatsu (Google) <[email protected]>