Re: [PATCH] ksmbd: auth: fix most kernel-doc warnings

[Namjae Jeon]

2023-12-16 12:03 GMT+09:00, Randy Dunlap <rdunlap@xxxxxxxxxxxxx>:
> 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@xxxxxxxxxxxxx>
> Cc: Namjae Jeon <linkinjeon@xxxxxxxxxx>
> Cc: Steve French <sfrench@xxxxxxxxx>
> Cc: Sergey Senozhatsky <senozhatsky@xxxxxxxxxxxx>
> Cc: Tom Talpey <tom@xxxxxxxxxx>
> Cc: linux-cifs@xxxxxxxxxxxxxxx
Acked-by: Namjae Jeon <linkinjeon@xxxxxxxxxx>
Applied it to #ksmbd-for-next-next.
Thanks for your patch.