Skip to contentSkip to conversation

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

PATCH In review Yang Li 2 participants 2 messages Mar 16, 2022 – Apr 8, 2022 Crypto API

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 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'

---
 crypto/crypto_engine.c | 1 +
 1 file changed, 1 insertion(+)
crypto/crypto_engine.c +1 -0
index 6056a990c9f2..bb8e77077f02 100644
@@ -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,
Signature · 1 line
2.20.1.7.g153144c
maintainer
#1 lore raw
Quoted 4 lines · Yang Li

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'.

Quoted 8 lines

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

---
 crypto/crypto_engine.c | 1 +
 1 file changed, 1 insertion(+)

Patch applied. Thanks.

Signature · 3 lines
Email: Herbert Xu <[email protected]>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt