Re: [PATCH] eventfs: Fix kerneldoc of eventfs_remove_rec()

[Mukesh Ojha <quic_mojha@quicinc.com>]

On 10/30/2023 9:45 PM, Steven Rostedt wrote:
> From: "Steven Rostedt (Google)" <rostedt@goodmis.org>
> 
> The eventfs_remove_rec() had some missing parameters in the kerneldoc
> comment above it. Also, rephrase the description a bit more to have a bit
> more correct grammar.
> 
> Fixes: 5790b1fb3d672 ("eventfs: Remove eventfs_file and just use eventfs_inode");
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202310052216.4SgqasWo-lkp@intel.com/
> Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>

Reviewed-by: Mukesh Ojha <quic_mojha@quicinc.com>

-Mukesh
> ---
>   fs/tracefs/event_inode.c | 6 ++++--
>   1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/fs/tracefs/event_inode.c b/fs/tracefs/event_inode.c
> index 5a3cc5394294..1c28e013201f 100644
> --- a/fs/tracefs/event_inode.c
> +++ b/fs/tracefs/event_inode.c
> @@ -977,9 +977,11 @@ static void free_rcu_ei(struct rcu_head *head)
>   /**
>    * eventfs_remove_rec - remove eventfs dir or file from list
>    * @ei: eventfs_inode to be removed.
> + * @head: the list head to place the deleted @ei and children
> + * @level: prevent recursion from going more than 3 levels deep.
>    *
> - * This function recursively remove eventfs_inode which
> - * contains info of file or dir.
> + * This function recursively removes eventfs_inodes which
> + * contains info of files and/or directories.
>    */
>   static void eventfs_remove_rec(struct eventfs_inode *ei, struct list_head *head, int level)
>   {