From: Tomasz Unger <tomasz.unger@yahoo.pl>
To: Florian Fainelli <florian.fainelli@broadcom.com>
Cc: Broadcom internal kernel review list
<bcm-kernel-feedback-list@broadcom.com>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
linux-rpi-kernel@lists.infradead.org,
linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org,
Tomasz Unger <tomasz.unger@yahoo.pl>
Subject: [PATCH] platform/raspberrypi: vchiq: Fix kernel-doc Return section
Date: Tue, 10 Nov 2026 22:38:25 +0100 [thread overview]
Message-ID: <20261110-vchiq-dev-kdoc-return-v1-1-dac3e840bcac@yahoo.pl> (raw)
In-Reply-To: <20261110-vchiq-dev-kdoc-return-v1-1-dac3e840bcac.ref@yahoo.pl>
scripts/kernel-doc -Wall reports that vchiq_register_chrdev() has no
description of its return value:
Warning: drivers/platform/raspberrypi/vchiq-interface/vchiq_dev.c:1341
No description found for return value of 'vchiq_register_chrdev'
The comment does describe it, but in a free-form "Returns 0 on success
..." sentence that kernel-doc does not recognize. Convert it to a
"Return:" section.
No functional change.
Signed-off-by: Tomasz Unger <tomasz.unger@yahoo.pl>
---
drivers/platform/raspberrypi/vchiq-interface/vchiq_dev.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/platform/raspberrypi/vchiq-interface/vchiq_dev.c b/drivers/platform/raspberrypi/vchiq-interface/vchiq_dev.c
index f1c9c0d4b96a..7dfeebbf34d3 100644
--- a/drivers/platform/raspberrypi/vchiq-interface/vchiq_dev.c
+++ b/drivers/platform/raspberrypi/vchiq-interface/vchiq_dev.c
@@ -1336,7 +1336,7 @@ static struct miscdevice vchiq_miscdev = {
* device files in userspace.
* @parent: The parent of the char device.
*
- * Returns 0 on success else returns the error code.
+ * Return: 0 on success, or a negative error code on failure.
*/
int vchiq_register_chrdev(struct device *parent)
{
---
base-commit: 6628e7d4c6b25c8d18f1345e3a20d21829aae7e4
change-id: 20261110-vchiq-dev-kdoc-return-5ba9491d7f0c
Best regards,
--
Tomasz Unger <tomasz.unger@yahoo.pl>
parent reply other threads:[~2026-11-10 21:38 UTC|newest]
Thread overview: expand[flat|nested] mbox.gz Atom feed
[parent not found: <20261110-vchiq-dev-kdoc-return-v1-1-dac3e840bcac.ref@yahoo.pl>]
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=20261110-vchiq-dev-kdoc-return-v1-1-dac3e840bcac@yahoo.pl \
--to=tomasz.unger@yahoo.pl \
--cc=bcm-kernel-feedback-list@broadcom.com \
--cc=florian.fainelli@broadcom.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-rpi-kernel@lists.infradead.org \
/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
all inboxes | Powered by JetHome®