From: Lee Jones <lee.jones@linaro.org>
To: arnd@arndb.de, gregkh@linuxfoundation.org
Cc: Andrew Donnellan <ajd@linux.ibm.com>,
Lee Jones <lee.jones@linaro.org>,
linux-kernel@vger.kernel.org,
Frederic Barrat <fbarrat@linux.ibm.com>,
linuxppc-dev@lists.ozlabs.org,
linux-arm-kernel@lists.infradead.org
Subject: [PATCH 28/30] misc: ocxl: config: Provide correct formatting to function headers
Date: Tue, 30 Jun 2020 14:51:08 +0100 [thread overview]
Message-ID: <20200630135110.2236389-29-lee.jones@linaro.org> (raw)
In-Reply-To: <20200630135110.2236389-1-lee.jones@linaro.org>
A nice attempt was made to provide kerneldoc headers for
read_template_version() and read_afu_lpc_memory_info() however,
the provided formatting does not match what is expected by
kerneldoc.
Fixes the following W=1 warnings:
drivers/misc/ocxl/config.c:286: warning: Function parameter or member 'dev' not described in 'read_template_version'
drivers/misc/ocxl/config.c:286: warning: Function parameter or member 'fn' not described in 'read_template_version'
drivers/misc/ocxl/config.c:286: warning: Function parameter or member 'len' not described in 'read_template_version'
drivers/misc/ocxl/config.c:286: warning: Function parameter or member 'version' not described in 'read_template_version'
drivers/misc/ocxl/config.c:489: warning: Function parameter or member 'dev' not described in 'read_afu_lpc_memory_info'
drivers/misc/ocxl/config.c:489: warning: Function parameter or member 'fn' not described in 'read_afu_lpc_memory_info'
drivers/misc/ocxl/config.c:489: warning: Function parameter or member 'afu' not described in 'read_afu_lpc_memory_info'
Cc: Frederic Barrat <fbarrat@linux.ibm.com>
Cc: Andrew Donnellan <ajd@linux.ibm.com>
Cc: linuxppc-dev@lists.ozlabs.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/misc/ocxl/config.c | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/drivers/misc/ocxl/config.c b/drivers/misc/ocxl/config.c
index c8e19bfb5ef90..e3b99a39d207e 100644
--- a/drivers/misc/ocxl/config.c
+++ b/drivers/misc/ocxl/config.c
@@ -273,11 +273,11 @@ static int read_afu_info(struct pci_dev *dev, struct ocxl_fn_config *fn,
}
/**
- * Read the template version from the AFU
- * dev: the device for the AFU
- * fn: the AFU offsets
- * len: outputs the template length
- * version: outputs the major<<8,minor version
+ * read_template_version - Read the template version from the AFU
+ * @dev: the device for the AFU
+ * @fn: the AFU offsets
+ * @len: outputs the template length
+ * @version: outputs the major<<8,minor version
*
* Returns 0 on success, negative on failure
*/
@@ -476,10 +476,10 @@ static int validate_afu(struct pci_dev *dev, struct ocxl_afu_config *afu)
}
/**
- * Populate AFU metadata regarding LPC memory
- * dev: the device for the AFU
- * fn: the AFU offsets
- * afu: the AFU struct to populate the LPC metadata into
+ * read_afu_lpc_memory_info - Populate AFU metadata regarding LPC memory
+ * @dev: the device for the AFU
+ * @fn: the AFU offsets
+ * @afu: the AFU struct to populate the LPC metadata into
*
* Returns 0 on success, negative on failure
*/
--
2.25.1
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
next prev parent reply other threads:[~2020-06-30 14:01 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-30 13:50 [PATCH 00/30] Last batch of patches to clean up Misc Lee Jones
2020-06-30 13:50 ` [PATCH 01/30] misc: genwqe: card_ddcb: Fix a variety of kerneldoc issues Lee Jones
2020-06-30 13:50 ` [PATCH 02/30] misc: genwqe: card_sysfs: Demote function/file headers from kerneldoc Lee Jones
2020-06-30 13:50 ` [PATCH 03/30] misc: genwqe: card_debugfs: Demote file header " Lee Jones
2020-06-30 13:50 ` [PATCH 04/30] misc: sgi-xp: xp_main: Staticify local functions xp_init() and xp_exit() Lee Jones
2020-07-01 17:09 ` Robin Holt
2020-06-30 13:50 ` [PATCH 05/30] misc: ibmasm: event: Demote function headers from kerneldoc Lee Jones
2020-06-30 13:50 ` [PATCH 06/30] misc: ibmasm: command: " Lee Jones
2020-06-30 13:50 ` [PATCH 07/30] misc: vmw_vmci_defs: 'struct vmci_handle VMCI_ANON_SRC_HANDLE' cannot be static Lee Jones
2020-06-30 22:58 ` kernel test robot
2020-06-30 13:50 ` [PATCH 08/30] misc: ibmasm: r_heartbeat: Demote function headers from kerneldoc Lee Jones
2020-06-30 13:50 ` [PATCH 09/30] misc: mic: host: mic_x100: Move declaration of mic_x100_intr_init[] into c-file Lee Jones
2020-06-30 13:50 ` [PATCH 10/30] misc: ibmasm: dot_command: Demote function headers from kerneldoc Lee Jones
2020-06-30 13:50 ` [PATCH 11/30] misc: mic: host: mic_intr: Properly document function arguments Lee Jones
2020-06-30 13:50 ` [PATCH 12/30] misc: mic: host: mic_x100: Add missing descriptions to kerneldoc headers Lee Jones
2020-06-30 13:50 ` [PATCH 13/30] misc: mic: card: mic_debugfs: Demote function headers from kerneldoc Lee Jones
2020-06-30 13:50 ` [PATCH 14/30] misc: mic: host: " Lee Jones
2020-06-30 13:50 ` [PATCH 15/30] misc: mic: cosm: cosm_main: Document 'force' function argument Lee Jones
2020-06-30 13:50 ` [PATCH 16/30] misc: mic: scif: scif_ports: Fix copy 'n' paste error Lee Jones
2020-06-30 13:50 ` [PATCH 17/30] misc: mic: cosm: cosm_debugfs: Demote function headers from kerneldoc Lee Jones
2020-06-30 13:50 ` [PATCH 18/30] misc: mic: scif: scif_api: Remove set but unused variable 'read_size' Lee Jones
2020-06-30 13:50 ` [PATCH 19/30] misc: mic: scif: scif_api: Demote scif_accept() function header Lee Jones
2020-06-30 13:51 ` [PATCH 20/30] misc: mic: scif: scif_epd: Describe missing 'scifdev' argument(s) Lee Jones
2020-06-30 13:51 ` [PATCH 21/30] misc: mic: scif: scif_nodeqp: Fix a bunch of kerneldoc issues Lee Jones
2020-06-30 13:51 ` [PATCH 22/30] misc: mic: scif: scif_nm: Supply various kerneldoc fix-ups Lee Jones
2020-06-30 13:51 ` [PATCH 23/30] misc: mic: scif: scif_dma: Fix a couple of kerneldoc issues Lee Jones
2020-06-30 13:51 ` [PATCH 24/30] misc: mic: scif: scif_fence: Fix a bunch of different documentation issues Lee Jones
2020-06-30 13:51 ` [PATCH 25/30] misc: mic: scif: scif_rma: Repair a bunch of kerneldoc issues Lee Jones
2020-06-30 13:51 ` [PATCH 26/30] misc: eeprom: at24: Tell the compiler that ACPI functions may not be used Lee Jones
2020-06-30 13:51 ` [PATCH 27/30] misc: cxl: hcalls: Demote half-assed kerneldoc attempt Lee Jones
2020-06-30 13:51 ` Lee Jones [this message]
2020-06-30 13:51 ` [PATCH 29/30] misc: ibmvmc: Repair ill-named function argument descriptions Lee Jones
2020-06-30 13:51 ` [PATCH 30/30] misc: cxl: flash: Remove unused pointer 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=20200630135110.2236389-29-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=ajd@linux.ibm.com \
--cc=arnd@arndb.de \
--cc=fbarrat@linux.ibm.com \
--cc=gregkh@linuxfoundation.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.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).