OSDN Git Service

crypto: engine - Add parameter description in crypto_transfer_request() kernel-doc...
authorYang Li <yang.lee@linux.alibaba.com>
Wed, 16 Mar 2022 01:03:01 +0000 (09:03 +0800)
committerHerbert Xu <herbert@gondor.apana.org.au>
Fri, 8 Apr 2022 08:13:30 +0000 (16:13 +0800)
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>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
crypto/crypto_engine.c

index 6056a99..bb8e770 100644 (file)
@@ -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,