linux-kernel - Re: [PATCH] ksmbd: auth: fix most 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: <CAKYAXd_yckU+dQwSfkA9P4xAbjAU+jaxJgV=R6n5CvrjQtm=fQ@mail.gmail.com>
Date: Sat, 16 Dec 2023 13:28:19 +0900
From: Namjae Jeon <linkinjeon@...nel.org>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, Steve French <sfrench@...ba.org>, 
	Sergey Senozhatsky <senozhatsky@...omium.org>, Tom Talpey <tom@...pey.com>, linux-cifs@...r.kernel.org
Subject: Re: [PATCH] ksmbd: auth: fix most kernel-doc warnings

2023-12-16 12:03 GMT+09:00, Randy Dunlap <rdunlap@...radead.org>:
> Fix 12 of 17 kernel-doc warnings in auth.c:
>
> auth.c:221: warning: Function parameter or member 'conn' not described in
> 'ksmbd_auth_ntlmv2'
> auth.c:221: warning: Function parameter or member 'cryptkey' not described
> in 'ksmbd_auth_ntlmv2'
> auth.c:305: warning: Function parameter or member 'blob_len' not described
> in 'ksmbd_decode_ntlmssp_auth_blob'
> auth.c:305: warning: Function parameter or member 'conn' not described in
> 'ksmbd_decode_ntlmssp_auth_blob'
> auth.c:305: warning: Excess function parameter 'usr' description in
> 'ksmbd_decode_ntlmssp_auth_blob'
> auth.c:385: warning: Function parameter or member 'blob_len' not described
> in 'ksmbd_decode_ntlmssp_neg_blob'
> auth.c:385: warning: Function parameter or member 'conn' not described in
> 'ksmbd_decode_ntlmssp_neg_blob'
> auth.c:385: warning: Excess function parameter 'rsp' description in
> 'ksmbd_decode_ntlmssp_neg_blob'
> auth.c:385: warning: Excess function parameter 'sess' description in
> 'ksmbd_decode_ntlmssp_neg_blob'
> auth.c:413: warning: Function parameter or member 'conn' not described in
> 'ksmbd_build_ntlmssp_challenge_blob'
> auth.c:413: warning: Excess function parameter 'rsp' description in
> 'ksmbd_build_ntlmssp_challenge_blob'
> auth.c:413: warning: Excess function parameter 'sess' description in
> 'ksmbd_build_ntlmssp_challenge_blob'
>
> The other 5 are only present when a W=1 kernel build is done or
> when scripts/kernel-doc is run with -Wall. They are:
>
> auth.c:81: warning: No description found for return value of
> 'ksmbd_gen_sess_key'
> auth.c:385: warning: No description found for return value of
> 'ksmbd_decode_ntlmssp_neg_blob'
> auth.c:413: warning: No description found for return value of
> 'ksmbd_build_ntlmssp_challenge_blob'
> auth.c:577: warning: No description found for return value of
> 'ksmbd_sign_smb2_pdu'
> auth.c:628: warning: No description found for return value of
> 'ksmbd_sign_smb3_pdu'
>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Namjae Jeon <linkinjeon@...nel.org>
> Cc: Steve French <sfrench@...ba.org>
> Cc: Sergey Senozhatsky <senozhatsky@...omium.org>
> Cc: Tom Talpey <tom@...pey.com>
> Cc: linux-cifs@...r.kernel.org
Acked-by: Namjae Jeon <linkinjeon@...nel.org>
Applied it to #ksmbd-for-next-next.
Thanks for your patch.