linux-kernel - Re: [PATCH] scripts: kernel-doc: fix parsing function-like typedefs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20201203160819.70cd8673@lwn.net>
Date:   Thu, 3 Dec 2020 16:08:19 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] scripts: kernel-doc: fix parsing function-like typedefs

On Wed,  2 Dec 2020 09:17:32 +0100
Mauro Carvalho Chehab <mchehab+huawei@...nel.org> wrote:

> 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@...nel.org>

Applied, thanks.

jon