From: Wolfram Sang <wsa@kernel.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org, kernel test robot <lkp@intel.com>,
Krzysztof Adamski <krzysztof.adamski@nokia.com>,
Andi Shyti <andi.shyti@kernel.org>,
linux-i2c@vger.kernel.org
Subject: Re: [PATCH] i2c: axxia: eliminate kernel-doc warnings
Date: Sat, 28 Oct 2023 14:34:55 +0200 [thread overview]
Message-ID: <ZTz/721T79wA4e1I@shikoro> (raw)
In-Reply-To: <20231026053918.17347-1-rdunlap@infradead.org>
[-- Attachment #1: Type: text/plain, Size: 1454 bytes --]
On Wed, Oct 25, 2023 at 10:39:18PM -0700, Randy Dunlap wrote:
> Add kernel-doc for 'slave' and 'irq' in struct axxia_i2c_dev.
> Drop kernel-doc notation ("/**") for static functions since they
> are not usually documented with kernel-doc.
>
> Prevents these kernel-doc warnings:
>
> i2c-axxia.c:150: warning: Function parameter or member 'slave' not described in 'axxia_i2c_dev'
> i2c-axxia.c:150: warning: Function parameter or member 'irq' not described in 'axxia_i2c_dev'
> i2c-axxia.c:172: warning: Function parameter or member 'ns' not described in 'ns_to_clk'
> i2c-axxia.c:172: warning: Function parameter or member 'clk_mhz' not described in 'ns_to_clk'
> i2c-axxia.c:172: warning: No description found for return value of 'ns_to_clk'
> i2c-axxia.c:271: warning: Function parameter or member 'idev' not described in 'axxia_i2c_empty_rx_fifo'
> i2c-axxia.c:271: warning: No description found for return value of 'axxia_i2c_empty_rx_fifo'
> i2c-axxia.c:303: warning: Function parameter or member 'idev' not described in 'axxia_i2c_fill_tx_fifo'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/all/202310181049.Vo62moV1-lkp@intel.com/
> Cc: Krzysztof Adamski <krzysztof.adamski@nokia.com>
> Cc: Andi Shyti <andi.shyti@kernel.org>
> Cc: Wolfram Sang <wsa@kernel.org>
> Cc: linux-i2c@vger.kernel.org
Applied to for-next, thanks!
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
prev parent reply other threads:[~2023-10-28 12:35 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-26 5:39 [PATCH] i2c: axxia: eliminate kernel-doc warnings Randy Dunlap
2023-10-27 10:04 ` Andi Shyti
2023-10-28 12:34 ` Wolfram Sang [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=ZTz/721T79wA4e1I@shikoro \
--to=wsa@kernel.org \
--cc=andi.shyti@kernel.org \
--cc=krzysztof.adamski@nokia.com \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lkp@intel.com \
--cc=rdunlap@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