[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <IA3PR11MB89868B3C74A4E47FA05158CFE591A@IA3PR11MB8986.namprd11.prod.outlook.com>
Date: Wed, 28 Jan 2026 17:49:53 +0000
From: "Loktionov, Aleksandr" <aleksandr.loktionov@...el.com>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, Jonathan Corbet
<corbet@....net>, Linux Doc Mailing List <linux-doc@...r.kernel.org>
CC: "bpf@...r.kernel.org" <bpf@...r.kernel.org>,
"intel-wired-lan@...ts.osuosl.org" <intel-wired-lan@...ts.osuosl.org>,
"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
"netdev@...r.kernel.org" <netdev@...r.kernel.org>, Peter Zijlstra
<peterz@...radead.org>, Randy Dunlap <rdunlap@...radead.org>, "Stephen
Rothwell" <sfr@...b.auug.org.au>
Subject: RE: [Intel-wired-lan] [PATCH v2 25/25] docs: kdoc_re: fix a parse bug
on struct page_pool_params
> -----Original Message-----
> From: Intel-wired-lan <intel-wired-lan-bounces@...osl.org> On Behalf
> Of Mauro Carvalho Chehab
> Sent: Wednesday, January 28, 2026 5:50 PM
> To: Jonathan Corbet <corbet@....net>; Linux Doc Mailing List <linux-
> doc@...r.kernel.org>
> Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>;
> bpf@...r.kernel.org; intel-wired-lan@...ts.osuosl.org; linux-
> kernel@...r.kernel.org; netdev@...r.kernel.org; Peter Zijlstra
> <peterz@...radead.org>; Randy Dunlap <rdunlap@...radead.org>; Stephen
> Rothwell <sfr@...b.auug.org.au>
> Subject: [Intel-wired-lan] [PATCH v2 25/25] docs: kdoc_re: fix a parse
> bug on struct page_pool_params
>
> The struct page_pool_params definition has a private definition on it:
>
> struct page_pool_params {
> struct_group_tagged(page_pool_params_fast, fast,
> unsigned int order;
> unsigned int pool_size;
> int nid;
> struct device *dev;
> struct napi_struct *napi;
> enum dma_data_direction dma_dir;
> unsigned int max_len;
> unsigned int offset;
> );
> struct_group_tagged(page_pool_params_slow, slow,
> struct net_device *netdev;
> unsigned int queue_idx;
> unsigned int flags;
> /* private: used by test code only */
> void (*init_callback)(netmem_ref netmem, void *arg);
> void *init_arg;
> );
> };
>
> This makes kernel-doc parser to miss the end parenthesis of the second
> struct_group_tagged, causing documentation issues.
>
> Address it by ensuring that, if are there anything at the stack, it
> will be placed as the last part of the argument.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> ---
> tools/lib/python/kdoc/kdoc_re.py | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/tools/lib/python/kdoc/kdoc_re.py
> b/tools/lib/python/kdoc/kdoc_re.py
> index f49a568b9155..8d4cfdf8f479 100644
> --- a/tools/lib/python/kdoc/kdoc_re.py
> +++ b/tools/lib/python/kdoc/kdoc_re.py
> @@ -206,6 +206,9 @@ class NestedMatch:
> """
>
> stack = []
> + start = 0
> + offset = 0
> + pos = 0
>
> for match_re in self.regex.finditer(line):
> start = match_re.start()
> @@ -255,6 +258,11 @@ class NestedMatch:
> yield start, offset, pos + 1
> break
>
> + # When /* private */ is used, it may end the end delimiterq
> + if stack:
> + stack.pop()
> + yield start, offset, len(line) + 1
> +
> def search(self, line):
> """
> This is similar to re.search:
> --
> 2.52.0
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@...el.com>
Powered by blists - more mailing lists