diff mbox series

net: skbuff: fix kernel-doc typos

Message ID 20231001003846.29541-2-rdunlap@infradead.org
State New
Headers
Series net: skbuff: fix kernel-doc typos |

Commit Message

Randy Dunlap Oct. 1, 2023, 12:38 a.m. UTC 
  Correct punctuation.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Eric Dumazet <edumazet@google.com>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Paolo Abeni <pabeni@redhat.com>
Cc: netdev@vger.kernel.org
---
 include/linux/skbuff.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Simon Horman Oct. 3, 2023, 10:44 a.m. UTC | #1 
On Sat, Sep 30, 2023 at 05:38:46PM -0700, Randy Dunlap wrote:
> Correct punctuation.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: "David S. Miller" <davem@davemloft.net>
> Cc: Eric Dumazet <edumazet@google.com>
> Cc: Jakub Kicinski <kuba@kernel.org>
> Cc: Paolo Abeni <pabeni@redhat.com>
> Cc: netdev@vger.kernel.org
> ---
>  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@kernel.org>

>   */
>  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.
>   */
>  
>  /**
>
Jakub Kicinski Oct. 4, 2023, 9:21 p.m. UTC | #2 
On Tue, 3 Oct 2023 12:44:47 +0200 Simon Horman wrote:
> > - * 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?

+1, since we're touching the line we can as well..
diff mbox series

Patch

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