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

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] [thread-next>] [day] [month] [year] [list]

Date: Tue, 3 Oct 2023 12:44:47 +0200
From: Simon Horman <horms@...nel.org>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, "David S. Miller" <davem@...emloft.net>,
	Eric Dumazet <edumazet@...gle.com>,
	Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>,
	netdev@...r.kernel.org
Subject: Re: [PATCH] net: skbuff: fix kernel-doc typos

On Sat, Sep 30, 2023 at 05:38:46PM -0700, Randy Dunlap wrote:
> Correct punctuation.
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: "David S. Miller" <davem@...emloft.net>
> Cc: Eric Dumazet <edumazet@...gle.com>
> Cc: Jakub Kicinski <kuba@...nel.org>
> Cc: Paolo Abeni <pabeni@...hat.com>
> Cc: netdev@...r.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@...nel.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.
>   */
>  
>  /**
>