netdev - Re: [PATCH] Documentation: sock.h

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Tue, 7 Apr 2020 15:32:32 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Lothar Rubusch <l.rubusch@...il.com>, kuba@...nel.org,
        davem@...emloft.net
Cc:     netdev@...r.kernel.org
Subject: Re: [PATCH] Documentation: sock.h - fix warnings

On 4/6/20 2:52 PM, Lothar Rubusch wrote:
> Fix some sphinx warnings at 'make htmldocs'.
> 
> Signed-off-by: Lothar Rubusch <l.rubusch@...il.com>
> ---
>  include/net/sock.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/net/sock.h b/include/net/sock.h
> index 6d84784d33fa..2924bcbbd402 100644
> --- a/include/net/sock.h
> +++ b/include/net/sock.h
> @@ -2554,8 +2554,8 @@ 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: 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)
> 

Hi,
How about something like this instead:

 /**
- * 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
  */


and preferably (IMO) the subject should be more like this:

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


thanks.
-- 
~Randy