From patchwork Tue Aug 22 09:33:13 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Steven Rostedt X-Patchwork-Id: 13360409 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id B75DEEE4993 for ; Tue, 22 Aug 2023 09:33:19 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234348AbjHVJdU convert rfc822-to-8bit (ORCPT ); Tue, 22 Aug 2023 05:33:20 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36512 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232280AbjHVJdT (ORCPT ); Tue, 22 Aug 2023 05:33:19 -0400 Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2C4C31B2; Tue, 22 Aug 2023 02:33:18 -0700 (PDT) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id B826161A04; Tue, 22 Aug 2023 09:33:17 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 222BBC433C8; Tue, 22 Aug 2023 09:33:16 +0000 (UTC) Date: Tue, 22 Aug 2023 05:33:13 -0400 From: Steven Rostedt To: LKML , Linux trace kernel Cc: Masami Hiramatsu , Mark Rutland , "Matthew Wilcox (Oracle)" Subject: [PATCH] tracefs: Remove kerneldoc from struct eventfs_file Message-ID: <20230822053313.77aa3397@rorschach.local.home> X-Mailer: Claws Mail 3.17.8 (GTK+ 2.24.33; x86_64-pc-linux-gnu) MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-trace-kernel@vger.kernel.org From d0d094090c093499380049c413b8f1c5b995ff52 Mon Sep 17 00:00:00 2001 From: "Steven Rostedt (Google)" 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) Signed-off-by: Steven Rostedt (Google) Reviewed-by: Masami Hiramatsu (Google) --- 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;