linux-kernel - Re: [PATCH] kdoc: allow dots in inline @param names

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: <87345217uo.fsf@trenco.lwn.net>
Date: Mon, 22 Dec 2025 15:15:27 -0700
From: Jonathan Corbet <corbet@....net>
To: Steven Price <steven.price@....com>, Mauro Carvalho Chehab
 <mchehab@...nel.org>
Cc: Steven Price <steven.price@....com>, linux-kernel@...r.kernel.org,
 linux-doc@...r.kernel.org
Subject: Re: [PATCH] kdoc: allow dots in inline @param names

Steven Price <steven.price@....com> writes:

> Inline kernel-doc blocks failed to parse tags containing dots (e.g.
> creator.process_name in panfrost_gem.h) because the @name regex only
> matched word characters. Modify the single-line pattern to match
> doc_inline_sect so it includes \. and parses the same as a multi-line
> comment.
>
> Signed-off-by: Steven Price <steven.price@....com>
> ---
>  tools/lib/python/kdoc/kdoc_parser.py | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/tools/lib/python/kdoc/kdoc_parser.py b/tools/lib/python/kdoc/kdoc_parser.py
> index 500aafc50032..261b484ad130 100644
> --- a/tools/lib/python/kdoc/kdoc_parser.py
> +++ b/tools/lib/python/kdoc/kdoc_parser.py
> @@ -53,7 +53,7 @@ doc_content = doc_com_body + KernRe(r'(.*)', cache=False)
>  doc_inline_start = KernRe(r'^\s*/\*\*\s*$', cache=False)
>  doc_inline_sect = KernRe(r'\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)', cache=False)
>  doc_inline_end = KernRe(r'^\s*\*/\s*$', cache=False)
> -doc_inline_oneline = KernRe(r'^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$', cache=False)
> +doc_inline_oneline = KernRe(r'^\s*/\*\*\s*(@\s*[\w][\w\.]*\s*):\s*(.*)\s*\*/\s*$', cache=False)
>  

Heh ... that makes cross-references to container_of() work ... I'm
convinced.  Applied, thanks.

jon