tracefs: Remove kerneldoc from struct eventfs_file
Commit Message
From d0d094090c093499380049c413b8f1c5b995ff52 Mon Sep 17 00:00:00 2001
From: "Steven Rostedt (Google)" <rostedt@goodmis.org>
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.
Link: https://lore.kernel.org/linux-trace-kernel/20230818201414.2729745-1-willy@infradead.org/
Reported-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
---
fs/tracefs/event_inode.c | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
Comments
On Tue, 22 Aug 2023 05:33:13 -0400
Steven Rostedt <rostedt@goodmis.org> wrote:
> From d0d094090c093499380049c413b8f1c5b995ff52 Mon Sep 17 00:00:00 2001
> From: "Steven Rostedt (Google)" <rostedt@goodmis.org>
> 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.
Looks good to me.
Reviewed-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
Thanks,
>
> Link: https://lore.kernel.org/linux-trace-kernel/20230818201414.2729745-1-willy@infradead.org/
>
> Reported-by: Matthew Wilcox (Oracle) <willy@infradead.org>
> Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
> ---
> fs/tracefs/event_inode.c | 14 ++++++++++----
> 1 file changed, 10 insertions(+), 4 deletions(-)
>
> diff --git a/fs/tracefs/event_inode.c b/fs/tracefs/event_inode.c
> index da8d2e73cc47..237c6f370ad9 100644
> --- a/fs/tracefs/event_inode.c
> +++ b/fs/tracefs/event_inode.c
> @@ -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;
> --
> 2.40.1
>
@@ -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;