From patchwork Sun Jan 8 02:12:38 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 40470 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4e01:0:0:0:0:0 with SMTP id p1csp1530194wrt; Sat, 7 Jan 2023 18:14:57 -0800 (PST) X-Google-Smtp-Source: AMrXdXvlynXifvn97XDhUNqNpnAkT+nY5INuChNTZMzO7PsNsO9x8o1+FSRDedPVSBAOh6lds/FJ X-Received: by 2002:a05:6a20:b044:b0:ac:ab16:442 with SMTP id dx4-20020a056a20b04400b000acab160442mr59264072pzb.4.1673144096942; Sat, 07 Jan 2023 18:14:56 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1673144096; cv=none; d=google.com; s=arc-20160816; b=b1k/duWPGAtYvbZS16I1/Ko9hTEDS6TfEWKcyB4NuaPz0ougLtXLF9i1Qq/9lmWXqF MbFO4//zqPNJLj0/57ddAlO8WuaKUt9cgljUBNVVhKyGygFPnP3HJEBhSVyZwhST42rP l4HMHq074C/QmXZzhkrxT7PPykvwufnaUIQBOf8JqFYQJ751yCIDLlXCuwVBiKebkt/N KJOdB0UUvl4lyZYVWOMSgS+IFF08NJojZuEzYr6+y38ibeJvbGrPCYzJblvWzLNKZ/z9 h3loJkOkq52CRxELb+adItNBqmJajCBSkq4dCCiAuYh27DYmSWAOveBr2QfKEev5QcwN UHcQ== 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:date:subject:cc:to:from:dkim-signature; bh=09HDW0zlCSZa5+hlax6tOj4H8VxYXYEiMzJJOQxFkq4=; b=jU6aP6kw9QCzWcxWqlVhZHuqIKU/m5S3itwCQ8Nw17bD/ACMYCj5IGev0yTe+Z1VSW fe9jRclIiXwTv9dIMO4/9O6K7j+S3EI48i3fBVKAHSBOLRzaXKfUjNGg1/9ISGlGj/TF fdAm6IyT2Rq/RiVbnoGmNMxPDHj/Xl0ua+ApOtTG1R+KJIrUT2dNzhPfJHEVNH4nsyxx r4ZLDGjxixm/lIBFONitXoK7Lj5Az4/hOIPXlMsic2hvcZ7iVTbKuWXIeedPsYW6mWjh fr65FrP3lWKbF5ee/d7JSippfYs3E0wUAiQC7UkwINPYLFgUhmzulKyD9u9x50dN5ctM Nn5Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=28YwxD5B; 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 v13-20020a63f20d000000b0049ceae025casi5773977pgh.604.2023.01.07.18.14.44; Sat, 07 Jan 2023 18:14:56 -0800 (PST) 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; dkim=pass header.i=@infradead.org header.s=bombadil.20210309 header.b=28YwxD5B; 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 S232110AbjAHCNC (ORCPT + 99 others); Sat, 7 Jan 2023 21:13:02 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53654 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232955AbjAHCMo (ORCPT ); Sat, 7 Jan 2023 21:12:44 -0500 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 3CA7F15FF9; Sat, 7 Jan 2023 18:12:40 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type: Content-ID:Content-Description:In-Reply-To:References; bh=09HDW0zlCSZa5+hlax6tOj4H8VxYXYEiMzJJOQxFkq4=; b=28YwxD5Bh92mtmziLR7YuU0ru4 O8FLLGaf0imqW6//4ZcHqOimOxJvqR0RDcKoU+uPpFMpER13kLDmJ3QNyJL/0mY3hJuPVyyrRfhhw S8Bk58rwI89jxgdh7NPTLhvaC+qp9Parb1OMktmPucVEp6SYB3Zskl7GT272O2jN2jmt1Rfy1UADw HArIpdkQE+hHH6YZGC/hrIJpJa8tR7IL2PeaipqeE1mgQehAtWmIY1iXBQCXjcrmhu3jxEjCZHo4e Zoqh0/yGRA7pnwdlpF+teU7YAMqz9EW1h0wJ7A683XCtU8cfuR01o8nT9MDDSFC5+1px4yjMmlNLc pngVJ60w==; Received: from [2601:1c2:d80:3110::a2e7] (helo=bombadil.infradead.org) by bombadil.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1pELAs-00Aq6H-P9; Sun, 08 Jan 2023 02:12:38 +0000 From: Randy Dunlap To: linux-kernel@vger.kernel.org Cc: Randy Dunlap , Steven Rostedt , Masami Hiramatsu , linux-trace-kernel@vger.kernel.org Subject: [PATCH] tracing/filter: fix kernel-doc warnings Date: Sat, 7 Jan 2023 18:12:38 -0800 Message-Id: <20230108021238.16398-1-rdunlap@infradead.org> X-Mailer: git-send-email 2.39.0 MIME-Version: 1.0 X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE 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: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1754418744646964320?= X-GMAIL-MSGID: =?utf-8?q?1754418744646964320?= Use the 'struct' keyword for a struct's kernel-doc notation and use the correct function parameter name to eliminate kernel-doc warnings: kernel/trace/trace_events_filter.c:136: warning: cannot understand function prototype: 'struct prog_entry ' kerne/trace/trace_events_filter.c:155: warning: Excess function parameter 'when_to_branch' description in 'update_preds' Also correct some trivial punctuation problems. Signed-off-by: Randy Dunlap Cc: Steven Rostedt Cc: Masami Hiramatsu Cc: linux-trace-kernel@vger.kernel.org --- kernel/trace/trace_events_filter.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff -- a/kernel/trace/trace_events_filter.c b/kernel/trace/trace_events_filter.c --- a/kernel/trace/trace_events_filter.c +++ b/kernel/trace/trace_events_filter.c @@ -128,7 +128,7 @@ static bool is_not(const char *str) } /** - * prog_entry - a singe entry in the filter program + * struct prog_entry - a singe entry in the filter program * @target: Index to jump to on a branch (actually one minus the index) * @when_to_branch: The value of the result of the predicate to do a branch * @pred: The predicate to execute. @@ -140,16 +140,16 @@ struct prog_entry { }; /** - * update_preds- assign a program entry a label target + * update_preds - assign a program entry a label target * @prog: The program array * @N: The index of the current entry in @prog - * @when_to_branch: What to assign a program entry for its branch condition + * @invert: What to assign a program entry for its branch condition * * The program entry at @N has a target that points to the index of a program * entry that can have its target and when_to_branch fields updated. * Update the current program entry denoted by index @N target field to be * that of the updated entry. This will denote the entry to update if - * we are processing an "||" after an "&&" + * we are processing an "||" after an "&&". */ static void update_preds(struct prog_entry *prog, int N, int invert) {