kunit: Documentation: Fix a kernel-doc reference
Subsystems (3)
PATCH 1/1 kunit: Documentation: Fix a kernel-doc reference
When building the KUnit documentation, the reference tokunit_test_suites in the kunit_test_init_section_suites kernel-doc
comment gives an error:Documentation/dev-tools/kunit/api/test:9: ./include/kunit/test.h:323: WARNING: Inline interpreted text or phrase reference start-string without end-string.
This is because the reference is mixing two function reference styles:
adding an '&' to the front, and "()" to the end. The latter is neater, so get rid of the '&'.
---
(As a KUnit patch, we'll accept this via the KUnit tree.)
--- include/kunit/test.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/kunit/test.h +1 -1
@@ -320,7 +320,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.
Signature · 1 line
2.37.0.rc0.161.g10f37bed90-goog
Quoted 6 lines · David Gow
When building the KUnit documentation, the reference to
kunit_test_suitesin thekunit_test_init_section_suiteskernel-doc
comment gives an error:Documentation/dev-tools/kunit/api/test:9:./include/kunit/test.h:323: WARNING: Inline interpreted text or phrase reference start-string without end-string.
Quoted 6 lines
This is because the reference is mixing two function reference styles:
adding an '&' to the front, and "()" to the end. The latter is neater, so get rid of the '&'.Fixes 9bf2eed995f9 ("kunit: add support for kunit_suites that reference init code")Signed-off-by David Gow <[email protected]>