| Message ID | 20220316010301.3166-1-yang.lee@linux.alibaba.com (mailing list archive) |
|---|---|
| State | Accepted |
| Delegated to: | Herbert Xu |
| Headers | show |
| Series | [-next] crypto: engine: Add parameter description in crypto_transfer_request() kernel-doc comment | expand |
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.
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,
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(+)