Re: [PATCH] net: skbuff: fix kernel-doc typos

From: Simon Horman
Date: Tue Oct 03 2023 - 06:44:55 EST


On Sat, Sep 30, 2023 at 05:38:46PM -0700, Randy Dunlap wrote:
> Correct punctuation.
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: "David S. Miller" <davem@xxxxxxxxxxxxx>
> Cc: Eric Dumazet <edumazet@xxxxxxxxxx>
> Cc: Jakub Kicinski <kuba@xxxxxxxxxx>
> Cc: Paolo Abeni <pabeni@xxxxxxxxxx>
> Cc: netdev@xxxxxxxxxxxxxxx
> ---
> include/linux/skbuff.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff -- a/include/linux/skbuff.h b/include/linux/skbuff.h
> --- a/include/linux/skbuff.h
> +++ b/include/linux/skbuff.h
> @@ -1309,7 +1309,7 @@ struct sk_buff_fclones {
> *
> * Returns true if skb is a fast clone, and its clone is not freed.
> * Some drivers call skb_orphan() in their ndo_start_xmit(),
> - * so we also check that this didnt happen.
> + * so we also check that this didn't happen.

At the risk of bikeshedding (let's not) perhaps "this" can be dropped
from the line above?

In any case, I agree that this patch improves the documentation.

Reviewed-by: Simon Horman <horms@xxxxxxxxxx>

> */
> static inline bool skb_fclone_busy(const struct sock *sk,
> const struct sk_buff *skb)
> @@ -2016,7 +2016,7 @@ static inline struct sk_buff *skb_share_
> * Copy shared buffers into a new sk_buff. We effectively do COW on
> * packets to handle cases where we have a local reader and forward
> * and a couple of other messy ones. The normal one is tcpdumping
> - * a packet thats being forwarded.
> + * a packet that's being forwarded.
> */
>
> /**
>