lkml.org 
[lkml]   [2021]   [Jan]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 10/10] seqlock: kernel-doc: fix a prototype
    Date
    Right now, kernel-doc produces a warning:

    ./include/linux/seqlock.h:829: warning: wrong kernel-doc identifier on line:
    * DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t

    The issue is that Kernel-doc valid syntaxes for function/define
    declarations are either:

    function_foo - description

    or:

    function_foo() - description

    The function parameters should be declared only afterwards.

    So, replace it to:
    DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t

    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
    ---
    include/linux/seqlock.h | 2 +-
    1 file changed, 1 insertion(+), 1 deletion(-)

    diff --git a/include/linux/seqlock.h b/include/linux/seqlock.h
    index 2f7bb92b4c9e..209454cedf61 100644
    --- a/include/linux/seqlock.h
    +++ b/include/linux/seqlock.h
    @@ -826,7 +826,7 @@ typedef struct {
    } while (0)

    /**
    - * DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
    + * DEFINE_SEQLOCK() - Define a statically allocated seqlock_t
    * @sl: Name of the seqlock_t instance
    */
    #define DEFINE_SEQLOCK(sl) \
    --
    2.29.2
    \
     
     \ /
      Last update: 2021-01-14 08:55    [W:4.105 / U:0.332 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site