Skip to contentSkip to conversation

kernel/trace/trace_kprobe.c - fix comment format

PATCH NAK Valdis Kl=?utf-8?Q?=c4=93?=tnieks 3 participants 5 messages Mar 12, 2019 1 message not in the archive Tracing

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kernel/trace/trace_kprobe.c - fix comment format

CC kernel/trace/trace_kprobe.o
kernel/trace/trace_kprobe.c:41: warning: cannot understand function prototype: 'struct trace_kprobe '

The real problem is that a comment looked like kerneldoc when it shouldn't be...

kernel/trace/trace_kprobe.c +1 -1
index 9eaf07f99212..c825c591553a 100644
@@ -35,7 +35,7 @@ static struct dyn_event_operations trace_kprobe_ops = {
 	.match = trace_kprobe_match,
 };
 
-/**
+/*
  * Kprobe event core functions
  */
 struct trace_kprobe {
maintainer NAK
#1 lore raw
Quoted 12 lines · On Tue, 12 Mar 2019 04:58:32 -0400 "Valdis Klētnieks"…

CC kernel/trace/trace_kprobe.o
kernel/trace/trace_kprobe.c:41: warning: cannot understand function prototype: 'struct trace_kprobe '

The real problem is that a comment looked like kerneldoc when it shouldn't be...

kernel/trace/trace_kprobe.c +0 -0
index 9eaf07f99212..c825c591553a 100644

kernel/trace/trace_kprobe.c static struct dyn_event_operations trace_kprobe_ops = { · line 38

Quoted 5 lines
kernel/trace/trace_kprobe.c +1 -1
@@ -35,7 +35,7 @@ static struct dyn_event_operations trace_kprobe_ops = {
 	.match = trace_kprobe_match,
 };
 
-/**
+/*

NACK.

This isn't a kernel doc comment, and I don't want to make it one when it is not. Just ignore that warning.

-- Steve

Quoted 3 lines
kernel/trace/trace_kprobe.c +0 -0
  * Kprobe event core functions
  */
 struct trace_kprobe {
#2 lore raw
Quoted 23 lines · Steven Rostedt
Quoted 12 lines · On Tue, 12 Mar 2019 04:58:32 -0400 "Valdis Klētnieks"…

CC kernel/trace/trace_kprobe.o
kernel/trace/trace_kprobe.c:41: warning: cannot understand function prototype: 'struct trace_kprobe '

The real problem is that a comment looked like kerneldoc when it shouldn't be...

kernel/trace/trace_kprobe.c +0 -0
index 9eaf07f99212..c825c591553a 100644

kernel/trace/trace_kprobe.c static struct dyn_event_operations trace_kprobe_ops = { · line 38

Quoted 5 lines
kernel/trace/trace_kprobe.c +1 -1
@@ -35,7 +35,7 @@ static struct dyn_event_operations trace_kprobe_ops = {
 	.match = trace_kprobe_match,
 };
 
-/**
+/*

NACK.

Quoted 4 lines

This isn't a kernel doc comment, and I don't want to make it one when it is not. Just ignore that warning.

-- Steve

Huh? The patch doesn't do that -- it does the opposite of that. I.e., begin a non-kernel-doc comment with /* instead of /**.

Quoted 5 lines
Quoted 4 lines
kernel/trace/trace_kprobe.c +0 -0
  * Kprobe event core functions
  */
 struct trace_kprobe {
Signature · 1 line
~Randy
maintainer
#3 lore raw
Quoted 9 lines · On Tue, 12 Mar 2019 08:14:52 -0700 Randy Dunlap <[email protected]> wrote:
Quoted 6 lines

NACK.

This isn't a kernel doc comment, and I don't want to make it one when it is not. Just ignore that warning.

-- Steve

Huh? The patch doesn't do that -- it does the opposite of that. I.e., begin a non-kernel-doc comment with /* instead of /**.

Ah, my head swapped the "-" to the "+". I thought the patch was adding the extra '*'. Nevermind, I'll take it.

Thanks for pointing that out.

Also, I'll change the subject to:

trace/probes: Remove kernel doc style from non kernel doc comment

-- Steve

A message that is not in the archive (sent off-list or not yet received): 3692.1552381710@turing-police

maintainer
#5 lore raw
Quoted 5 lines · On Tue, 12 Mar 2019 05:08:30 -0400 [email protected] wrote:
Quoted 4 lines · Valdis Klētnieks

CC kernel/trace/trace_kprobe.o
kernel/trace/trace_kprobe.c:41: warning: cannot understand function prototype: 'struct trace_kprobe '

Quoted 7 lines
Quoted 1 line

The real problem is that a comment looked like kerneldoc when it shouldn't be...

After finding another case of this, it's debatable whether the *REAL* real problem is that gcc is buggy/incomplete and doesn't know that kerneldoc comments can be applied to structure definitions as well....

What's the consensus? Should I go yell at the gcc people instead, or?

Nevermind, I mistook your patch as adding a kernel doc comment.

It's fine, I'll take it.

Thanks!

-- Steve