From patchwork Fri Oct 27 04:13:14 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Yujie Liu X-Patchwork-Id: 13438107 Received: from lindbergh.monkeyblade.net (lindbergh.monkeyblade.net [23.128.96.19]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 5D3534412 for ; Fri, 27 Oct 2023 04:18:02 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.b="BlNUx3WH" Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.24]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E01471AA; Thu, 26 Oct 2023 21:18:00 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1698380280; x=1729916280; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=VB0nfCH/N7YJT0+H9sBd9b04Zg5nBw9CuKbABzwzJQI=; b=BlNUx3WH9xBZuMYgR0raXyPPhaavy+Zzi1wUh5jatIwtZ60FvFzS9dfS g/zZKJiIo/20HB1Nw4vhXSzaWyDMjiwuMfTwEiklNJcZVvHwsOV24kio1 z14w4I9pJtTmP/kuZvhE0I7jS8idJb18f1OhXJ+D3MHJYRi9yp2UEfXy6 JVV9x8qNkK6ry0SPCfRchi8udqo21n7EsEgmoO1tfF4JMnVEFu2DA14Or 9Ruj6miPq43cDFf71UGMYGFfewDIPlz9LLxt76zWjfHZOtmZR4s7a+nFB rION7Hgn9N4VBDh8BZqfcAaNy7QrC47e4IQ8U+BXrbM8+PKntbxrXNnZs Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10875"; a="390562805" X-IronPort-AV: E=Sophos;i="6.03,255,1694761200"; d="scan'208";a="390562805" Received: from orsmga001.jf.intel.com ([10.7.209.18]) by orsmga102.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 26 Oct 2023 21:17:59 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10875"; a="794462482" X-IronPort-AV: E=Sophos;i="6.03,255,1694761200"; d="scan'208";a="794462482" Received: from yujie-x299.sh.intel.com ([10.239.159.77]) by orsmga001-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 26 Oct 2023 21:17:57 -0700 From: Yujie Liu To: Steven Rostedt Cc: Masami Hiramatsu , Tom Zanussi , linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org, kernel test robot Subject: [PATCH] tracing/kprobes: Fix the description of variable length arguments Date: Fri, 27 Oct 2023 12:13:14 +0800 Message-Id: <20231027041315.2613166-1-yujie.liu@intel.com> X-Mailer: git-send-email 2.34.1 Precedence: bulk X-Mailing-List: linux-trace-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Fix the following kernel-doc warnings: kernel/trace/trace_kprobe.c:1029: warning: Excess function parameter 'args' description in '__kprobe_event_gen_cmd_start' kernel/trace/trace_kprobe.c:1097: warning: Excess function parameter 'args' description in '__kprobe_event_add_fields' Refer to the usage of variable length arguments elsewhere in the kernel code, "@..." is the proper way to express it in the description. Fixes: 2a588dd1d5d6 ("tracing: Add kprobe event command generation functions") Reported-by: kernel test robot Closes: https://lore.kernel.org/oe-kbuild-all/202310190437.paI6LYJF-lkp@intel.com/ Signed-off-by: Yujie Liu Reviewed-by: Mukesh Ojha --- kernel/trace/trace_kprobe.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/kernel/trace/trace_kprobe.c b/kernel/trace/trace_kprobe.c index a8fef6ab0872..95c5b0668cb7 100644 --- a/kernel/trace/trace_kprobe.c +++ b/kernel/trace/trace_kprobe.c @@ -1007,7 +1007,7 @@ EXPORT_SYMBOL_GPL(kprobe_event_cmd_init); * @name: The name of the kprobe event * @loc: The location of the kprobe event * @kretprobe: Is this a return probe? - * @args: Variable number of arg (pairs), one pair for each field + * @...: Variable number of arg (pairs), one pair for each field * * NOTE: Users normally won't want to call this function directly, but * rather use the kprobe_event_gen_cmd_start() wrapper, which automatically @@ -1080,7 +1080,7 @@ EXPORT_SYMBOL_GPL(__kprobe_event_gen_cmd_start); /** * __kprobe_event_add_fields - Add probe fields to a kprobe command from arg list * @cmd: A pointer to the dynevent_cmd struct representing the new event - * @args: Variable number of arg (pairs), one pair for each field + * @...: Variable number of arg (pairs), one pair for each field * * NOTE: Users normally won't want to call this function directly, but * rather use the kprobe_event_add_fields() wrapper, which