Correct grammar for better readability.
Signed-off-by: Randy Dunlap <[email protected]>
Cc: Jesper Dangaard Brouer <[email protected]>
Cc: Ilias Apalodimas <[email protected]>
Cc: [email protected]
Cc: "David S. Miller" <[email protected]>
Cc: Eric Dumazet <[email protected]>
Cc: Jakub Kicinski <[email protected]>
Cc: Paolo Abeni <[email protected]>
---
include/net/page_pool/helpers.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff -- a/include/net/page_pool/helpers.h b/include/net/page_pool/helpers.h
--- a/include/net/page_pool/helpers.h
+++ b/include/net/page_pool/helpers.h
@@ -16,13 +16,13 @@
* page_pool_alloc_pages() call. Drivers should use
* page_pool_dev_alloc_pages() replacing dev_alloc_pages().
*
- * API keeps track of in-flight pages, in order to let API user know
+ * The API keeps track of in-flight pages, in order to let API users know
* when it is safe to free a page_pool object. Thus, API users
* must call page_pool_put_page() to free the page, or attach
- * the page to a page_pool-aware objects like skbs marked with
+ * the page to a page_pool-aware object like skbs marked with
* skb_mark_for_recycle().
*
- * API user must call page_pool_put_page() once on a page, as it
+ * API users must call page_pool_put_page() once on a page, as it
* will either recycle the page, or in case of refcnt > 1, it will
* release the DMA mapping and in-flight state accounting.
*/
Correct punctuation.
Signed-off-by: Randy Dunlap <[email protected]>
Cc: "David S. Miller" <[email protected]>
Cc: Eric Dumazet <[email protected]>
Cc: Jakub Kicinski <[email protected]>
Cc: Paolo Abeni <[email protected]>
Cc: [email protected]
---
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.
*/
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.
*/
/**
On Sat, Sep 30, 2023 at 05:38:45PM -0700, Randy Dunlap wrote:
> Correct grammar for better readability.
>
> Signed-off-by: Randy Dunlap <[email protected]>
Reviewed-by: Simon Horman <[email protected]>
On Sat, Sep 30, 2023 at 05:38:46PM -0700, Randy Dunlap wrote:
> Correct punctuation.
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: "David S. Miller" <[email protected]>
> Cc: Eric Dumazet <[email protected]>
> Cc: Jakub Kicinski <[email protected]>
> Cc: Paolo Abeni <[email protected]>
> Cc: [email protected]
> ---
> 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 <[email protected]>
> */
> 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.
> */
>
> /**
>
Thanks Randy!
On Sun, 1 Oct 2023 at 03:38, Randy Dunlap <[email protected]> wrote:
>
> Correct grammar for better readability.
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Jesper Dangaard Brouer <[email protected]>
> Cc: Ilias Apalodimas <[email protected]>
> Cc: [email protected]
> Cc: "David S. Miller" <[email protected]>
> Cc: Eric Dumazet <[email protected]>
> Cc: Jakub Kicinski <[email protected]>
> Cc: Paolo Abeni <[email protected]>
> ---
> include/net/page_pool/helpers.h | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff -- a/include/net/page_pool/helpers.h b/include/net/page_pool/helpers.h
> --- a/include/net/page_pool/helpers.h
> +++ b/include/net/page_pool/helpers.h
> @@ -16,13 +16,13 @@
> * page_pool_alloc_pages() call. Drivers should use
> * page_pool_dev_alloc_pages() replacing dev_alloc_pages().
> *
> - * API keeps track of in-flight pages, in order to let API user know
> + * The API keeps track of in-flight pages, in order to let API users know
> * when it is safe to free a page_pool object. Thus, API users
> * must call page_pool_put_page() to free the page, or attach
> - * the page to a page_pool-aware objects like skbs marked with
> + * the page to a page_pool-aware object like skbs marked with
> * skb_mark_for_recycle().
> *
> - * API user must call page_pool_put_page() once on a page, as it
> + * API users must call page_pool_put_page() once on a page, as it
> * will either recycle the page, or in case of refcnt > 1, it will
> * release the DMA mapping and in-flight state accounting.
> */
Acked-by: Ilias Apalodimas <[email protected]>
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..
Hello:
This patch was applied to netdev/net.git (main)
by Jakub Kicinski <[email protected]>:
On Sat, 30 Sep 2023 17:38:45 -0700 you wrote:
> Correct grammar for better readability.
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Jesper Dangaard Brouer <[email protected]>
> Cc: Ilias Apalodimas <[email protected]>
> Cc: [email protected]
> Cc: "David S. Miller" <[email protected]>
> Cc: Eric Dumazet <[email protected]>
> Cc: Jakub Kicinski <[email protected]>
> Cc: Paolo Abeni <[email protected]>
>
> [...]
Here is the summary with links:
- page_pool: fix documentation typos
https://git.kernel.org/netdev/net/c/513dbc10cfc1
You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html