2024-01-27 03:21:48

by Carlos Ortiz

[permalink] [raw]
Subject: [PATCH] net/tipc: Remove Documentation Warnings for `Excess struct member`

As far as I can tell,the struct `inputq` and `namedq` were never part of the `tipc_node`,
therefor removing the documentation comments this will make the warnings for ./net/tipc/node.c when
running `make htmldocs` to be gone.

For socket.c, and documentation comment was added on commit 365ad353c2564bba8835290061308ba825166b3a
but the struct member was not added in addition of removing `blocking_link` also move `dupl_rcvcnt`
documentations a few lines up to match the struct member order.

Signed-off-by: Carlos Ortiz <[email protected]>
---
net/tipc/node.c | 2 --
net/tipc/socket.c | 3 +--
2 files changed, 1 insertion(+), 4 deletions(-)

diff --git a/net/tipc/node.c b/net/tipc/node.c
index 3105abe97bb9..c1e890a82434 100644
--- a/net/tipc/node.c
+++ b/net/tipc/node.c
@@ -86,8 +86,6 @@ struct tipc_bclink_entry {
* @lock: rwlock governing access to structure
* @net: the applicable net namespace
* @hash: links to adjacent nodes in unsorted hash chain
- *
@inputq: pointer to input queue containing messages for msg event
- * @namedq: pointer to name table input queue with name table messages
* @active_links: bearer ids of active links, used as index into links[] array
* @links: array containing references to all links to node
* @bc_entry: broadcast link entry
diff --git a/net/tipc/socket.c b/net/tipc/socket.c
index bb1118d02f95..a022719882ce 100644
--- a/net/tipc/socket.c
+++ b/net/tipc/socket.c
@@ -80,11 +80,10 @@ struct sockaddr_pair {
* @phdr: preformatted message header used when sending messages
* @cong_links: list of congested links
* @publications: list of publications for port
- * @blocking_link: address of the congested link we are currently sleeping on
* @pub_count: total # of publications port has made during its lifetime
+ * @dupl_rcvcnt: number of bytes counted twice, in both backlog and rcv queue
* @conn_timeout: the time we can wait for an unresponded setup request
* @probe_unacked: prob
e has not received ack yet
- * @dupl_rcvcnt: number of bytes counted twice, in both backlog and rcv queue
* @cong_link_cnt: number of congested links
* @snt_unacked: # messages sent by socket, and not yet acked by peer
* @snd_win: send window size
--
2.43.0


Attachments:
signature.asc (258.00 B)
OpenPGP digital signature

2024-01-27 05:00:09

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] net/tipc: Remove Documentation Warnings for `Excess struct member`



On 1/26/24 19:21, Carlos Ortiz wrote:
> As far as I can tell,the struct `inputq` and `namedq` were never part of the `tipc_node`,
> therefor removing the documentation comments this will make the warnings for ./net/tipc/node.c when
> running `make htmldocs` to be gone.
>
> For socket.c, and documentation comment was added on commit 365ad353c2564bba8835290061308ba825166b3a
> but the struct member was not added in addition of removing `blocking_link` also move `dupl_rcvcnt`
> documentations a few lines up to match the struct member order.
>
> Signed-off-by: Carlos Ortiz <[email protected]>
> ---
> net/tipc/node.c | 2 --
> net/tipc/socket.c | 3 +--
> 2 files changed, 1 insertion(+), 4 deletions(-)
>

Hi,
These are already fixed (recently), but Thanks.

https://lore.kernel.org/netdev/170614862613.13756.7070098094645334807.git-patchwork-notify@kernel.org/
https://lore.kernel.org/netdev/170614862616.13756.18046951576152774345.git-patchwork-notify@kernel.org/
--
#Randy