From: Lee Jones <lee.jones@linaro.org>
To: arnd@arndb.de, gregkh@linuxfoundation.org
Cc: linux-kernel@vger.kernel.org, Lee Jones <lee.jones@linaro.org>,
Steven Royer <seroyer@linux.ibm.com>,
Adam Reznechek <adreznec@linux.vnet.ibm.com>,
"Bryant G. Ly" <bryantly@linux.vnet.ibm.com>,
Dave Engebretsen <engebret@us.ibm.com>
Subject: [PATCH v2 29/30] misc: ibmvmc: Repair ill-named function argument descriptions
Date: Wed, 1 Jul 2020 09:31:17 +0100 [thread overview]
Message-ID: <20200701083118.45744-30-lee.jones@linaro.org> (raw)
In-Reply-To: <20200701083118.45744-1-lee.jones@linaro.org>
Formatting is correct and descriptions are all present, but some
of the argument names are not properly represented in the
documentation.
Fixes the following W=1 build warnings:
drivers/misc/ibmvmc.c:780: warning: Function parameter or member 'msg_len' not described in 'ibmvmc_send_msg'
drivers/misc/ibmvmc.c:780: warning: Excess function parameter 'msg_length' description in 'ibmvmc_send_msg'
drivers/misc/ibmvmc.c:1041: warning: Function parameter or member 'buffer' not described in 'ibmvmc_write'
drivers/misc/ibmvmc.c:1041: warning: Excess function parameter 'buf' description in 'ibmvmc_write'
drivers/misc/ibmvmc.c:1360: warning: Function parameter or member 'file' not described in 'ibmvmc_ioctl'
drivers/misc/ibmvmc.c:1360: warning: Excess function parameter 'session' description in 'ibmvmc_ioctl'
Cc: Steven Royer <seroyer@linux.ibm.com>
Cc: Adam Reznechek <adreznec@linux.vnet.ibm.com>
Cc: "Bryant G. Ly" <bryantly@linux.vnet.ibm.com>
Cc: Dave Engebretsen <engebret@us.ibm.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/misc/ibmvmc.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/drivers/misc/ibmvmc.c b/drivers/misc/ibmvmc.c
index 2ed23c99f59fd..c0d139c265055 100644
--- a/drivers/misc/ibmvmc.c
+++ b/drivers/misc/ibmvmc.c
@@ -760,7 +760,7 @@ static int ibmvmc_send_rem_buffer_resp(struct crq_server_adapter *adapter,
* @adapter: crq_server_adapter struct
* @buffer: ibmvmc_buffer struct
* @hmc: ibmvmc_hmc struct
- * @msg_length: message length field
+ * @msg_len: message length field
*
* This command is sent between the management partition and the hypervisor
* in order to signal the arrival of an HMC protocol message. The command
@@ -1028,7 +1028,7 @@ static unsigned int ibmvmc_poll(struct file *file, poll_table *wait)
* ibmvmc_write - Write
*
* @file: file struct
- * @buf: Character buffer
+ * @buffer: Character buffer
* @count: Count field
* @ppos: Offset
*
@@ -1347,7 +1347,7 @@ static long ibmvmc_ioctl_requestvmc(struct ibmvmc_file_session *session,
/**
* ibmvmc_ioctl - IOCTL
*
- * @session: ibmvmc_file_session struct
+ * @file: file information
* @cmd: cmd field
* @arg: Argument field
*
--
2.25.1
next prev parent reply other threads:[~2020-07-01 8:32 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-01 8:30 [PATCH v2 00/30] Last batch of patches to clean up Misc Lee Jones
2020-07-01 8:30 ` [PATCH v2 01/30] misc: genwqe: card_ddcb: Fix a variety of kerneldoc issues Lee Jones
2020-07-01 8:30 ` [PATCH v2 02/30] misc: genwqe: card_sysfs: Demote function/file headers from kerneldoc Lee Jones
2020-07-01 8:30 ` [PATCH v2 03/30] misc: genwqe: card_debugfs: Demote file header " Lee Jones
2020-07-01 8:30 ` [PATCH v2 04/30] misc: sgi-xp: xp_main: Staticify local functions xp_init() and xp_exit() Lee Jones
2020-07-01 8:30 ` [PATCH v2 05/30] misc: ibmasm: event: Demote function headers from kerneldoc Lee Jones
2020-07-01 8:30 ` [PATCH v2 06/30] misc: ibmasm: command: " Lee Jones
2020-07-01 8:30 ` [PATCH v2 07/30] misc: vmw_vmci_defs: Mark 'struct vmci_handle VMCI_ANON_SRC_HANDLE' as __maybe_unused Lee Jones
2020-07-01 10:33 ` Lee Jones
2020-07-01 8:30 ` [PATCH v2 08/30] misc: ibmasm: r_heartbeat: Demote function headers from kerneldoc Lee Jones
2020-07-01 8:30 ` [PATCH v2 09/30] misc: mic: host: mic_x100: Move declaration of mic_x100_intr_init[] into c-file Lee Jones
2020-07-01 8:30 ` [PATCH v2 10/30] misc: ibmasm: dot_command: Demote function headers from kerneldoc Lee Jones
2020-07-01 8:30 ` [PATCH v2 11/30] misc: mic: host: mic_intr: Properly document function arguments Lee Jones
2020-07-01 8:31 ` [PATCH v2 12/30] misc: mic: host: mic_x100: Add missing descriptions to kerneldoc headers Lee Jones
2020-07-01 8:31 ` [PATCH v2 13/30] misc: mic: card: mic_debugfs: Demote function headers from kerneldoc Lee Jones
2020-07-01 8:31 ` [PATCH v2 14/30] misc: mic: host: " Lee Jones
2020-07-01 8:31 ` [PATCH v2 15/30] misc: mic: cosm: cosm_main: Document 'force' function argument Lee Jones
2020-07-01 8:31 ` [PATCH v2 16/30] misc: mic: scif: scif_ports: Fix copy 'n' paste error Lee Jones
2020-07-01 8:31 ` [PATCH v2 17/30] misc: mic: cosm: cosm_debugfs: Demote function headers from kerneldoc Lee Jones
2020-07-01 8:31 ` [PATCH v2 18/30] misc: mic: scif: scif_api: Remove set but unused variable 'read_size' Lee Jones
2020-07-01 8:31 ` [PATCH v2 19/30] misc: mic: scif: scif_api: Demote scif_accept() function header Lee Jones
2020-07-01 8:31 ` [PATCH v2 20/30] misc: mic: scif: scif_epd: Describe missing 'scifdev' argument(s) Lee Jones
2020-07-01 8:31 ` [PATCH v2 21/30] misc: mic: scif: scif_nodeqp: Fix a bunch of kerneldoc issues Lee Jones
2020-07-01 8:31 ` [PATCH v2 22/30] misc: mic: scif: scif_nm: Supply various kerneldoc fix-ups Lee Jones
2020-07-01 8:31 ` [PATCH v2 23/30] misc: mic: scif: scif_dma: Fix a couple of kerneldoc issues Lee Jones
2020-07-01 8:31 ` [PATCH v2 24/30] misc: mic: scif: scif_fence: Fix a bunch of different documentation issues Lee Jones
2020-07-01 8:31 ` [PATCH v2 25/30] misc: mic: scif: scif_rma: Repair a bunch of kerneldoc issues Lee Jones
2020-07-01 8:31 ` [PATCH v2 26/30] misc: eeprom: at24: Tell the compiler that ACPI functions may not be used Lee Jones
2020-07-01 8:48 ` Wolfram Sang
2020-07-01 9:36 ` Lee Jones
2020-07-06 17:16 ` Bartosz Golaszewski
2020-07-01 8:31 ` [PATCH v2 27/30] misc: cxl: hcalls: Demote half-assed kerneldoc attempt Lee Jones
2020-07-01 8:31 ` [PATCH v2 28/30] misc: ocxl: config: Provide correct formatting to function headers Lee Jones
2020-07-01 8:31 ` Lee Jones [this message]
2020-07-01 8:31 ` [PATCH v2 30/30] misc: cxl: flash: Remove unused pointer Lee Jones
2020-07-01 13:13 ` Greg KH
2020-07-01 13:31 ` 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=20200701083118.45744-30-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=adreznec@linux.vnet.ibm.com \
--cc=arnd@arndb.de \
--cc=bryantly@linux.vnet.ibm.com \
--cc=engebret@us.ibm.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=seroyer@linux.ibm.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
all inboxes | Powered by JetHome®