All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH -next] crypto: engine: Add parameter description in crypto_transfer_request() kernel-doc comment
@ 2022-03-16  1:03 Yang Li
  2022-04-08  8:30 ` Herbert Xu
  0 siblings, 1 reply; 2+ messages in thread
From: Yang Li @ 2022-03-16  1:03 UTC (permalink / raw)
  To: herbert; +Cc: davem, linux-crypto, linux-kernel, Yang Li, Abaci Robot

Add the description of @need_pump in crypto_transfer_request() kernel-doc
comment to remove warning found by running scripts/kernel-doc, which is
caused by using 'make W=1'.

crypto/crypto_engine.c:260: warning: Function parameter or member
'need_pump' not described in 'crypto_transfer_request'

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 crypto/crypto_engine.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/crypto/crypto_engine.c b/crypto/crypto_engine.c
index 6056a990c9f2..bb8e77077f02 100644
--- a/crypto/crypto_engine.c
+++ b/crypto/crypto_engine.c
@@ -253,6 +253,7 @@ static void crypto_pump_work(struct kthread_work *work)
  * crypto_transfer_request - transfer the new request into the engine queue
  * @engine: the hardware engine
  * @req: the request need to be listed into the engine queue
+ * @need_pump: indicates whether queue the pump of request to kthread_work
  */
 static int crypto_transfer_request(struct crypto_engine *engine,
 				   struct crypto_async_request *req,
-- 
2.20.1.7.g153144c


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH -next] crypto: engine: Add parameter description in crypto_transfer_request() kernel-doc comment
  2022-03-16  1:03 [PATCH -next] crypto: engine: Add parameter description in crypto_transfer_request() kernel-doc comment Yang Li
@ 2022-04-08  8:30 ` Herbert Xu
  0 siblings, 0 replies; 2+ messages in thread
From: Herbert Xu @ 2022-04-08  8:30 UTC (permalink / raw)
  To: Yang Li; +Cc: davem, linux-crypto, linux-kernel, Abaci Robot

On Wed, Mar 16, 2022 at 09:03:01AM +0800, Yang Li wrote:
> Add the description of @need_pump in crypto_transfer_request() kernel-doc
> comment to remove warning found by running scripts/kernel-doc, which is
> caused by using 'make W=1'.
> 
> crypto/crypto_engine.c:260: warning: Function parameter or member
> 'need_pump' not described in 'crypto_transfer_request'
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
>  crypto/crypto_engine.c | 1 +
>  1 file changed, 1 insertion(+)

Patch applied.  Thanks.
-- 
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2022-04-08  8:31 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-03-16  1:03 [PATCH -next] crypto: engine: Add parameter description in crypto_transfer_request() kernel-doc comment Yang Li
2022-04-08  8:30 ` Herbert Xu

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.