* [PATCH] scripts: kernel-doc: fix parsing function-like typedefs
@ 2020-12-02 8:17 Mauro Carvalho Chehab
2020-12-03 23:08 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Mauro Carvalho Chehab @ 2020-12-02 8:17 UTC (permalink / raw)
To: Linux Doc Mailing List, Jonathan Corbet
Cc: Mauro Carvalho Chehab, linux-kernel
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>
---
scripts/kernel-doc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 919acae23fad..a9a92e623dbc 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1444,7 +1444,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.28.0
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] scripts: kernel-doc: fix parsing function-like typedefs
2020-12-02 8:17 [PATCH] scripts: kernel-doc: fix parsing function-like typedefs Mauro Carvalho Chehab
@ 2020-12-03 23:08 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2020-12-03 23:08 UTC (permalink / raw)
To: Mauro Carvalho Chehab; +Cc: Linux Doc Mailing List, linux-kernel
On Wed, 2 Dec 2020 09:17:32 +0100
Mauro Carvalho Chehab <mchehab+huawei@kernel.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@kernel.org>
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-12-03 23:09 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-12-02 8:17 [PATCH] scripts: kernel-doc: fix parsing function-like typedefs Mauro Carvalho Chehab
2020-12-03 23:08 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).