From: Lee Jones <lee.jones@linaro.org>
To: arnd@arndb.de, gregkh@linuxfoundation.org
Cc: linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org, Lee Jones <lee.jones@linaro.org>
Subject: [PATCH 22/30] misc: mic: scif: scif_nm: Supply various kerneldoc fix-ups
Date: Tue, 30 Jun 2020 14:51:02 +0100 [thread overview]
Message-ID: <20200630135110.2236389-23-lee.jones@linaro.org> (raw)
In-Reply-To: <20200630135110.2236389-1-lee.jones@linaro.org>
Includes; missing descriptions for function args, the promotion
of obvious kerneldoc headers and the mis-formatting of existing
argument descriptions.
Fixes the following W=1 kernel build warnings:
drivers/misc/mic/scif/scif_nm.c:19: warning: Function parameter or member 'node' not described in 'scif_invalidate_ep'
drivers/misc/mic/scif/scif_nm.c:173: warning: Function parameter or member 'node_id' not described in 'scif_disconnect_node'
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/misc/mic/scif/scif_nm.c | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/drivers/misc/mic/scif/scif_nm.c b/drivers/misc/mic/scif/scif_nm.c
index c537df84539a9..c4d9422082b7d 100644
--- a/drivers/misc/mic/scif/scif_nm.c
+++ b/drivers/misc/mic/scif/scif_nm.c
@@ -14,6 +14,8 @@
/**
* scif_invalidate_ep() - Set state for all connected endpoints
* to disconnected and wake up all send/recv waitqueues
+ *
+ * @node: Node to invalidate
*/
static void scif_invalidate_ep(int node)
{
@@ -99,11 +101,10 @@ void scif_send_acks(struct scif_dev *dev)
}
}
-/*
- * scif_cleanup_scifdev
- *
+/**
+ * scif_cleanup_scifdev - Uninitialize SCIF data structures for remote
+ * SCIF device.
* @dev: Remote SCIF device.
- * Uninitialize SCIF data structures for remote SCIF device.
*/
void scif_cleanup_scifdev(struct scif_dev *dev)
{
@@ -136,8 +137,8 @@ void scif_cleanup_scifdev(struct scif_dev *dev)
scif_cleanup_qp(dev);
}
-/*
- * scif_remove_node:
+/**
+ * scif_remove_node
*
* @node: Node to remove
*/
@@ -162,9 +163,9 @@ static int scif_send_rmnode_msg(int node, int remove_node)
}
/**
- * scif_node_disconnect:
+ * scif_node_disconnect
*
- * @node_id[in]: source node id.
+ * @node_id: source node id [in]
* @mgmt_initiated: Disconnection initiated from the mgmt node
*
* Disconnect a node from the scif network.
--
2.25.1
next prev parent reply other threads:[~2020-06-30 13:52 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 ` Lee Jones [this message]
2020-06-30 13:51 ` [PATCH 23/30] misc: mic: scif: scif_dma: Fix a couple " 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 ` [PATCH 28/30] misc: ocxl: config: Provide correct formatting to function headers Lee Jones
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-23-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=arnd@arndb.de \
--cc=gregkh@linuxfoundation.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@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
all inboxes | Powered by JetHome®