Skip to contentSkip to conversation

doc: update docbook annotations for socket and skb

PATCH Applied Stephen Hemminger 2 participants 2 messages Oct 23, 2016 – Oct 26, 2016

Subsystems (3)
Networking Network drivers Sockets
lore
Share & tools
lore

Stephen Hemminger

author
#0 lore raw

PATCH 1/1 doc: update docbook annotations for socket and skb

From: Stephen Hemminger <[email protected]>

The skbuff and sock structure both had missing parameter annotation values.

Signed-off-by Stephen Hemminger <[email protected]>
---
 include/linux/skbuff.h | 1 +
 include/net/sock.h     | 4 +++-
 2 files changed, 4 insertions(+), 1 deletion(-)
include/linux/skbuff.h +1 -0
index 601258f..32810f2 100644
@@ -936,6 +936,7 @@ struct sk_buff_fclones {
 
 /**
  *	skb_fclone_busy - check if fclone is busy
+ *	@sk: socket
  *	@skb: buffer
  *
  * Returns true if skb is a fast clone, and its clone is not freed.
include/net/sock.h +3 -1
index ebf75db..73c6b00 100644
@@ -252,6 +252,7 @@ struct sock_common {
   *	@sk_pacing_rate: Pacing rate (if supported by transport/packet scheduler)
   *	@sk_max_pacing_rate: Maximum pacing rate (%SO_MAX_PACING_RATE)
   *	@sk_sndbuf: size of send buffer in bytes
+  *	@sk_padding: unused element for alignment
   *	@sk_no_check_tx: %SO_NO_CHECK setting, set checksum in TX packets
   *	@sk_no_check_rx: allow zero checksum in RX packets
   *	@sk_route_caps: route capabilities (e.g. %NETIF_F_TSO)

@@ -302,7 +303,8 @@ struct sock_common {
   *	@sk_backlog_rcv: callback to process the backlog
   *	@sk_destruct: called at sock freeing time, i.e. when all refcnt == 0
   *	@sk_reuseport_cb: reuseport group container
- */
+  *	@sk_rcu: used during RCU grace period
+  */
 struct sock {
 	/*
 	 * Now struct inet_timewait_sock also uses sock_common, so please just
Signature · 1 line
2.9.3