linux-kernel - Re: [PATCH] i2c: axxia: eliminate kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <ZTz/721T79wA4e1I@shikoro>
Date:   Sat, 28 Oct 2023 14:34:55 +0200
From:   Wolfram Sang <wsa@...nel.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org, kernel test robot <lkp@...el.com>,
        Krzysztof Adamski <krzysztof.adamski@...ia.com>,
        Andi Shyti <andi.shyti@...nel.org>, linux-i2c@...r.kernel.org
Subject: Re: [PATCH] i2c: axxia: eliminate kernel-doc warnings

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@...radead.org>
> Reported-by: kernel test robot <lkp@...el.com>
> Closes: https://lore.kernel.org/all/202310181049.Vo62moV1-lkp@intel.com/
> Cc: Krzysztof Adamski <krzysztof.adamski@...ia.com>
> Cc: Andi Shyti <andi.shyti@...nel.org>
> Cc: Wolfram Sang <wsa@...nel.org>
> Cc: linux-i2c@...r.kernel.org

Applied to for-next, thanks!


Download attachment "signature.asc" of type "application/pgp-signature" (834 bytes)