Skip to contentSkip to conversation

pgo: rectify comment to proper kernel-doc syntax

PATCH Applied Lukas Bulwahn 2 participants 2 messages Jun 28, 2021

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 pgo: rectify comment to proper kernel-doc syntax

The command ./scripts/kernel-doc -none kernel/pgo/pgo.h warns:

kernel/pgo/pgo.h:112: warning: cannot understand function prototype: 'struct llvm_prf_value_node_data '

This is due to a slightly invalid use of kernel-doc syntax for the comment of this struct, that must have probably just slipped through refactoring and review before.

Rectify the comment to proper kernel-doc syntax.

---
Kees, please pick this quick minor fix into your pgo tree.

 kernel/pgo/pgo.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/pgo/pgo.h +1 -1
index ba3f8499254a..04fbf3bcde1e 100644
@@ -103,7 +103,7 @@ struct llvm_prf_data {
 } __aligned(LLVM_INSTR_PROF_DATA_ALIGNMENT);
 
 /**
- * structure llvm_prf_value_node_data - represents the data part of the struct
+ * struct llvm_prf_value_node_data - represents the data part of the struct
  *   llvm_prf_value_node data structure.
  * @value: the value counters.
  * @count: the counters' count.
Signature · 1 line
2.17.1
Applied
#1 lore raw
Quoted 9 lines · Lukas Bulwahn

The command ./scripts/kernel-doc -none kernel/pgo/pgo.h warns:

kernel/pgo/pgo.h:112: warning: cannot understand function prototype: 'struct llvm_prf_value_node_data '

This is due to a slightly invalid use of kernel-doc syntax for the comment of this struct, that must have probably just slipped through refactoring and review before.

[...]

Applied to for-next/clang/features, thanks!

[1/1] pgo: rectify comment to proper kernel-doc syntax

      https://git.kernel.org/kees/c/6a0544606ec7
Signature · 1 line
Kees Cook