From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
Ayush Sawal <ayush.sawal@chelsio.com>,
Vinay Kumar Yadav <vinay.yadav@chelsio.com>,
Rohit Maheshwari <rohitm@chelsio.com>,
Herbert Xu <herbert@gondor.apana.org.au>,
"David S. Miller" <davem@davemloft.net>,
Manoj Malviya <manojmalviya@chelsio.com>,
Atul Gupta <atul.gupta@chelsio.com>,
Jitendra Lulla <jlulla@chelsio.com>,
M R Gowda <yeshaswi@chelsio.com>, Harsh Jain <harsh@chelsio.com>,
linux-crypto@vger.kernel.org
Subject: [PATCH 03/10] crypto: chelsio: chcr_core: Fix some kernel-doc issues
Date: Wed, 3 Mar 2021 14:34:42 +0000 [thread overview]
Message-ID: <20210303143449.3170813-4-lee.jones@linaro.org> (raw)
In-Reply-To: <20210303143449.3170813-1-lee.jones@linaro.org>
Fixes the following W=1 kernel build warning(s):
drivers/crypto/chelsio/chcr_core.c:2: warning: wrong kernel-doc identifier on line:
drivers/crypto/chelsio/chcr_algo.c:806: warning: Function parameter or member 'wrparam' not described in 'create_cipher_wr'
drivers/crypto/chelsio/chcr_algo.c:806: warning: Excess function parameter 'req' description in 'create_cipher_wr'
drivers/crypto/chelsio/chcr_algo.c:806: warning: Excess function parameter 'ctx' description in 'create_cipher_wr'
drivers/crypto/chelsio/chcr_algo.c:806: warning: Excess function parameter 'qid' description in 'create_cipher_wr'
drivers/crypto/chelsio/chcr_algo.c:806: warning: Excess function parameter 'op_type' description in 'create_cipher_wr'
drivers/crypto/chelsio/chcr_algo.c:1566: warning: Function parameter or member 'req' not described in 'create_hash_wr'
drivers/crypto/chelsio/chcr_algo.c:1566: warning: Function parameter or member 'param' not described in 'create_hash_wr'
Cc: Ayush Sawal <ayush.sawal@chelsio.com>
Cc: Vinay Kumar Yadav <vinay.yadav@chelsio.com>
Cc: Rohit Maheshwari <rohitm@chelsio.com>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Manoj Malviya <manojmalviya@chelsio.com>
Cc: Atul Gupta <atul.gupta@chelsio.com>
Cc: Jitendra Lulla <jlulla@chelsio.com>
Cc: M R Gowda <yeshaswi@chelsio.com>
Cc: Harsh Jain <harsh@chelsio.com>
Cc: linux-crypto@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/crypto/chelsio/chcr_algo.c | 8 +++-----
drivers/crypto/chelsio/chcr_core.c | 2 +-
2 files changed, 4 insertions(+), 6 deletions(-)
diff --git a/drivers/crypto/chelsio/chcr_algo.c b/drivers/crypto/chelsio/chcr_algo.c
index f5a336634daa6..f77d3fd962bf8 100644
--- a/drivers/crypto/chelsio/chcr_algo.c
+++ b/drivers/crypto/chelsio/chcr_algo.c
@@ -797,10 +797,7 @@ static inline void create_wreq(struct chcr_context *ctx,
/**
* create_cipher_wr - form the WR for cipher operations
- * @req: cipher req.
- * @ctx: crypto driver context of the request.
- * @qid: ingress qid where response of this WR should be received.
- * @op_type: encryption or decryption
+ * @wrparam: Container for create_cipher_wr()'s parameters
*/
static struct sk_buff *create_cipher_wr(struct cipher_wr_param *wrparam)
{
@@ -1559,7 +1556,8 @@ static inline void chcr_free_shash(struct crypto_shash *base_hash)
/**
* create_hash_wr - Create hash work request
- * @req - Cipher req base
+ * @req: Cipher req base
+ * @param: Container for create_hash_wr()'s parameters
*/
static struct sk_buff *create_hash_wr(struct ahash_request *req,
struct hash_wr_param *param)
diff --git a/drivers/crypto/chelsio/chcr_core.c b/drivers/crypto/chelsio/chcr_core.c
index f91f9d762a45e..f03ef4a23f96d 100644
--- a/drivers/crypto/chelsio/chcr_core.c
+++ b/drivers/crypto/chelsio/chcr_core.c
@@ -1,4 +1,4 @@
-/**
+/*
* This file is part of the Chelsio T4/T5/T6 Ethernet driver for Linux.
*
* Copyright (C) 2011-2016 Chelsio Communications. All rights reserved.
--
2.27.0
next prev parent reply other threads:[~2021-03-03 18:39 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-03 14:34 [PATCH v2 00/10] Rid W=1 warnings in Crypto Lee Jones
2021-03-03 14:34 ` [PATCH 01/10] crypto: hisilicon: sec_drv: Supply missing description for 'sec_queue_empty()'s 'queue' param Lee Jones
2021-03-03 14:34 ` [PATCH 02/10] crypto: bcm: Fix a whole host of kernel-doc misdemeanours Lee Jones
2021-03-03 14:34 ` Lee Jones [this message]
2021-03-03 14:34 ` [PATCH 04/10] crypto: ux500: hash: hash_core: Fix worthy kernel-doc headers and remove others Lee Jones
2021-03-03 14:34 ` [PATCH 05/10] crypto: keembay: ocs-hcu: Fix incorrectly named functions/structs Lee Jones
2021-03-04 12:02 ` Alessandrelli, Daniele
2021-03-03 14:34 ` [PATCH 06/10] crypto: atmel-ecc: Struct headers need to start with keyword 'struct' Lee Jones
2021-03-03 14:34 ` [PATCH 07/10] crypto: caam: caampkc: Provide the name of the function and provide missing descriptions Lee Jones
2021-03-03 17:52 ` Horia Geantă
2021-03-03 14:34 ` [PATCH 08/10] crypto: vmx: Source headers are not good kernel-doc candidates Lee Jones
2021-03-03 14:34 ` [PATCH 09/10] crypto: nx: nx-aes-cbc: Repair some kernel-doc problems Lee Jones
2021-03-03 14:34 ` [PATCH 10/10] crypto: cavium: nitrox_isr: Demote non-compliant kernel-doc headers Lee Jones
2021-03-18 12:44 [PATCH v3 00/10] Rid W=1 warnings in Crypto Lee Jones
2021-03-18 12:44 ` [PATCH 03/10] crypto: chelsio: chcr_core: Fix some kernel-doc issues Lee Jones
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210303143449.3170813-4-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=atul.gupta@chelsio.com \
--cc=ayush.sawal@chelsio.com \
--cc=davem@davemloft.net \
--cc=harsh@chelsio.com \
--cc=herbert@gondor.apana.org.au \
--cc=jlulla@chelsio.com \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=manojmalviya@chelsio.com \
--cc=rohitm@chelsio.com \
--cc=vinay.yadav@chelsio.com \
--cc=yeshaswi@chelsio.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).