* [PATCH] EDAC/octeon: fix kernel-doc comment for co_cache_error_event
@ 2026-08-21 23:37 hanzhijian
2026-09-02 1:23 ` Borislav Petkov
0 siblings, 1 reply; 3+ messages in thread
From: hanzhijian @ 2026-08-21 23:37 UTC (permalink / raw)
To: Thomas Bogendoerfer, Borislav Petkov, Tony Luck
Cc: linux-edac, linux-mips, linux-kernel, hanzhijian
The comment for co_cache_error_event() starts with "/**" but lacks the
function name line, so scripts/kernel-doc reports "isn't a kernel-doc
comment" and it is silently dropped from the generated documentation.
Add the missing name line and document the parameters.
Signed-off-by: hanzhijian <hanzhijian1991@gmail.com>
---
drivers/edac/octeon_edac-pc.c | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/drivers/edac/octeon_edac-pc.c b/drivers/edac/octeon_edac-pc.c
index aa1219db0..076a3952f 100644
--- a/drivers/edac/octeon_edac-pc.c
+++ b/drivers/edac/octeon_edac-pc.c
@@ -31,9 +31,11 @@ struct co_cache_error {
};
/**
- * EDAC CPU cache error callback
+ * co_cache_error_event() - EDAC CPU cache error callback
*
+ * @this: notifier block
* @event: non-zero if unrecoverable.
+ * @ptr: unused
*/
static int co_cache_error_event(struct notifier_block *this,
unsigned long event, void *ptr)
--
2.43.0
^ permalink raw reply related [flat|nested] 3+ messages in thread* Re: [PATCH] EDAC/octeon: fix kernel-doc comment for co_cache_error_event
2026-08-21 23:37 [PATCH] EDAC/octeon: fix kernel-doc comment for co_cache_error_event hanzhijian
@ 2026-09-02 1:23 ` Borislav Petkov
2026-09-02 3:42 ` Zhijian Han
0 siblings, 1 reply; 3+ messages in thread
From: Borislav Petkov @ 2026-09-02 1:23 UTC (permalink / raw)
To: hanzhijian
Cc: Thomas Bogendoerfer, Tony Luck, linux-edac, linux-mips,
linux-kernel
On Sat, Aug 22, 2026 at 07:37:51AM +0800, hanzhijian wrote:
> The comment for co_cache_error_event() starts with "/**" but lacks the
> function name line, so scripts/kernel-doc reports "isn't a kernel-doc
> comment" and it is silently dropped from the generated documentation.
>
> Add the missing name line and document the parameters.
>
> Signed-off-by: hanzhijian <hanzhijian1991@gmail.com>
I'm presuming your legal name is "Zhijian Han"?
Because you should use your proper legal name when you sign off on patches.
You don't have to send a new version - I can fix it up when applying.
Thx.
--
Regards/Gruss,
Boris.
https://people.kernel.org/tglx/notes-about-netiquette
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [PATCH] EDAC/octeon: fix kernel-doc comment for co_cache_error_event
2026-09-02 1:23 ` Borislav Petkov
@ 2026-09-02 3:42 ` Zhijian Han
0 siblings, 0 replies; 3+ messages in thread
From: Zhijian Han @ 2026-09-02 3:42 UTC (permalink / raw)
To: Borislav Petkov
Cc: Thomas Bogendoerfer, Tony Luck, linux-edac, linux-mips,
linux-kernel
On Tue, Sep 01, 2026 at 06:23:31PM -0700, Borislav Petkov wrote:
> I'm presuming your legal name is "Zhijian Han"?
> Because you should use your proper legal name when you sign off on patches.
> You don't have to send a new version - I can fix it up when applying.
Yes, "Zhijian Han" is correct. Thank you for fixing it up.
Regards,
Zhijian
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2026-09-02 3:42 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-08-21 23:37 [PATCH] EDAC/octeon: fix kernel-doc comment for co_cache_error_event hanzhijian
2026-09-02 1:23 ` Borislav Petkov
2026-09-02 3:42 ` Zhijian Han
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox