netdev - [PATCH 15/35] tipc: Reorganize kerneldoc parameter names

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20240930112121.95324-16-Julia.Lawall@inria.fr>
Date: Mon, 30 Sep 2024 13:21:01 +0200
From: Julia Lawall <Julia.Lawall@...ia.fr>
To: Jon Maloy <jmaloy@...hat.com>
Cc: kernel-janitors@...r.kernel.org,
	Ying Xue <ying.xue@...driver.com>,
	"David S. Miller" <davem@...emloft.net>,
	Eric Dumazet <edumazet@...gle.com>,
	Jakub Kicinski <kuba@...nel.org>,
	Paolo Abeni <pabeni@...hat.com>,
	netdev@...r.kernel.org,
	tipc-discussion@...ts.sourceforge.net,
	linux-kernel@...r.kernel.org
Subject: [PATCH 15/35] tipc: Reorganize kerneldoc parameter names

Reorganize kerneldoc parameter names to match the parameter
order in the function header.

Problems identified using Coccinelle.

Signed-off-by: Julia Lawall <Julia.Lawall@...ia.fr>

---
 net/tipc/link.c |   14 +++++++-------
 net/tipc/msg.c  |    2 +-
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/net/tipc/link.c b/net/tipc/link.c
index 5c2088a469ce..55c2ad1d88a2 100644
--- a/net/tipc/link.c
+++ b/net/tipc/link.c
@@ -461,15 +461,15 @@ u32 tipc_link_state(struct tipc_link *l)
  * @min_win: minimal send window to be used by link
  * @max_win: maximal send window to be used by link
  * @session: session to be used by link
+ * @self: local unicast link id
  * @peer: node id of peer node
+ * @peer_id: 128-bit ID of peer
  * @peer_caps: bitmap describing peer node capabilities
  * @bc_sndlink: the namespace global link used for broadcast sending
  * @bc_rcvlink: the peer specific link used for broadcast reception
  * @inputq: queue to put messages ready for delivery
  * @namedq: queue to put binding table update messages ready for delivery
  * @link: return value, pointer to put the created link
- * @self: local unicast link id
- * @peer_id: 128-bit ID of peer
  *
  * Return: true if link was created, otherwise false
  */
@@ -538,17 +538,17 @@ bool tipc_link_create(struct net *net, char *if_name, int bearer_id,
 /**
  * tipc_link_bc_create - create new link to be used for broadcast
  * @net: pointer to associated network namespace
+ * @ownnode: identity of own node
+ * @peer: node id of peer node
+ * @peer_id: 128-bit ID of peer
  * @mtu: mtu to be used initially if no peers
  * @min_win: minimal send window to be used by link
  * @max_win: maximal send window to be used by link
+ * @peer_caps: bitmap describing peer node capabilities
  * @inputq: queue to put messages ready for delivery
  * @namedq: queue to put binding table update messages ready for delivery
- * @link: return value, pointer to put the created link
- * @ownnode: identity of own node
- * @peer: node id of peer node
- * @peer_id: 128-bit ID of peer
- * @peer_caps: bitmap describing peer node capabilities
  * @bc_sndlink: the namespace global link used for broadcast sending
+ * @link: return value, pointer to put the created link
  *
  * Return: true if link was created, otherwise false
  */
diff --git a/net/tipc/msg.c b/net/tipc/msg.c
index 76284fc538eb..dc3000c28d43 100644
--- a/net/tipc/msg.c
+++ b/net/tipc/msg.c
@@ -196,8 +196,8 @@ int tipc_buf_append(struct sk_buff **headbuf, struct sk_buff **buf)
  * tipc_msg_append(): Append data to tail of an existing buffer queue
  * @_hdr: header to be used
  * @m: the data to be appended
- * @mss: max allowable size of buffer
  * @dlen: size of data to be appended
+ * @mss: max allowable size of buffer
  * @txq: queue to append to
  *
  * Return: the number of 1k blocks appended or errno value