Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1:18;
From:   slm <kelulanainsley@gmail.com>
To:     mingo@redhat.com, rostedt@goodmis.org
Cc:     linux-kernel@vger.kernel.org, kelulanainsley@gmail.com,
        sunliming@kylinos.cn
Subject: [PATCH] tracing: fix comments of event_trigger_separate_filter()
Date:   Mon, 23 May 2022 15:51:23 +0800
Message-Id: <20220523075123.1068763-1-sunliming@kylinos.cn>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

The parameter name in comments of event_trigger_separate_filter()
is inconsistent with actual parameter name, fix it.

Signed-off-by: slm <sunliming@kylinos.cn>
---
 kernel/trace/trace_events_trigger.c | 23 ++++++++++++-----------
 1 file changed, 12 insertions(+), 11 deletions(-)

diff --git a/kernel/trace/trace_events_trigger.c b/kernel/trace/trace_events_trigger.c
index 21592bed2e89..c364dc729339 100644
--- a/kernel/trace/trace_events_trigger.c
+++ b/kernel/trace/trace_events_trigger.c
@@ -738,27 +738,28 @@ bool event_trigger_empty_param(const char *param)
 
 /**
  * event_trigger_separate_filter - separate an event trigger from a filter
- * @param: The param string containing trigger and possibly filter
- * @trigger: outparam, will be filled with a pointer to the trigger
+ * @param_and_filter: The param_and_filter string containing trigger
+ * and possibly filter
+ * @param: outparam, will be filled with a pointer to the trigger
  * @filter: outparam, will be filled with a pointer to the filter
  * @param_required: Specifies whether or not the param string is required
  *
  * Given a param string of the form '[trigger] [if filter]', this
  * function separates the filter from the trigger and returns the
- * trigger in *trigger and the filter in *filter.  Either the *trigger
+ * trigger in *param and the filter in *filter.  Either the *param
  * or the *filter may be set to NULL by this function - if not set to
  * NULL, they will contain strings corresponding to the trigger and
  * filter.
  *
  * There are two cases that need to be handled with respect to the
- * passed-in param: either the param is required, or it is not
- * required.  If @param_required is set, and there's no param, it will
- * return -EINVAL.  If @param_required is not set and there's a param
- * that starts with a number, that corresponds to the case of a
- * trigger with :n (n = number of times the trigger should fire) and
- * the parsing continues normally; otherwise the function just returns
- * and assumes param just contains a filter and there's nothing else
- * to do.
+ * passed-in param_and_filter: either the param is required, or
+ * it is not required.  If @param_required is set, and there's no
+ * param, it will return -EINVAL.  If @param_required is not set
+ * and there's a param_and_filter that starts with a number, that
+ * corresponds to the case of a trigger with :n (n = number of times
+ * the trigger should fire) and the parsing continues normally;
+ * otherwise the function just returns and assumes param_and_filter
+ * just contains a filter and there's nothing else to do.
  *
  * Return: 0 on success, errno otherwise
  */
-- 
2.25.1