[PATCH] tipc: Remove some excess struct member documentation

[PATCH] tipc: Remove some excess struct member documentation

[Jonathan Corbet]

Remove documentation for nonexistent struct members, addressing these
warnings:

  ./net/tipc/link.c:228: warning: Excess struct member 'media_addr' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'timer' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'refcnt' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'proto_msg' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'pmsg' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'backlog_limit' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'exp_msg_count' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'reset_rcv_checkpt' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'transmitq' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'snt_nxt' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'deferred_queue' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'unacked_window' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'next_out' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'long_msg_seq_no' description in 'tipc_link'
  ./net/tipc/link.c:228: warning: Excess struct member 'bc_rcvr' description in 'tipc_link'

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 net/tipc/link.c | 15 ---------------
 1 file changed, 15 deletions(-)

diff --git a/net/tipc/link.c b/net/tipc/link.c
index d0143823658d..0716eb5c8a31 100644
--- a/net/tipc/link.c
+++ b/net/tipc/link.c
@@ -82,10 +82,7 @@ struct tipc_stats {
  * struct tipc_link - TIPC link data structure
  * @addr: network address of link's peer node
  * @name: link name character string
- * @media_addr: media address to use when sending messages over link
- * @timer: link timer
  * @net: pointer to namespace struct
- * @refcnt: reference counter for permanent references (owner node & timer)
  * @peer_session: link session # being used by peer end of link
  * @peer_bearer_id: bearer id used by link's peer endpoint
  * @bearer_id: local bearer id used by link
@@ -94,31 +91,19 @@ struct tipc_stats {
  * @state: current state of link FSM
  * @peer_caps: bitmap describing capabilities of peer node
  * @silent_intv_cnt: # of timer intervals without any reception from peer
- * @proto_msg: template for control messages generated by link
- * @pmsg: convenience pointer to "proto_msg" field
  * @priority: current link priority
  * @net_plane: current link network plane ('A' through 'H')
  * @mon_state: cookie with information needed by link monitor
- * @backlog_limit: backlog queue congestion thresholds (indexed by importance)
- * @exp_msg_count: # of tunnelled messages expected during link changeover
- * @reset_rcv_checkpt: seq # of last acknowledged message at time of link reset
  * @mtu: current maximum packet size for this link
  * @advertised_mtu: advertised own mtu when link is being established
- * @transmitq: queue for sent, non-acked messages
  * @backlogq: queue for messages waiting to be sent
- * @snt_nxt: next sequence number to use for outbound messages
  * @ackers: # of peers that needs to ack each packet before it can be released
  * @acked: # last packet acked by a certain peer. Used for broadcast.
  * @rcv_nxt: next sequence number to expect for inbound messages
- * @deferred_queue: deferred queue saved OOS b'cast message received from node
- * @unacked_window: # of inbound messages rx'd without ack'ing back to peer
  * @inputq: buffer queue for messages to be delivered upwards
  * @namedq: buffer queue for name table messages to be delivered upwards
- * @next_out: ptr to first unsent outbound message in queue
  * @wakeupq: linked list of wakeup msgs waiting for link congestion to abate
- * @long_msg_seq_no: next identifier to use for outbound fragmented messages
  * @reasm_buf: head of partially reassembled inbound message fragments
- * @bc_rcvr: marks that this is a broadcast receiver link
  * @stats: collects statistics regarding link activity
  * @session: session to be used by link
  * @snd_nxt_state: next send seq number
-- 
2.43.0

Re: [PATCH] tipc: Remove some excess struct member documentation

[Randy Dunlap]

On 12/18/23 16:28, Jonathan Corbet wrote:
> Remove documentation for nonexistent struct members, addressing these
> warnings:
> 
>   ./net/tipc/link.c:228: warning: Excess struct member 'media_addr' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'timer' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'refcnt' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'proto_msg' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'pmsg' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'backlog_limit' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'exp_msg_count' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'reset_rcv_checkpt' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'transmitq' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'snt_nxt' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'deferred_queue' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'unacked_window' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'next_out' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'long_msg_seq_no' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'bc_rcvr' description in 'tipc_link'
> 
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>


Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  net/tipc/link.c | 15 ---------------
>  1 file changed, 15 deletions(-)
> 
> diff --git a/net/tipc/link.c b/net/tipc/link.c
> index d0143823658d..0716eb5c8a31 100644
> --- a/net/tipc/link.c
> +++ b/net/tipc/link.c
> @@ -82,10 +82,7 @@ struct tipc_stats {
>   * struct tipc_link - TIPC link data structure
>   * @addr: network address of link's peer node
>   * @name: link name character string
> - * @media_addr: media address to use when sending messages over link
> - * @timer: link timer
>   * @net: pointer to namespace struct
> - * @refcnt: reference counter for permanent references (owner node & timer)
>   * @peer_session: link session # being used by peer end of link
>   * @peer_bearer_id: bearer id used by link's peer endpoint
>   * @bearer_id: local bearer id used by link
> @@ -94,31 +91,19 @@ struct tipc_stats {
>   * @state: current state of link FSM
>   * @peer_caps: bitmap describing capabilities of peer node
>   * @silent_intv_cnt: # of timer intervals without any reception from peer
> - * @proto_msg: template for control messages generated by link
> - * @pmsg: convenience pointer to "proto_msg" field
>   * @priority: current link priority
>   * @net_plane: current link network plane ('A' through 'H')
>   * @mon_state: cookie with information needed by link monitor
> - * @backlog_limit: backlog queue congestion thresholds (indexed by importance)
> - * @exp_msg_count: # of tunnelled messages expected during link changeover
> - * @reset_rcv_checkpt: seq # of last acknowledged message at time of link reset
>   * @mtu: current maximum packet size for this link
>   * @advertised_mtu: advertised own mtu when link is being established
> - * @transmitq: queue for sent, non-acked messages
>   * @backlogq: queue for messages waiting to be sent
> - * @snt_nxt: next sequence number to use for outbound messages
>   * @ackers: # of peers that needs to ack each packet before it can be released
>   * @acked: # last packet acked by a certain peer. Used for broadcast.
>   * @rcv_nxt: next sequence number to expect for inbound messages
> - * @deferred_queue: deferred queue saved OOS b'cast message received from node
> - * @unacked_window: # of inbound messages rx'd without ack'ing back to peer
>   * @inputq: buffer queue for messages to be delivered upwards
>   * @namedq: buffer queue for name table messages to be delivered upwards
> - * @next_out: ptr to first unsent outbound message in queue
>   * @wakeupq: linked list of wakeup msgs waiting for link congestion to abate
> - * @long_msg_seq_no: next identifier to use for outbound fragmented messages
>   * @reasm_buf: head of partially reassembled inbound message fragments
> - * @bc_rcvr: marks that this is a broadcast receiver link
>   * @stats: collects statistics regarding link activity
>   * @session: session to be used by link
>   * @snd_nxt_state: next send seq number

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html

Re: [PATCH] tipc: Remove some excess struct member documentation

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by David S. Miller <davem@davemloft.net>:

On Mon, 18 Dec 2023 17:28:13 -0700 you wrote:
> Remove documentation for nonexistent struct members, addressing these
> warnings:
> 
>   ./net/tipc/link.c:228: warning: Excess struct member 'media_addr' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'timer' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'refcnt' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'proto_msg' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'pmsg' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'backlog_limit' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'exp_msg_count' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'reset_rcv_checkpt' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'transmitq' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'snt_nxt' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'deferred_queue' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'unacked_window' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'next_out' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'long_msg_seq_no' description in 'tipc_link'
>   ./net/tipc/link.c:228: warning: Excess struct member 'bc_rcvr' description in 'tipc_link'
> 
> [...]

Here is the summary with links:
  - tipc: Remove some excess struct member documentation
    https://git.kernel.org/netdev/net-next/c/45248f290229

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html