[PATCH] tracing/hist: add in missing * in comment blocks

[PATCH] tracing/hist: add in missing * in comment blocks

[Colin Ian King]

There are a couple of missing * in comment blocks. Fix these.
Cleans up two clang warnings:

kernel/trace/trace_events_hist.c:986: warning: bad line:
kernel/trace/trace_events_hist.c:3229: warning: bad line:

Signed-off-by: Colin Ian King <colin.i.king@gmail.com>
---
 kernel/trace/trace_events_hist.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/kernel/trace/trace_events_hist.c b/kernel/trace/trace_events_hist.c
index 48465f7e97b4..087c19548049 100644
--- a/kernel/trace/trace_events_hist.c
+++ b/kernel/trace/trace_events_hist.c
@@ -983,7 +983,7 @@ static struct hist_field *find_any_var_ref(struct hist_trigger_data *hist_data,
  * A trigger can define one or more variables.  If any one of them is
  * currently referenced by any other trigger, this function will
  * determine that.
-
+ *
  * Typically used to determine whether or not a trigger can be removed
  * - if there are any references to a trigger's variables, it cannot.
  *
@@ -3226,7 +3226,7 @@ static struct field_var *create_field_var(struct hist_trigger_data *hist_data,
  * events.  However, for convenience, users are allowed to directly
  * specify an event field in an action, which will be automatically
  * converted into a variable on their behalf.
-
+ *
  * This function creates a field variable with the name var_name on
  * the hist trigger currently being defined on the target event.  If
  * subsys_name and event_name are specified, this function simply
-- 
2.37.3

Re: [PATCH] tracing/hist: add in missing * in comment blocks

[Masami Hiramatsu]

Hi,

On Thu, 20 Oct 2022 14:30:19 +0100
Colin Ian King <colin.i.king@gmail.com> wrote:

> There are a couple of missing * in comment blocks. Fix these.
> Cleans up two clang warnings:
> 
> kernel/trace/trace_events_hist.c:986: warning: bad line:
> kernel/trace/trace_events_hist.c:3229: warning: bad line:
> 
> Signed-off-by: Colin Ian King <colin.i.king@gmail.com>

Thanks for the patch. 

Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>

BTW, what version of clang are you using?
I couldn't see this warning with clang 15.0.0. Maybe I need a kconfig option?

Thank you,

> ---
>  kernel/trace/trace_events_hist.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/kernel/trace/trace_events_hist.c b/kernel/trace/trace_events_hist.c
> index 48465f7e97b4..087c19548049 100644
> --- a/kernel/trace/trace_events_hist.c
> +++ b/kernel/trace/trace_events_hist.c
> @@ -983,7 +983,7 @@ static struct hist_field *find_any_var_ref(struct hist_trigger_data *hist_data,
>   * A trigger can define one or more variables.  If any one of them is
>   * currently referenced by any other trigger, this function will
>   * determine that.
> -
> + *
>   * Typically used to determine whether or not a trigger can be removed
>   * - if there are any references to a trigger's variables, it cannot.
>   *
> @@ -3226,7 +3226,7 @@ static struct field_var *create_field_var(struct hist_trigger_data *hist_data,
>   * events.  However, for convenience, users are allowed to directly
>   * specify an event field in an action, which will be automatically
>   * converted into a variable on their behalf.
> -
> + *
>   * This function creates a field variable with the name var_name on
>   * the hist trigger currently being defined on the target event.  If
>   * subsys_name and event_name are specified, this function simply
> -- 
> 2.37.3
> 


-- 
Masami Hiramatsu (Google) <mhiramat@kernel.org>

Re: [PATCH] tracing/hist: add in missing * in comment blocks

[Colin King (gmail)]

On 20/10/2022 15:44, Masami Hiramatsu (Google) wrote:
> Hi,
> 
> On Thu, 20 Oct 2022 14:30:19 +0100
> Colin Ian King <colin.i.king@gmail.com> wrote:
> 
>> There are a couple of missing * in comment blocks. Fix these.
>> Cleans up two clang warnings:
>>
>> kernel/trace/trace_events_hist.c:986: warning: bad line:
>> kernel/trace/trace_events_hist.c:3229: warning: bad line:
>>
>> Signed-off-by: Colin Ian King <colin.i.king@gmail.com>
> 
> Thanks for the patch.
> 
> Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
> 
> BTW, what version of clang are you using?
> I couldn't see this warning with clang 15.0.0. Maybe I need a kconfig option?

clang-13 and kernel W=1 for this specific case, e.g. kernel built using 
make  CC=clang-13 HOSTCC=clang-13 W=1


> 
> Thank you,
> 
>> ---
>>   kernel/trace/trace_events_hist.c | 4 ++--
>>   1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/kernel/trace/trace_events_hist.c b/kernel/trace/trace_events_hist.c
>> index 48465f7e97b4..087c19548049 100644
>> --- a/kernel/trace/trace_events_hist.c
>> +++ b/kernel/trace/trace_events_hist.c
>> @@ -983,7 +983,7 @@ static struct hist_field *find_any_var_ref(struct hist_trigger_data *hist_data,
>>    * A trigger can define one or more variables.  If any one of them is
>>    * currently referenced by any other trigger, this function will
>>    * determine that.
>> -
>> + *
>>    * Typically used to determine whether or not a trigger can be removed
>>    * - if there are any references to a trigger's variables, it cannot.
>>    *
>> @@ -3226,7 +3226,7 @@ static struct field_var *create_field_var(struct hist_trigger_data *hist_data,
>>    * events.  However, for convenience, users are allowed to directly
>>    * specify an event field in an action, which will be automatically
>>    * converted into a variable on their behalf.
>> -
>> + *
>>    * This function creates a field variable with the name var_name on
>>    * the hist trigger currently being defined on the target event.  If
>>    * subsys_name and event_name are specified, this function simply
>> -- 
>> 2.37.3
>>
> 
> 

Re: [PATCH] tracing/hist: add in missing * in comment blocks

[Randy Dunlap]

On 10/20/22 08:10, Colin King (gmail) wrote:
> On 20/10/2022 15:44, Masami Hiramatsu (Google) wrote:
>> Hi,
>>
>> On Thu, 20 Oct 2022 14:30:19 +0100
>> Colin Ian King <colin.i.king@gmail.com> wrote:
>>
>>> There are a couple of missing * in comment blocks. Fix these.
>>> Cleans up two clang warnings:
>>>
>>> kernel/trace/trace_events_hist.c:986: warning: bad line:
>>> kernel/trace/trace_events_hist.c:3229: warning: bad line:
>>>
>>> Signed-off-by: Colin Ian King <colin.i.king@gmail.com>
>>
>> Thanks for the patch.
>>
>> Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
>>
>> BTW, what version of clang are you using?
>> I couldn't see this warning with clang 15.0.0. Maybe I need a kconfig option?
> 
> clang-13 and kernel W=1 for this specific case, e.g. kernel built using make  CC=clang-13 HOSTCC=clang-13 W=1
> 

but those are kernel-doc warnings, not clang (AFAIK).

> 
>>
>> Thank you,
>>
>>> ---
>>>   kernel/trace/trace_events_hist.c | 4 ++--
>>>   1 file changed, 2 insertions(+), 2 deletions(-)
>>>
>>> diff --git a/kernel/trace/trace_events_hist.c b/kernel/trace/trace_events_hist.c
>>> index 48465f7e97b4..087c19548049 100644
>>> --- a/kernel/trace/trace_events_hist.c
>>> +++ b/kernel/trace/trace_events_hist.c
>>> @@ -983,7 +983,7 @@ static struct hist_field *find_any_var_ref(struct hist_trigger_data *hist_data,
>>>    * A trigger can define one or more variables.  If any one of them is
>>>    * currently referenced by any other trigger, this function will
>>>    * determine that.
>>> -
>>> + *
>>>    * Typically used to determine whether or not a trigger can be removed
>>>    * - if there are any references to a trigger's variables, it cannot.
>>>    *
>>> @@ -3226,7 +3226,7 @@ static struct field_var *create_field_var(struct hist_trigger_data *hist_data,
>>>    * events.  However, for convenience, users are allowed to directly
>>>    * specify an event field in an action, which will be automatically
>>>    * converted into a variable on their behalf.
>>> -
>>> + *
>>>    * This function creates a field variable with the name var_name on
>>>    * the hist trigger currently being defined on the target event.  If
>>>    * subsys_name and event_name are specified, this function simply
>>> -- 
>>> 2.37.3
>>>
>>
>>
> 

-- 
~Randy

Re: [PATCH] tracing/hist: add in missing * in comment blocks

[Masami Hiramatsu]

On Thu, 20 Oct 2022 11:07:12 -0700
Randy Dunlap <rdunlap@infradead.org> wrote:

> 
> 
> On 10/20/22 08:10, Colin King (gmail) wrote:
> > On 20/10/2022 15:44, Masami Hiramatsu (Google) wrote:
> >> Hi,
> >>
> >> On Thu, 20 Oct 2022 14:30:19 +0100
> >> Colin Ian King <colin.i.king@gmail.com> wrote:
> >>
> >>> There are a couple of missing * in comment blocks. Fix these.
> >>> Cleans up two clang warnings:
> >>>
> >>> kernel/trace/trace_events_hist.c:986: warning: bad line:
> >>> kernel/trace/trace_events_hist.c:3229: warning: bad line:
> >>>
> >>> Signed-off-by: Colin Ian King <colin.i.king@gmail.com>
> >>
> >> Thanks for the patch.
> >>
> >> Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
> >>
> >> BTW, what version of clang are you using?
> >> I couldn't see this warning with clang 15.0.0. Maybe I need a kconfig option?
> > 
> > clang-13 and kernel W=1 for this specific case, e.g. kernel built using make  CC=clang-13 HOSTCC=clang-13 W=1
> > 
> 
> but those are kernel-doc warnings, not clang (AFAIK).

Ah, I got it.

Thanks!

> 
> > 
> >>
> >> Thank you,
> >>
> >>> ---
> >>>   kernel/trace/trace_events_hist.c | 4 ++--
> >>>   1 file changed, 2 insertions(+), 2 deletions(-)
> >>>
> >>> diff --git a/kernel/trace/trace_events_hist.c b/kernel/trace/trace_events_hist.c
> >>> index 48465f7e97b4..087c19548049 100644
> >>> --- a/kernel/trace/trace_events_hist.c
> >>> +++ b/kernel/trace/trace_events_hist.c
> >>> @@ -983,7 +983,7 @@ static struct hist_field *find_any_var_ref(struct hist_trigger_data *hist_data,
> >>>    * A trigger can define one or more variables.  If any one of them is
> >>>    * currently referenced by any other trigger, this function will
> >>>    * determine that.
> >>> -
> >>> + *
> >>>    * Typically used to determine whether or not a trigger can be removed
> >>>    * - if there are any references to a trigger's variables, it cannot.
> >>>    *
> >>> @@ -3226,7 +3226,7 @@ static struct field_var *create_field_var(struct hist_trigger_data *hist_data,
> >>>    * events.  However, for convenience, users are allowed to directly
> >>>    * specify an event field in an action, which will be automatically
> >>>    * converted into a variable on their behalf.
> >>> -
> >>> + *
> >>>    * This function creates a field variable with the name var_name on
> >>>    * the hist trigger currently being defined on the target event.  If
> >>>    * subsys_name and event_name are specified, this function simply
> >>> -- 
> >>> 2.37.3
> >>>
> >>
> >>
> > 
> 
> -- 
> ~Randy


-- 
Masami Hiramatsu (Google) <mhiramat@kernel.org>