lkml.org 
[lkml]   [2022]   [Jul]   [2]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 08/12] kunit: test.h: fix a kernel-doc markup
    Date
    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(-)

    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
    \
     
     \ /
      Last update: 2022-07-02 13:09    [W:4.167 / U:0.160 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site