Received-SPF: pass (google.com: domain of linux-kernel+bounces-2063-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
Precedence: bulk
MIME-Version: 1.0
In-Reply-To: <20231216030357.7728-1-rdunlap@infradead.org>
References: <20231216030357.7728-1-rdunlap@infradead.org>
From: Namjae Jeon <linkinjeon@kernel.org>
Date: Sat, 16 Dec 2023 13:28:19 +0900
Message-ID: <CAKYAXd_yckU+dQwSfkA9P4xAbjAU+jaxJgV=R6n5CvrjQtm=fQ@mail.gmail.com>
Subject: Re: [PATCH] ksmbd: auth: fix most kernel-doc warnings
To: Randy Dunlap <rdunlap@infradead.org>
Cc: linux-kernel@vger.kernel.org, Steve French <sfrench@samba.org>, 
	Sergey Senozhatsky <senozhatsky@chromium.org>, Tom Talpey <tom@talpey.com>, linux-cifs@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"

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.