* [PATCH] Documentation: sock.h - fix warnings
@ 2020-04-06 21:52 Lothar Rubusch
2020-04-07 22:32 ` Randy Dunlap
0 siblings, 1 reply; 2+ messages in thread
From: Lothar Rubusch @ 2020-04-06 21:52 UTC (permalink / raw)
To: kuba, davem; +Cc: netdev, Lothar Rubusch
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)
--
2.20.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] Documentation: sock.h - fix warnings
2020-04-06 21:52 [PATCH] Documentation: sock.h - fix warnings Lothar Rubusch
@ 2020-04-07 22:32 ` Randy Dunlap
0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2020-04-07 22:32 UTC (permalink / raw)
To: Lothar Rubusch, kuba, davem; +Cc: netdev
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.
--
~Randy
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-04-07 22:32 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-06 21:52 [PATCH] Documentation: sock.h - fix warnings Lothar Rubusch
2020-04-07 22:32 ` Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).