lkml.org 
[lkml]   [2020]   [Dec]   [28]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 5.10 294/717] scripts: kernel-doc: fix parsing function-like typedefs
    Date
    From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

    [ Upstream commit 7d2c6b1edf790d96e9017a0b27be2425e1af1532 ]

    Changeset 6b80975c6308 ("scripts: kernel-doc: fix typedef parsing")
    added support for things like:

    typedef unsigned long foo();

    However, it caused a regression on this prototype:

    typedef bool v4l2_check_dv_timings_fnc(const struct v4l2_dv_timings *t, void *handle);

    This is only noticed after adding a patch that checks if the
    kernel-doc identifier matches the typedef:

    ./scripts/kernel-doc -none $(git grep '^.. kernel-doc::' Documentation/ |cut -d ' ' -f 3|sort|uniq) 2>&1|grep expecting
    include/media/v4l2-dv-timings.h:38: warning: expecting prototype for typedef v4l2_check_dv_timings_fnc. Prototype was for typedef nc instead

    The problem is that, with the new parsing logic, it is not
    checking for complete words at the type part.

    Fix it by adding a \b at the end of each type word at the
    regex.

    fixes: 6b80975c6308 ("scripts: kernel-doc: fix typedef parsing")
    Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
    Link: https://lore.kernel.org/r/218ff56dcb8e73755005d3fb64586eb1841a276b.1606896997.git.mchehab+huawei@kernel.org
    Signed-off-by: Jonathan Corbet <corbet@lwn.net>
    Signed-off-by: Sasha Levin <sashal@kernel.org>
    ---
    scripts/kernel-doc | 2 +-
    1 file changed, 1 insertion(+), 1 deletion(-)

    diff --git a/scripts/kernel-doc b/scripts/kernel-doc
    index 9b6ddeb097e93..6325bec3f66f8 100755
    --- a/scripts/kernel-doc
    +++ b/scripts/kernel-doc
    @@ -1431,7 +1431,7 @@ sub dump_enum($$) {
    }
    }

    -my $typedef_type = qr { ((?:\s+[\w\*]+){1,8})\s* }x;
    +my $typedef_type = qr { ((?:\s+[\w\*]+\b){1,8})\s* }x;
    my $typedef_ident = qr { \*?\s*(\w\S+)\s* }x;
    my $typedef_args = qr { \s*\((.*)\); }x;

    --
    2.27.0


    \
     
     \ /
      Last update: 2020-12-28 15:14    [W:2.361 / U:0.200 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site