From: Florian Fainelli <florian.fainelli@broadcom.com>
To: bcm-kernel-feedback-list@broadcom.com,
Tomasz Unger <tomasz.unger@yahoo.pl>,
Florian Fainelli <florian.fainelli@broadcom.com>
Cc: Florian Fainelli <f.fainelli@gmail.com>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
linux-rpi-kernel@lists.infradead.org,
linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] platform/raspberrypi: vchiq: Fix kernel-doc Return section
Date: Fri, 13 Nov 2026 19:32:10 -0800 [thread overview]
Message-ID: <20261114033210.876038-1-florian.fainelli@broadcom.com> (raw)
In-Reply-To: <20261110-vchiq-dev-kdoc-return-v1-1-dac3e840bcac@yahoo.pl>
From: Florian Fainelli <f.fainelli@gmail.com>
On Tue, 10 Nov 2026 22:38:25 +0100, Tomasz Unger <tomasz.unger@yahoo.pl> wrote:
> 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>
> ---
Applied to https://github.com/Broadcom/stblinux/commits/drivers/next, thanks!
--
Florian
prev parent reply other threads:[~2026-11-14 3:32 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20261110-vchiq-dev-kdoc-return-v1-1-dac3e840bcac.ref@yahoo.pl>
2026-11-10 21:38 ` [PATCH] platform/raspberrypi: vchiq: Fix kernel-doc Return section Tomasz Unger
2026-11-14 3:32 ` Florian Fainelli [this message]
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=20261114033210.876038-1-florian.fainelli@broadcom.com \
--to=florian.fainelli@broadcom.com \
--cc=bcm-kernel-feedback-list@broadcom.com \
--cc=f.fainelli@gmail.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 \
--cc=tomasz.unger@yahoo.pl \
/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