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: 136497 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b82d:0:b0:3f2:4152:657d with SMTP id z13csp3530677vqi; Tue, 22 Aug 2023 03:29:14 -0700 (PDT) X-Google-Smtp-Source: AGHT+IG3QzpW6i8pMjieX61FMXvWC6bPk6DP0W9Gr4NmYa1SbjtFXdxBF4Sdk0dM108GkU0i3wYx X-Received: by 2002:aa7:c603:0:b0:523:ae0a:a446 with SMTP id h3-20020aa7c603000000b00523ae0aa446mr7439408edq.24.1692700154454; Tue, 22 Aug 2023 03:29:14 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1692700154; cv=none; d=google.com; s=arc-20160816; b=P5D5QKhHXWmnqUminyLxtVD0dY/gnl5w02i46LWXjj5dCvKRnxbDsAx0aqCKlWmCfR dGjJ0SqwnYb/yIjq4HwU/B8bkxC8mJVACas2zpij4f2CVR+z+vXrx3rVR6m4xI0l1Jw5 v0UUW4SsHVORU+bRaCD4D9ot8rM92/yqBdSMfzX8CVVJficMBRkEu4tB1qLdp4GEDhGj IvJDPhkIq94lMi5Wk7kLnuRujikRluSFZhi5Zgn59AqkYvJ6HAaWfZU9wyY8ET52+cyh NSDBGZGdq1zfKgR8WMGSibZdJFzqg71A1BCIwic5tcz5PNvHZFO5VJNFJ0TltvJhwSDn vc8A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:subject:cc:to:from:date; bh=GV9BmQQAgAUi2nefhpF71EdEy8BEEdBTFxQET9G8wCg=; fh=no6P2VfLK0lz+1HDO4VdVjgjQ/Jdx3nyf2mFEXb0YTo=; b=UWOLMqt2EMwFw1DVjtUa+k0hmEXxcyBYStywmvSVuFXPL2m1DXYXisD33hVf6Gj0db YzOgXgz4zgbC71OAg2XMMBqDJmRSVUlWrPvgo2v7xBE/WCpB1GbN+hHid0ARwQgDYCW5 /w20gW8zFZQYQYietnKinoifcZvJ8zgDLLOT3pDNBJlCH6LAGWEoNqJVzWHWC5vkFm2f XGJLB+/zWFFPSJigttbMo0uNgSJpB3WN8Ch82dnYqi6Go62TfbmF3ldMJRIBzzOstn2T zCA2CGsT/ilpLCrVUkolPaxQ+YU2A7k6212CIRBko4Xmgjq0COVdPH4I4bP7G9RvemMZ NiDg== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id l13-20020a056402344d00b005236db67178si7350450edc.417.2023.08.22.03.28.51; Tue, 22 Aug 2023 03:29:14 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234368AbjHVJdU convert rfc822-to-8bit (ORCPT + 99 others); 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 X-Spam-Status: No, score=-6.7 required=5.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,RCVD_IN_DNSWL_HI,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1774924757529051567 X-GMAIL-MSGID: 1774924757529051567 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;