kunit: test.h: fix a kernel-doc markup
authorMauro Carvalho Chehab <mchehab@kernel.org>
Sat, 2 Jul 2022 11:07:40 +0000 (12:07 +0100)
committerShuah Khan <skhan@linuxfoundation.org>
Fri, 8 Jul 2022 17:22:47 +0000 (11:22 -0600)
Fix this kernel-doc warning:

Documentation/dev-tools/kunit/api/test:9: ./include/kunit/test.h:323: WARNING: Inline interpreted text or phrase reference start-string without end-string.

Functions should use func_name() on kernel-doc markups, as
documented at:
Documentation/doc-guide/kernel-doc.rst

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Reviewed-by: David Gow <davidgow@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
include/kunit/test.h

index ccae848..7646d1b 100644 (file)
@@ -321,7 +321,7 @@ static inline int kunit_run_all_tests(void)
  *
  * @__suites: a statically allocated list of &struct kunit_suite.
  *
- * This functions identically as &kunit_test_suites() except that it suppresses
+ * This functions identically as kunit_test_suites() except that it suppresses
  * modpost warnings for referencing functions marked __init or data marked
  * __initdata; this is OK because currently KUnit only runs tests upon boot
  * during the init phase or upon loading a module during the init phase.