[PATCH 08/12] kunit: test.h: fix a kernel-doc markup

0 views
Skip to first unread message

Mauro Carvalho Chehab

unread,
Jul 2, 2022, 7:07:49 AMJul 2
to Linux Doc Mailing List, Mauro Carvalho Chehab, Jonathan Corbet, Mauro Carvalho Chehab, Brendan Higgins, kuni...@googlegroups.com, linux-...@vger.kernel.org, linux-k...@vger.kernel.org
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 <mch...@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.16567599...@kernel.org/

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

David Gow

unread,
Jul 2, 2022, 9:19:06 AMJul 2
to Mauro Carvalho Chehab, Linux Doc Mailing List, Jonathan Corbet, Mauro Carvalho Chehab, Brendan Higgins, KUnit Development, Linux Kernel Mailing List, open list:KERNEL SELFTEST FRAMEWORK
On Sat, Jul 2, 2022 at 7:07 PM Mauro Carvalho Chehab <mch...@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 <mch...@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.16567599...@kernel.org/
>

Reviewed-by: David Gow <davi...@google.com>

FYI, this is identical to:
https://lore.kernel.org/all/20220702051205.3...@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+...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/32a67e9ee77cc6c435d08a2cb5ef12559b417fee.1656759989.git.mchehab%40kernel.org.

Shuah Khan

unread,
Jul 8, 2022, 1:30:18 PMJul 8
to David Gow, Mauro Carvalho Chehab, Linux Doc Mailing List, Jonathan Corbet, Mauro Carvalho Chehab, Brendan Higgins, KUnit Development, Linux Kernel Mailing List, open list:KERNEL SELFTEST FRAMEWORK, Shuah Khan
On 7/2/22 7:18 AM, David Gow wrote:
> On Sat, Jul 2, 2022 at 7:07 PM Mauro Carvalho Chehab <mch...@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 <mch...@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.16567599...@kernel.org/
>>
>
> Reviewed-by: David Gow <davi...@google.com>
>
> FYI, this is identical to:
> https://lore.kernel.org/all/20220702051205.3...@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

Reply all
Reply to author
Forward
0 new messages