linux-kernel - Re: [PATCH] i2c: rk3x: fix a bunch of 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]

Date:   Fri, 20 Jan 2023 10:20:53 +0100
From:   Wolfram Sang <wsa@...nel.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org, Heiko Stuebner <heiko@...ech.de>,
        linux-arm-kernel@...ts.infradead.org,
        linux-rockchip@...ts.infradead.org, linux-i2c@...r.kernel.org
Subject: Re: [PATCH] i2c: rk3x: fix a bunch of kernel-doc warnings

On Thu, Jan 12, 2023 at 10:38:05PM -0800, Randy Dunlap wrote:
> Fix multiple W=1 kernel-doc warnings in i2c-rk3x.c:
> 
> drivers/i2c/busses/i2c-rk3x.c:83: warning: missing initial short description on line:
>  * struct i2c_spec_values:
> drivers/i2c/busses/i2c-rk3x.c:139: warning: missing initial short description on line:
>  * struct rk3x_i2c_calced_timings:
> drivers/i2c/busses/i2c-rk3x.c:162: warning: missing initial short description on line:
>  * struct rk3x_i2c_soc_data:
> drivers/i2c/busses/i2c-rk3x.c:242: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Generate a START condition, which triggers a REG_INT_START interrupt.
> drivers/i2c/busses/i2c-rk3x.c:261: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Generate a STOP condition, which triggers a REG_INT_STOP interrupt.
> drivers/i2c/busses/i2c-rk3x.c:304: warning: expecting prototype for Setup a read according to i2c(). Prototype was for rk3x_i2c_prepare_read() instead
> drivers/i2c/busses/i2c-rk3x.c:335: warning: expecting prototype for Fill the transmit buffer with data from i2c(). Prototype was for rk3x_i2c_fill_transmit_buf() instead
> drivers/i2c/busses/i2c-rk3x.c:535: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Get timing values of I2C specification
> drivers/i2c/busses/i2c-rk3x.c:552: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Calculate divider values for desired SCL frequency
> drivers/i2c/busses/i2c-rk3x.c:713: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Calculate timing values for desired SCL frequency
> drivers/i2c/busses/i2c-rk3x.c:963: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Setup I2C registers for an I2C operation specified by msgs, num.
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Heiko Stuebner <heiko@...ech.de>
> Cc: linux-arm-kernel@...ts.infradead.org
> Cc: linux-rockchip@...ts.infradead.org
> Cc: Wolfram Sang <wsa@...nel.org>
> Cc: linux-i2c@...r.kernel.org

Applied to for-current, thanks!


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