Re: [PATCH] kernel-doc: better handle '::' sequences

From: Jonathan Corbet
Date: Thu Mar 25 2021 - 14:52:25 EST


Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> writes:

> Right now, if one of the following headers end with a '::', the
> kernel-doc script will do the wrong thing:
>
> description|context|returns?|notes?|examples?
>
> The real issue is with examples, as people could try to write
> something like:
>
> example::
>
> /* Some C code */
>
> and this won't be properly evaluated. So, improve the regex
> to not catch '\w+::' regex for the above identifiers.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
> ---
> scripts/kernel-doc | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)

Ah....wouldn't it be nice if kerneldoc comments had just been RST from
the beginning? I don't think we're fixing that at this point, though,
so this makes sense; applied.

Thanks,

jon