* [PATCH] pgo: rectify comment to proper kernel-doc syntax
@ 2021-06-28 5:59 Lukas Bulwahn
2021-06-28 19:29 ` Kees Cook
0 siblings, 1 reply; 2+ messages in thread
From: Lukas Bulwahn @ 2021-06-28 5:59 UTC (permalink / raw)
To: Sami Tolvanen, Bill Wendling, Kees Cook, clang-built-linux, linux-kernel
Cc: Nathan Chancellor, Nick Desaulniers, linux-doc, kernel-janitors,
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.
Rectify the comment to proper kernel-doc syntax.
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
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
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] pgo: rectify comment to proper kernel-doc syntax
2021-06-28 5:59 [PATCH] pgo: rectify comment to proper kernel-doc syntax Lukas Bulwahn
@ 2021-06-28 19:29 ` Kees Cook
0 siblings, 0 replies; 2+ messages in thread
From: Kees Cook @ 2021-06-28 19:29 UTC (permalink / raw)
To: Sami Tolvanen, clang-built-linux, Lukas Bulwahn, Bill Wendling,
linux-kernel
Cc: Kees Cook, Nathan Chancellor, kernel-janitors, linux-doc,
Nick Desaulniers
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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-06-28 19:29 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-06-28 5:59 [PATCH] pgo: rectify comment to proper kernel-doc syntax Lukas Bulwahn
2021-06-28 19:29 ` Kees Cook
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.