2021-06-28 06:22:02

by Lukas Bulwahn

Subject: [PATCH] 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.

Signed-off-by: Lukas Bulwahn <[email protected]>
---
Kees, please pick this quick minor fix into your pgo tree.

kernel/pgo/pgo.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/pgo/pgo.h b/kernel/pgo/pgo.h
index ba3f8499254a..04fbf3bcde1e 100644
--- a/kernel/pgo/pgo.h
+++ b/kernel/pgo/pgo.h
@@ -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.
--
2.17.1

2021-06-28 23:40:51

by Kees Cook

Subject: Re: [PATCH] pgo: rectify comment to proper kernel-doc syntax

On Mon, 28 Jun 2021 07:59:47 +0200, Lukas Bulwahn wrote:
> 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

--
Kees Cook