| Message ID | 32a67e9ee77cc6c435d08a2cb5ef12559b417fee.1656759989.git.mchehab@kernel.org (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 7b2379454b9a72fece618319acea8d33497d2299 |
| Delegated to: | Brendan Higgins |
| Headers | show |
| Series | Fix several documentation build warnings with Sphinx 2.4.4 | expand |
On Sat, Jul 2, 2022 at 7:07 PM Mauro Carvalho Chehab <mchehab@kernel.org> wrote: > > 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> > --- > > To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. > See [PATCH 00/12] at: https://lore.kernel.org/all/cover.1656759988.git.mchehab@kernel.org/ > Reviewed-by: David Gow <davidgow@google.com> FYI, this is identical to: https://lore.kernel.org/all/20220702051205.3292468-1-davidgow@google.com/ It doesn't matter which one goes through, so if this patch is applied (e.g. to the docs tree as a part of this series), I'll make sure the other one doesn't end up in the KUnit tree. Cheers, -- David > include/kunit/test.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > 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. > -- > 2.36.1 > > -- > You received this message because you are subscribed to the Google Groups "KUnit Development" group. > To unsubscribe from this group and stop receiving emails from it, send an email to kunit-dev+unsubscribe@googlegroups.com. > To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/32a67e9ee77cc6c435d08a2cb5ef12559b417fee.1656759989.git.mchehab%40kernel.org.
On 7/2/22 7:18 AM, David Gow wrote: > On Sat, Jul 2, 2022 at 7:07 PM Mauro Carvalho Chehab <mchehab@kernel.org> wrote: >> >> 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> >> --- >> >> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. >> See [PATCH 00/12] at: https://lore.kernel.org/all/cover.1656759988.git.mchehab@kernel.org/ >> > > Reviewed-by: David Gow <davidgow@google.com> > > FYI, this is identical to: > https://lore.kernel.org/all/20220702051205.3292468-1-davidgow@google.com/ > > It doesn't matter which one goes through, so if this patch is applied > (e.g. to the docs tree as a part of this series), I'll make sure the > other one doesn't end up in the KUnit tree. > > Cheers, > -- David > Applied this now to linux-kselftest kunit branch for 5.20-rc1 thanks, -- Shuah
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.
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> --- To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH 00/12] at: https://lore.kernel.org/all/cover.1656759988.git.mchehab@kernel.org/ include/kunit/test.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)