From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Doug Ledford <dledford@redhat.com>,
Jason Gunthorpe <jgg@ziepe.ca>,
linux-rdma@vger.kernel.org
Subject: [PATCH 05/20] RDMA/core/cache: Fix some misspellings, missing and superfluous param descriptions
Date: Mon, 18 Jan 2021 22:39:14 +0000 [thread overview]
Message-ID: <20210118223929.512175-6-lee.jones@linaro.org> (raw)
In-Reply-To: <20210118223929.512175-1-lee.jones@linaro.org>
Fixes the following W=1 kernel build warning(s):
drivers/infiniband/core/cache.c:688: warning: Function parameter or member 'ib_dev' not described in 'rdma_find_gid_by_port'
drivers/infiniband/core/cache.c:688: warning: Function parameter or member 'port' not described in 'rdma_find_gid_by_port'
drivers/infiniband/core/cache.c:688: warning: Excess function parameter 'device' description in 'rdma_find_gid_by_port'
drivers/infiniband/core/cache.c:688: warning: Excess function parameter 'port_num' description in 'rdma_find_gid_by_port'
drivers/infiniband/core/cache.c:741: warning: Function parameter or member 'ib_dev' not described in 'rdma_find_gid_by_filter'
drivers/infiniband/core/cache.c:741: warning: Function parameter or member 'context' not described in 'rdma_find_gid_by_filter'
drivers/infiniband/core/cache.c:741: warning: Excess function parameter 'device' description in 'rdma_find_gid_by_filter'
drivers/infiniband/core/cache.c:1263: warning: Excess function parameter 'num_entries' description in 'rdma_query_gid_table'
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@ziepe.ca>
Cc: linux-rdma@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/infiniband/core/cache.c | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/drivers/infiniband/core/cache.c b/drivers/infiniband/core/cache.c
index 7989b7e1d1c04..5c9fac7cf4203 100644
--- a/drivers/infiniband/core/cache.c
+++ b/drivers/infiniband/core/cache.c
@@ -669,11 +669,10 @@ int ib_cache_gid_del_all_netdev_gids(struct ib_device *ib_dev, u8 port,
* rdma_find_gid_by_port - Returns the GID entry attributes when it finds
* a valid GID entry for given search parameters. It searches for the specified
* GID value in the local software cache.
- * @device: The device to query.
+ * @ib_dev: The device to query.
* @gid: The GID value to search for.
* @gid_type: The GID type to search for.
- * @port_num: The port number of the device where the GID value should be
- * searched.
+ * @port: The port number of the device where the GID value should be searched.
* @ndev: In RoCE, the net device of the device. NULL means ignore.
*
* Returns sgid attributes if the GID is found with valid reference or
@@ -719,7 +718,7 @@ EXPORT_SYMBOL(rdma_find_gid_by_port);
/**
* rdma_find_gid_by_filter - Returns the GID table attribute where a
* specified GID value occurs
- * @device: The device to query.
+ * @ib_dev: The device to query.
* @gid: The GID value to search for.
* @port: The port number of the device where the GID value could be
* searched.
@@ -728,6 +727,7 @@ EXPORT_SYMBOL(rdma_find_gid_by_port);
* otherwise, we continue searching the GID table. It's guaranteed that
* while filter is executed, ndev field is valid and the structure won't
* change. filter is executed in an atomic context. filter must not be NULL.
+ * @context: Private data to pass into the call-back.
*
* rdma_find_gid_by_filter() searches for the specified GID value
* of which the filter function returns true in the port's GID table.
@@ -1253,7 +1253,6 @@ EXPORT_SYMBOL(rdma_get_gid_attr);
* @entries: Entries where GID entries are returned.
* @max_entries: Maximum number of entries that can be returned.
* Entries array must be allocated to hold max_entries number of entries.
- * @num_entries: Updated to the number of entries that were successfully read.
*
* Returns number of entries on success or appropriate error code.
*/
--
2.25.1
next prev parent reply other threads:[~2021-01-18 22:48 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-18 22:39 [PATCH 00/20] Rid W=1 warnings from Infinibad Lee Jones
2021-01-18 22:39 ` [PATCH 01/20] RDMA/hw: i40iw_hmc: Fix misspellings of '*idx' args Lee Jones
2021-01-18 22:39 ` [PATCH 02/20] RDMA/core: device: Fix formatting in worthy kernel-doc header and demote another Lee Jones
2021-01-18 22:39 ` [PATCH 03/20] RDMA/hw/i40iw/i40iw_ctrl: Fix a bunch of misspellings and formatting issues Lee Jones
2021-01-18 22:39 ` [PATCH 04/20] RDMA/hw/i40iw/i40iw_cm: Fix a bunch of function documentation issues Lee Jones
2021-01-18 22:39 ` Lee Jones [this message]
2021-01-18 22:39 ` [PATCH 06/20] RDMA/hw/i40iw/i40iw_hw: Provide description for 'ipv4', remove 'user_pri' and fix 'iwcq' Lee Jones
2021-01-18 22:39 ` [PATCH 07/20] RDMA/hw/i40iw/i40iw_main: Rectify some kernel-doc misdemeanours Lee Jones
2021-01-18 22:39 ` [PATCH 08/20] RDMA/core/roce_gid_mgmt: Fix misnaming of 'rdma_roce_rescan_device()'s param 'ib_dev' Lee Jones
2021-01-18 22:39 ` [PATCH 09/20] RDMA/hw/i40iw/i40iw_pble: Provide description for 'dev' and fix formatting issues Lee Jones
2021-01-18 22:39 ` [PATCH 10/20] RDMA/hw/i40iw/i40iw_puda: Fix some misspellings and provide missing descriptions Lee Jones
2021-01-18 22:39 ` [PATCH 11/20] RDMA/core/multicast: Provide description for 'ib_init_ah_from_mcmember()'s 'rec' param Lee Jones
2021-01-18 22:39 ` [PATCH 12/20] RDMA/core/sa_query: Demote non-conformant kernel-doc header Lee Jones
2021-01-18 22:39 ` [PATCH 13/20] RDMA/hw/i40iw/i40iw_uk: Clean-up some function documentation headers Lee Jones
2021-01-18 22:39 ` [PATCH 14/20] RDMA/hw/i40iw/i40iw_virtchnl: Fix a bunch of kernel-doc issues Lee Jones
2021-01-18 22:39 ` [PATCH 15/20] RDMA/hw/i40iw/i40iw_utils: Fix some misspellings and missing param descriptions Lee Jones
2021-01-18 22:39 ` [PATCH 16/20] RDMA/core/restrack: Fix kernel-doc formatting issue Lee Jones
2021-01-18 22:39 ` [PATCH 17/20] RDMA/hw/i40iw/i40iw_verbs: Fix worthy function headers and demote some others Lee Jones
2021-01-18 22:39 ` [PATCH 18/20] RDMA/core/counters: Demote non-conformant kernel-doc headers Lee Jones
2021-01-18 22:39 ` [PATCH 19/20] RDMA/core/iwpm_util: Fix some param description misspellings Lee Jones
2021-01-18 22:39 ` [PATCH 20/20] RDMA/core/iwpm_msg: Add proper descriptions for 'skb' param Lee Jones
2021-01-20 0:40 ` [PATCH 00/20] Rid W=1 warnings from Infinibad Jason Gunthorpe
2021-01-20 8:00 ` 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=20210118223929.512175-6-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=dledford@redhat.com \
--cc=jgg@ziepe.ca \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-rdma@vger.kernel.org \
/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).