Skip to contentSkip to conversation

net: sock.h: fix skb_steal_sock() kernel-doc

PATCH Applied Lothar Rubusch 3 participants 3 messages Apr 7, 2020 – Apr 8, 2020

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 net: sock.h: fix skb_steal_sock() kernel-doc

Fix warnings related to kernel-doc notation, and wording in function description.

---
 include/net/sock.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
include/net/sock.h +3 -3
index 6d84784d33fa..3e8c6d4b4b59 100644
@@ -2553,9 +2553,9 @@ sk_is_refcounted(struct sock *sk)
 }
 
 /**
- * skb_steal_sock
- * @skb to steal the socket from
- * @refcounted is set to true if the socket is reference-counted
+ * skb_steal_sock - steal a socket from an sk_buff
+ * @skb: sk_buff to steal the socket from
+ * @refcounted: is set to true if the socket is reference-counted
  */
 static inline struct sock *
 skb_steal_sock(struct sk_buff *skb, bool *refcounted)
Signature · 1 line
2.20.1
Acked-by Tested-by on v2 1/1
#1 lore raw
Quoted 4 lines · Lothar Rubusch

Fix warnings related to kernel-doc notation, and wording in function description.

Thanks.

Quoted 22 lines
---
 include/net/sock.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
include/net/sock.h +3 -3
index 6d84784d33fa..3e8c6d4b4b59 100644
@@ -2553,9 +2553,9 @@ sk_is_refcounted(struct sock *sk)
 }
 
 /**
- * skb_steal_sock
- * @skb to steal the socket from
- * @refcounted is set to true if the socket is reference-counted
+ * skb_steal_sock - steal a socket from an sk_buff
+ * @skb: sk_buff to steal the socket from
+ * @refcounted: is set to true if the socket is reference-counted
  */
 static inline struct sock *
 skb_steal_sock(struct sk_buff *skb, bool *refcounted)
Signature · 1 line
~Randy