crypto: engine - Add parameter description in crypto_transfer_request() kernel-doc comment

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>
This commit is contained in:
Yang Li 2022-03-16 09:03:01 +08:00 committed by Herbert Xu
parent 5b33e0ec88
commit d5db91d26a
1 changed files with 1 additions and 0 deletions

View 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 * crypto_transfer_request - transfer the new request into the engine queue
* @engine: the hardware engine * @engine: the hardware engine
* @req: the request need to be listed into the engine queue * @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, static int crypto_transfer_request(struct crypto_engine *engine,
struct crypto_async_request *req, struct crypto_async_request *req,