diff mbox series

kunit: skb: add gfp to kernel doc for kunit_zalloc_skb()

Message ID b31a16ef-382f-4b8f-b4d5-1c4d93803779@stanley.mountain (mailing list archive)
State New
Delegated to: Brendan Higgins
Headers show
Series kunit: skb: add gfp to kernel doc for kunit_zalloc_skb() | expand

Commit Message

Dan Carpenter Nov. 11, 2024, 10:54 a.m. UTC
Kuan-Wei Chiu pointed out that the kernel doc for kunit_zalloc_skb()
needs to include the @gfp information.  Add it.

Reported-by: Kuan-Wei Chiu <visitorckw@gmail.com>
Closes: https://lore.kernel.org/all/Zy+VIXDPuU613fFd@visitorckw-System-Product-Name/
Signed-off-by: Dan Carpenter <dan.carpenter@linaro.org>
---
 include/kunit/skbuff.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Kuan-Wei Chiu Nov. 11, 2024, 4:09 p.m. UTC | #1
On Mon, Nov 11, 2024 at 01:54:09PM +0300, Dan Carpenter wrote:
> Kuan-Wei Chiu pointed out that the kernel doc for kunit_zalloc_skb()
> needs to include the @gfp information.  Add it.
> 
> Reported-by: Kuan-Wei Chiu <visitorckw@gmail.com>
> Closes: https://lore.kernel.org/all/Zy+VIXDPuU613fFd@visitorckw-System-Product-Name/
> Signed-off-by: Dan Carpenter <dan.carpenter@linaro.org>

Reviewed-by: Kuan-Wei Chiu <visitorckw@gmail.com>

Regards,
Kuan-Wei

> ---
>  include/kunit/skbuff.h | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/include/kunit/skbuff.h b/include/kunit/skbuff.h
> index 345e1e8f0312..07784694357c 100644
> --- a/include/kunit/skbuff.h
> +++ b/include/kunit/skbuff.h
> @@ -20,8 +20,9 @@ static void kunit_action_kfree_skb(void *p)
>   * kunit_zalloc_skb() - Allocate and initialize a resource managed skb.
>   * @test: The test case to which the skb belongs
>   * @len: size to allocate
> + * @gfp: allocation flags
>   *
> - * Allocate a new struct sk_buff with GFP_KERNEL, zero fill the give length
> + * Allocate a new struct sk_buff with gfp flags, zero fill the given length
>   * and add it as a resource to the kunit test for automatic cleanup.
>   *
>   * Returns: newly allocated SKB, or %NULL on error
> -- 
> 2.45.2
> 
>
David Gow Nov. 12, 2024, 6:20 a.m. UTC | #2
On Mon, 11 Nov 2024 at 18:54, Dan Carpenter <dan.carpenter@linaro.org> wrote:
>
> Kuan-Wei Chiu pointed out that the kernel doc for kunit_zalloc_skb()
> needs to include the @gfp information.  Add it.
>
> Reported-by: Kuan-Wei Chiu <visitorckw@gmail.com>
> Closes: https://lore.kernel.org/all/Zy+VIXDPuU613fFd@visitorckw-System-Product-Name/
> Signed-off-by: Dan Carpenter <dan.carpenter@linaro.org>
> ---
>  include/kunit/skbuff.h | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/include/kunit/skbuff.h b/include/kunit/skbuff.h
> index 345e1e8f0312..07784694357c 100644
> --- a/include/kunit/skbuff.h
> +++ b/include/kunit/skbuff.h
> @@ -20,8 +20,9 @@ static void kunit_action_kfree_skb(void *p)
>   * kunit_zalloc_skb() - Allocate and initialize a resource managed skb.
>   * @test: The test case to which the skb belongs
>   * @len: size to allocate
> + * @gfp: allocation flags
>   *
> - * Allocate a new struct sk_buff with GFP_KERNEL, zero fill the give length
> + * Allocate a new struct sk_buff with gfp flags, zero fill the given length
>   * and add it as a resource to the kunit test for automatic cleanup.
>   *
>   * Returns: newly allocated SKB, or %NULL on error
> --

Thanks for fixing this.

Reviewed-by: David Gow <davidgow@google.com>

Cheers,
-- David

> 2.45.2
>
diff mbox series

Patch

diff --git a/include/kunit/skbuff.h b/include/kunit/skbuff.h
index 345e1e8f0312..07784694357c 100644
--- a/include/kunit/skbuff.h
+++ b/include/kunit/skbuff.h
@@ -20,8 +20,9 @@  static void kunit_action_kfree_skb(void *p)
  * kunit_zalloc_skb() - Allocate and initialize a resource managed skb.
  * @test: The test case to which the skb belongs
  * @len: size to allocate
+ * @gfp: allocation flags
  *
- * Allocate a new struct sk_buff with GFP_KERNEL, zero fill the give length
+ * Allocate a new struct sk_buff with gfp flags, zero fill the given length
  * and add it as a resource to the kunit test for automatic cleanup.
  *
  * Returns: newly allocated SKB, or %NULL on error