From: hanzhijian <hanzhijian1991@gmail.com>
To: Thomas Bogendoerfer <tsbogend@alpha.franken.de>,
Borislav Petkov <bp@alien8.de>, Tony Luck <tony.luck@intel.com>
Cc: linux-edac@vger.kernel.org, linux-mips@vger.kernel.org,
linux-kernel@vger.kernel.org,
hanzhijian <hanzhijian1991@gmail.com>
Subject: [PATCH] EDAC/octeon: fix kernel-doc comment for co_cache_error_event
Date: Sat, 22 Aug 2026 07:37:51 +0800 [thread overview]
Message-ID: <20260821233751.2331272-1-hanzhijian1991@gmail.com> (raw)
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
next reply other threads:[~2026-08-21 23:38 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-08-21 23:37 hanzhijian [this message]
2026-09-02 1:23 ` [PATCH] EDAC/octeon: fix kernel-doc comment for co_cache_error_event Borislav Petkov
2026-09-02 3:42 ` Zhijian Han
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260821233751.2331272-1-hanzhijian1991@gmail.com \
--to=hanzhijian1991@gmail.com \
--cc=bp@alien8.de \
--cc=linux-edac@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mips@vger.kernel.org \
--cc=tony.luck@intel.com \
--cc=tsbogend@alpha.franken.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox