linux-kernel - Re: [PATCH] crypto: fix kernel-doc notation in chacha.c and af

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:   Thu, 22 Apr 2021 17:45:08 +1000
From:   Herbert Xu <herbert@...dor.apana.org.au>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org,
        "David S. Miller" <davem@...emloft.net>,
        linux-crypto@...r.kernel.org
Subject: Re: [PATCH] crypto: fix kernel-doc notation in chacha.c and af_alg.c

On Sun, Apr 11, 2021 at 05:05:56PM -0700, Randy Dunlap wrote:
> Fix function name in chacha.c kernel-doc comment to remove a warning.
> 
> Convert af_alg.c to kernel-doc notation to eliminate many kernel-doc
> warnings.
> 
> ../lib/crypto/chacha.c:77: warning: expecting prototype for chacha_block(). Prototype was for chacha_block_generic() instead
> chacha.c:104: warning: Excess function parameter 'out' description in 'hchacha_block_generic'
> 
> af_alg.c:498: warning: Function parameter or member 'sk' not described in 'af_alg_alloc_tsgl'
> ../crypto/af_alg.c:539: warning: expecting prototype for aead_count_tsgl(). Prototype was for af_alg_count_tsgl() instead
> ../crypto/af_alg.c:596: warning: expecting prototype for aead_pull_tsgl(). Prototype was for af_alg_pull_tsgl() instead
> af_alg.c:663: warning: Function parameter or member 'areq' not described in 'af_alg_free_areq_sgls'
> af_alg.c:700: warning: Function parameter or member 'sk' not described in 'af_alg_wait_for_wmem'
> af_alg.c:700: warning: Function parameter or member 'flags' not described in 'af_alg_wait_for_wmem'
> af_alg.c:731: warning: Function parameter or member 'sk' not described in 'af_alg_wmem_wakeup'
> af_alg.c:757: warning: Function parameter or member 'sk' not described in 'af_alg_wait_for_data'
> af_alg.c:757: warning: Function parameter or member 'flags' not described in 'af_alg_wait_for_data'
> af_alg.c:757: warning: Function parameter or member 'min' not described in 'af_alg_wait_for_data'
> af_alg.c:796: warning: Function parameter or member 'sk' not described in 'af_alg_data_wakeup'
> af_alg.c:832: warning: Function parameter or member 'sock' not described in 'af_alg_sendmsg'
> af_alg.c:832: warning: Function parameter or member 'msg' not described in 'af_alg_sendmsg'
> af_alg.c:832: warning: Function parameter or member 'size' not described in 'af_alg_sendmsg'
> af_alg.c:832: warning: Function parameter or member 'ivsize' not described in 'af_alg_sendmsg'
> af_alg.c:985: warning: Function parameter or member 'sock' not described in 'af_alg_sendpage'
> af_alg.c:985: warning: Function parameter or member 'page' not described in 'af_alg_sendpage'
> af_alg.c:985: warning: Function parameter or member 'offset' not described in 'af_alg_sendpage'
> af_alg.c:985: warning: Function parameter or member 'size' not described in 'af_alg_sendpage'
> af_alg.c:985: warning: Function parameter or member 'flags' not described in 'af_alg_sendpage'
> af_alg.c:1040: warning: Function parameter or member 'areq' not described in 'af_alg_free_resources'
> af_alg.c:1059: warning: Function parameter or member '_req' not described in 'af_alg_async_cb'
> af_alg.c:1059: warning: Function parameter or member 'err' not described in 'af_alg_async_cb'
> af_alg.c:1083: warning: Function parameter or member 'file' not described in 'af_alg_poll'
> af_alg.c:1083: warning: Function parameter or member 'sock' not described in 'af_alg_poll'
> af_alg.c:1083: warning: Function parameter or member 'wait' not described in 'af_alg_poll'
> af_alg.c:1114: warning: Function parameter or member 'sk' not described in 'af_alg_alloc_areq'
> af_alg.c:1114: warning: Function parameter or member 'areqlen' not described in 'af_alg_alloc_areq'
> af_alg.c:1146: warning: Function parameter or member 'sk' not described in 'af_alg_get_rsgl'
> af_alg.c:1146: warning: Function parameter or member 'msg' not described in 'af_alg_get_rsgl'
> af_alg.c:1146: warning: Function parameter or member 'flags' not described in 'af_alg_get_rsgl'
> af_alg.c:1146: warning: Function parameter or member 'areq' not described in 'af_alg_get_rsgl'
> af_alg.c:1146: warning: Function parameter or member 'maxsize' not described in 'af_alg_get_rsgl'
> af_alg.c:1146: warning: Function parameter or member 'outlen' not described in 'af_alg_get_rsgl'
> 
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Herbert Xu <herbert@...dor.apana.org.au>
> Cc: "David S. Miller" <davem@...emloft.net>
> Cc: linux-crypto@...r.kernel.org
> ---
>  crypto/af_alg.c     |   94 +++++++++++++++++++++++-------------------
>  lib/crypto/chacha.c |    4 -
>  2 files changed, 55 insertions(+), 43 deletions(-)

Patch applied.  Thanks.
-- 
Email: Herbert Xu <herbert@...dor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt