lkml.org 
[lkml]   [2020]   [Oct]   [13]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v6 64/80] kunit: test.h: fix a bad kernel-doc markup
    Date
    As warned by:

    ./include/kunit/test.h:504: WARNING: Block quote ends without a blank line; unexpected unindent.

    The right way to describe a function is:

    name - description

    Instead, kunit_remove_resource was using:

    name: description

    Causing it to be improperly parsed.

    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
    ---
    include/kunit/test.h | 4 ++--
    1 file changed, 2 insertions(+), 2 deletions(-)

    diff --git a/include/kunit/test.h b/include/kunit/test.h
    index 41b3a266bf8c..5c5ed262a950 100644
    --- a/include/kunit/test.h
    +++ b/include/kunit/test.h
    @@ -498,8 +498,8 @@ static inline int kunit_destroy_named_resource(struct kunit *test,
    }

    /**
    - * kunit_remove_resource: remove resource from resource list associated with
    - * test.
    + * kunit_remove_resource() - remove resource from resource list associated with
    + * test.
    * @test: The test context object.
    * @res: The resource to be removed.
    *
    --
    2.26.2
    \
     
     \ /
      Last update: 2020-10-13 13:56    [W:4.656 / U:0.024 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site