| Message ID | 20220702051205.3292468-1-davidgow@google.com |
|---|---|
| State | New |
| Headers | show |
| Series | kunit: Documentation: Fix a kernel-doc reference | expand |
On Sat, Jul 2, 2022 at 1:12 AM David Gow <davidgow@google.com> wrote: > > When building the KUnit documentation, the reference to > kunit_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 '&'. > > Fixes: 9bf2eed995f9 ("kunit: add support for kunit_suites that reference init code") > Signed-off-by: David Gow <davidgow@google.com> Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
diff --git a/include/kunit/test.h b/include/kunit/test.h index 8ffcd7de9607..f1c1a95df9b8 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -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.
When building the KUnit documentation, the reference to kunit_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 '&'. Fixes: 9bf2eed995f9 ("kunit: add support for kunit_suites that reference init code") Signed-off-by: David Gow <davidgow@google.com> --- (As a KUnit patch, we'll accept this via the KUnit tree.) --- include/kunit/test.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)