| Message ID | 20231216030357.7728-1-rdunlap@infradead.org |
|---|---|
| State | New |
| Headers | show |
| Series | ksmbd: auth: fix most kernel-doc warnings | expand |
2023-12-16 12:03 GMT+09:00, Randy Dunlap <rdunlap@infradead.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@infradead.org> > Cc: Namjae Jeon <linkinjeon@kernel.org> > Cc: Steve French <sfrench@samba.org> > Cc: Sergey Senozhatsky <senozhatsky@chromium.org> > Cc: Tom Talpey <tom@talpey.com> > Cc: linux-cifs@vger.kernel.org Acked-by: Namjae Jeon <linkinjeon@kernel.org> Applied it to #ksmbd-for-next-next. Thanks for your patch.
diff -- a/fs/smb/server/auth.c b/fs/smb/server/auth.c --- a/fs/smb/server/auth.c +++ b/fs/smb/server/auth.c @@ -208,10 +208,12 @@ out: /** * ksmbd_auth_ntlmv2() - NTLMv2 authentication handler - * @sess: session of connection + * @conn: connection + * @sess: session of connection * @ntlmv2: NTLMv2 challenge response * @blen: NTLMv2 blob length * @domain_name: domain name + * @cryptkey: session crypto key * * Return: 0 on success, error number on error */ @@ -294,7 +296,8 @@ out: * ksmbd_decode_ntlmssp_auth_blob() - helper function to construct * authenticate blob * @authblob: authenticate blob source pointer - * @usr: user details + * @blob_len: length of the @authblob message + * @conn: connection * @sess: session of connection * * Return: 0 on success, error number on error @@ -376,8 +379,8 @@ int ksmbd_decode_ntlmssp_auth_blob(struc * ksmbd_decode_ntlmssp_neg_blob() - helper function to construct * negotiate blob * @negblob: negotiate blob source pointer - * @rsp: response header pointer to be updated - * @sess: session of connection + * @blob_len: length of the @authblob message + * @conn: connection * */ int ksmbd_decode_ntlmssp_neg_blob(struct negotiate_message *negblob, @@ -403,8 +406,7 @@ int ksmbd_decode_ntlmssp_neg_blob(struct * ksmbd_build_ntlmssp_challenge_blob() - helper function to construct * challenge blob * @chgblob: challenge blob source pointer to initialize - * @rsp: response header pointer to be updated - * @sess: session of connection + * @conn: connection * */ unsigned int
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@infradead.org> Cc: Namjae Jeon <linkinjeon@kernel.org> Cc: Steve French <sfrench@samba.org> Cc: Sergey Senozhatsky <senozhatsky@chromium.org> Cc: Tom Talpey <tom@talpey.com> Cc: linux-cifs@vger.kernel.org --- fs/smb/server/auth.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-)