| Message ID | 20200406215230.21758-1-l.rubusch@gmail.com |
|---|---|
| State | Superseded |
| Delegated to: | David Miller |
| Headers | show |
| Series | Documentation: sock.h - fix warnings | expand |
On 4/6/20 2:52 PM, Lothar Rubusch wrote: > Fix some sphinx warnings at 'make htmldocs'. > > Signed-off-by: Lothar Rubusch <l.rubusch@gmail.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.
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)
Fix some sphinx warnings at 'make htmldocs'. Signed-off-by: Lothar Rubusch <l.rubusch@gmail.com> --- include/net/sock.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)