diff mbox series

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

Message ID 20200407225526.16085-1-l.rubusch@gmail.com
State Accepted
Delegated to: David Miller
Headers show
Series [v2] net: sock.h: fix skb_steal_sock() kernel-doc | expand

Commit Message

Lothar Rubusch April 7, 2020, 10:55 p.m. UTC
Fix warnings related to kernel-doc notation, and wording in
function description.

Signed-off-by: Lothar Rubusch <l.rubusch@gmail.com>
---
 include/net/sock.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Randy Dunlap April 7, 2020, 11:03 p.m. UTC | #1
On 4/7/20 3:55 PM, Lothar Rubusch wrote:
> Fix warnings related to kernel-doc notation, and wording in
> function description.
> 
> Signed-off-by: Lothar Rubusch <l.rubusch@gmail.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  include/net/sock.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/include/net/sock.h b/include/net/sock.h
> index 6d84784d33fa..3e8c6d4b4b59 100644
> --- a/include/net/sock.h
> +++ b/include/net/sock.h
> @@ -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)
>
David Miller April 8, 2020, 1:09 a.m. UTC | #2
From: Lothar Rubusch <l.rubusch@gmail.com>
Date: Tue,  7 Apr 2020 22:55:25 +0000

> Fix warnings related to kernel-doc notation, and wording in
> function description.
> 
> Signed-off-by: Lothar Rubusch <l.rubusch@gmail.com>

Applied, thanks.
diff mbox series

Patch

diff --git a/include/net/sock.h b/include/net/sock.h
index 6d84784d33fa..3e8c6d4b4b59 100644
--- a/include/net/sock.h
+++ b/include/net/sock.h
@@ -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)