linux-kernel - Re: [PATCH v2 07/12] docs: kdoc: Coalesce parameter-list handling

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <8734b2yjyr.fsf@trenco.lwn.net>
Date: Fri, 11 Jul 2025 06:45:32 -0600
From: Jonathan Corbet <corbet@....net>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, Akira Yokosawa
 <akiyks@...il.com>
Subject: Re: [PATCH v2 07/12] docs: kdoc: Coalesce parameter-list handling

Mauro Carvalho Chehab <mchehab+huawei@...nel.org> writes:

> Em Thu, 10 Jul 2025 17:31:37 -0600
> Jonathan Corbet <corbet@....net> escreveu:
>
>> Callers to output_declaration() always pass the parameter information from
>> self.entry; remove all of the boilerplate arguments and just get at that
>> information directly.  Formalize its placement in the KdocItem class.
>> 
>> It would be nice to get rid of parameterlist as well, but that has the
>> effect of reordering the output of function parameters and struct fields to
>> match the order in the kerneldoc comment rather than in the declaration.
>> One could argue about which is more correct, but the ordering has been left
>> unchanged for now.
>> 
>> Signed-off-by: Jonathan Corbet <corbet@....net>
>> ---
>>  scripts/lib/kdoc/kdoc_item.py   | 11 ++++-
>>  scripts/lib/kdoc/kdoc_output.py | 75 +++++++++++++--------------------
>>  scripts/lib/kdoc/kdoc_parser.py | 23 ++--------
>>  3 files changed, 42 insertions(+), 67 deletions(-)
>> 
>> diff --git a/scripts/lib/kdoc/kdoc_item.py b/scripts/lib/kdoc/kdoc_item.py
>> index f0b2b9082c56..beac5c70a881 100644
>> --- a/scripts/lib/kdoc/kdoc_item.py
>> +++ b/scripts/lib/kdoc/kdoc_item.py
>> @@ -11,6 +11,9 @@ class KdocItem:
>>          self.declaration_start_line = start_line
>>          self.sections = {}
>>          self.sections_start_lines = {}
>
>> +        self.parameterlist = self.parameterdesc_start_lines = []
>
> Please split it on two lines as well. With that, feel free to add:
>
> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

Weird, I was sure I did that...will do it again...

Thanks,

jon