From: David Gow <davidgow@google.com>
Date: Thu, 5 Sep 2024 02:47:55 +0000 (+0800)
Subject: kunit: Fix missing kerneldoc comment
X-Git-Tag: v6.11-rc7~8^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=12cb32a52eb607dc4d0e45fe6f4cf946d08da0fd;p=thirdparty%2Fkernel%2Flinux.git

kunit: Fix missing kerneldoc comment

Add a missing kerneldoc comment for the 'test' test context parameter,
fixing the following warning:

include/kunit/test.h:492: warning: Function parameter or struct member 'test' not described in 'kunit_kfree_const'

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/lkml/20240827160631.67e121ed@canb.auug.org.au/
Fixes: f2c6dbd22017 ("kunit: Device wrappers should also manage driver name")
Signed-off-by: David Gow <davidgow@google.com>
Reviewed-by: Kees Cook <kees@kernel.org>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
---

diff --git a/include/kunit/test.h b/include/kunit/test.h
index 5ac237c949a08..34b71e42fb107 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -484,6 +484,7 @@ static inline void *kunit_kcalloc(struct kunit *test, size_t n, size_t size, gfp
 
 /**
  * kunit_kfree_const() - conditionally free test managed memory
+ * @test: The test context object.
  * @x: pointer to the memory
  *
  * Calls kunit_kfree() only if @x is not in .rodata section.