From nobody Mon Oct 6 16:49:25 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (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 4C4261C4A17; Sun, 20 Jul 2025 06:22:40 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1752992562; cv=none; b=WELlxb+zhT8Rek/WoIDUgH0r/fW9vRamKZbtV93fkq+Yc2WORNB7NcKdjy9/ZbwWQb5feqYIeGNW9HECPIPvo7DaDAw0p5qKH9H2tty+7Z5WCCc4OO3AoPxgD3krAWzBoHcKi0k3X61XUiRzLT+vcKSKV6/gucBR0brT3NZci0w= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1752992562; c=relaxed/simple; bh=hpsFt4kAWZBfDMi50YQCwG8A9W+7Ajj8ewsnZeWqOFU=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=Q9h+c+MrEFBYKnOe778MU0mPKeKQzxh4NT4B+E2hFrvsubV6S24poXrWCnQF0fUIBbAgJKrE1jqqrkM6yK3O29r6l9vlBgs5DcV8IHMraQGe9OWLmvn1yykF7m/O5rsL49OTKik1Dlu5P0D7o15XwSTvZJ6GyX+SQY7lMOUR1hA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=P4ieRLN2; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="P4ieRLN2" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 6D6FFC4CEE7; Sun, 20 Jul 2025 06:22:39 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1752992560; bh=hpsFt4kAWZBfDMi50YQCwG8A9W+7Ajj8ewsnZeWqOFU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=P4ieRLN2s9ZFB/85pCxisLwz5mm/Xuhs34F6EbOr1kW0RPjos1Nwm0dSfjphPku+j 0f6Vsgk/VRMJW5FuR+SEPiaExFkHsPgyrcLa6+FnafYh1w970dpwNyOIexzfwr/jtx Ftscbsh9sSPE5Wb9b44OAJMH1fZeKcS+FTsAI+Ef/mKORbnQH1dR//GjwVB5R11Zj4 jXqvfM72xO6p3g1MQT14wGAKpixiY+Vxn529XhMPm1drXDKds052sX5liWrtmsbicF Qt8LCYsjRsl/RgMseqIDsfJRMTDuEM3hTSyixQk4WSv9qHke0NtwcSFGhFbQFmXYeo d820YuIRhne1g== From: "Masami Hiramatsu (Google)" To: Steven Rostedt , Masami Hiramatsu Cc: Mathieu Desnoyers , linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org Subject: [PATCH v2 6/6] tracing: probes: Add a kerneldoc for traceprobe_parse_event_name() Date: Sun, 20 Jul 2025 15:22:36 +0900 Message-ID: <175299255609.418723.7661338110074622016.stgit@devnote2> X-Mailer: git-send-email 2.43.0 In-Reply-To: <175299249728.418723.17799706394466693180.stgit@devnote2> References: <175299249728.418723.17799706394466693180.stgit@devnote2> User-Agent: StGit/0.19 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable From: Masami Hiramatsu (Google) Since traceprobe_parse_event_name() is a bit complicated, add a kerneldoc for explaining the behavior. Suggested-by: Steven Rostedt Signed-off-by: Masami Hiramatsu (Google) --- kernel/trace/trace_probe.c | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/kernel/trace/trace_probe.c b/kernel/trace/trace_probe.c index abfab8957a6c..72bf430a3804 100644 --- a/kernel/trace/trace_probe.c +++ b/kernel/trace/trace_probe.c @@ -247,7 +247,22 @@ int traceprobe_split_symbol_offset(char *symbol, long = *offset) return 0; } =20 -/* @buf must has MAX_EVENT_NAME_LEN size */ +/** + * traceprobe_parse_event_name - Parse a string into group and event names + * @pevent: A pointer to the string to be parsed. On return, this is updat= ed + * to point to the event name part of the string. + * @pgroup: A pointer to the group name. This is updated to point to the p= arsed + * group name, which is stored in @buf. + * @buf: A buffer to store the parsed group name. + * @offset: The offset of the string in the original user command, for log= ging. + * + * Description: This parses a string with the format `[GROUP/][EVENT]` or + * `[GROUP.][EVENT]` (either GROUP or EVENT or both must be speci= fied). + * The parsed group name is stored in @buf. + * The caller must ensure @buf is at least MAX_EVENT_NAME_LEN byt= es. + * + * Return: 0 on success, or -EINVAL on failure. + */ int traceprobe_parse_event_name(const char **pevent, const char **pgroup, char *buf, int offset) {