Skip to content

Commit b4068f1

Browse files
rddunlapSteve French
authored andcommitted
ksmbd: auth: fix most kernel-doc warnings
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> Signed-off-by: Steve French <stfrench@microsoft.com>
1 parent ebfee7a commit b4068f1

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

fs/smb/server/auth.c

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -208,10 +208,12 @@ static int calc_ntlmv2_hash(struct ksmbd_conn *conn, struct ksmbd_session *sess,
208208

209209
/**
210210
* ksmbd_auth_ntlmv2() - NTLMv2 authentication handler
211-
* @sess: session of connection
211+
* @conn: connection
212+
* @sess: session of connection
212213
* @ntlmv2: NTLMv2 challenge response
213214
* @blen: NTLMv2 blob length
214215
* @domain_name: domain name
216+
* @cryptkey: session crypto key
215217
*
216218
* Return: 0 on success, error number on error
217219
*/
@@ -294,7 +296,8 @@ int ksmbd_auth_ntlmv2(struct ksmbd_conn *conn, struct ksmbd_session *sess,
294296
* ksmbd_decode_ntlmssp_auth_blob() - helper function to construct
295297
* authenticate blob
296298
* @authblob: authenticate blob source pointer
297-
* @usr: user details
299+
* @blob_len: length of the @authblob message
300+
* @conn: connection
298301
* @sess: session of connection
299302
*
300303
* Return: 0 on success, error number on error
@@ -376,8 +379,8 @@ int ksmbd_decode_ntlmssp_auth_blob(struct authenticate_message *authblob,
376379
* ksmbd_decode_ntlmssp_neg_blob() - helper function to construct
377380
* negotiate blob
378381
* @negblob: negotiate blob source pointer
379-
* @rsp: response header pointer to be updated
380-
* @sess: session of connection
382+
* @blob_len: length of the @authblob message
383+
* @conn: connection
381384
*
382385
*/
383386
int ksmbd_decode_ntlmssp_neg_blob(struct negotiate_message *negblob,
@@ -403,8 +406,7 @@ int ksmbd_decode_ntlmssp_neg_blob(struct negotiate_message *negblob,
403406
* ksmbd_build_ntlmssp_challenge_blob() - helper function to construct
404407
* challenge blob
405408
* @chgblob: challenge blob source pointer to initialize
406-
* @rsp: response header pointer to be updated
407-
* @sess: session of connection
409+
* @conn: connection
408410
*
409411
*/
410412
unsigned int

0 commit comments

Comments
 (0)