crypto: engine: Add parameter description in crypto_transfer_request() kernel-doc comment
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'
Reported-by Abaci Robot <[email protected]>
Signed-off-by Yang Li <[email protected]>
--- crypto/crypto_engine.c | 1 + 1 file changed, 1 insertion(+)
crypto/crypto_engine.c +1 -0
@@ -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
Herbert Xu
maintainerQuoted 4 lines · Yang Li
Add the description of @need_pump in
crypto_transfer_request()kernel-doc comment to remove warning found by runningscripts/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'Reported-by Abaci Robot <[email protected]>Signed-off-by Yang Li <[email protected]>--- 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