[PATCH] net: fix comment typo for __skb_alloc_pages()

[PATCH] net: fix comment typo for __skb_alloc_pages()

[Florian Fainelli]

The name of the function in the comment is __skb_alloc_page() while we
are actually commenting __skb_alloc_pages(). Fix this typo.

Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
---
 include/linux/skbuff.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h
index 5ac96f3..3a81e4b 100644
--- a/include/linux/skbuff.h
+++ b/include/linux/skbuff.h
@@ -1906,7 +1906,7 @@ static inline struct sk_buff *netdev_alloc_skb_ip_align(struct net_device *dev,
 }
 
 /*
- *	__skb_alloc_page - allocate pages for ps-rx on a skb and preserve pfmemalloc data
+ *	__skb_alloc_pages - allocate pages for ps-rx on a skb and preserve pfmemalloc data
  *	@gfp_mask: alloc_pages_node mask. Set __GFP_NOMEMALLOC if not for network packet RX
  *	@skb: skb to set pfmemalloc on if __GFP_MEMALLOC is used
  *	@order: size of the allocation
-- 
1.8.1.2

Re: [PATCH] net: fix comment typo for __skb_alloc_pages()

[Eric Dumazet]

On Fri, 2013-08-30 at 14:28 +0100, Florian Fainelli wrote:
> The name of the function in the comment is __skb_alloc_page() while we
> are actually commenting __skb_alloc_pages(). Fix this typo.
> 
> Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
> ---
>  include/linux/skbuff.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h
> index 5ac96f3..3a81e4b 100644
> --- a/include/linux/skbuff.h
> +++ b/include/linux/skbuff.h
> @@ -1906,7 +1906,7 @@ static inline struct sk_buff *netdev_alloc_skb_ip_align(struct net_device *dev,
>  }
>  
>  /*
> - *	__skb_alloc_page - allocate pages for ps-rx on a skb and preserve pfmemalloc data
> + *	__skb_alloc_pages - allocate pages for ps-rx on a skb and preserve pfmemalloc data
>   *	@gfp_mask: alloc_pages_node mask. Set __GFP_NOMEMALLOC if not for network packet RX
>   *	@skb: skb to set pfmemalloc on if __GFP_MEMALLOC is used
>   *	@order: size of the allocation

What about making this a real kerneldoc comment ?

/**

instead of

/*

Re: [PATCH] net: fix comment typo for __skb_alloc_pages()

[Florian Fainelli]

2013/8/30 Eric Dumazet <eric.dumazet@gmail.com>:
> On Fri, 2013-08-30 at 14:28 +0100, Florian Fainelli wrote:
>> The name of the function in the comment is __skb_alloc_page() while we
>> are actually commenting __skb_alloc_pages(). Fix this typo.
>>
>> Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
>> ---
>>  include/linux/skbuff.h | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h
>> index 5ac96f3..3a81e4b 100644
>> --- a/include/linux/skbuff.h
>> +++ b/include/linux/skbuff.h
>> @@ -1906,7 +1906,7 @@ static inline struct sk_buff *netdev_alloc_skb_ip_align(struct net_device *dev,
>>  }
>>
>>  /*
>> - *   __skb_alloc_page - allocate pages for ps-rx on a skb and preserve pfmemalloc data
>> + *   __skb_alloc_pages - allocate pages for ps-rx on a skb and preserve pfmemalloc data
>>   *   @gfp_mask: alloc_pages_node mask. Set __GFP_NOMEMALLOC if not for network packet RX
>>   *   @skb: skb to set pfmemalloc on if __GFP_MEMALLOC is used
>>   *   @order: size of the allocation
>
> What about making this a real kerneldoc comment ?

Sure, I was not sure whether this deserved one or more patches, will
resend fixed.
-- 
Florian

[PATCH net-next] net: fix comment typo for __skb_alloc_pages()

[Florian Fainelli]

The name of the function in the comment is __skb_alloc_page() while we
are actually commenting __skb_alloc_pages(). Fix this typo and make it
a valid kernel doc comment.

Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
---
 include/linux/skbuff.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h
index 5ac96f3..6f1330a 100644
--- a/include/linux/skbuff.h
+++ b/include/linux/skbuff.h
@@ -1905,8 +1905,8 @@ static inline struct sk_buff *netdev_alloc_skb_ip_align(struct net_device *dev,
 	return __netdev_alloc_skb_ip_align(dev, length, GFP_ATOMIC);
 }
 
-/*
- *	__skb_alloc_page - allocate pages for ps-rx on a skb and preserve pfmemalloc data
+/**
+ *	__skb_alloc_pages - allocate pages for ps-rx on a skb and preserve pfmemalloc data
  *	@gfp_mask: alloc_pages_node mask. Set __GFP_NOMEMALLOC if not for network packet RX
  *	@skb: skb to set pfmemalloc on if __GFP_MEMALLOC is used
  *	@order: size of the allocation
-- 
1.8.1.2

Re: [PATCH net-next] net: fix comment typo for __skb_alloc_pages()

[David Miller]

From: "Florian Fainelli" <f.fainelli@gmail.com>
Date: Fri, 30 Aug 2013 15:36:14 +0100

> The name of the function in the comment is __skb_alloc_page() while we
> are actually commenting __skb_alloc_pages(). Fix this typo and make it
> a valid kernel doc comment.
> 
> Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>

Applied, thanks.