From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH v2 07/12] docs: kdoc: Coalesce parameter-list handling
Date: Fri, 11 Jul 2025 06:45:32 -0600 [thread overview]
Message-ID: <8734b2yjyr.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20250711075406.76ae06ec@foz.lan>
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> Em Thu, 10 Jul 2025 17:31:37 -0600
> Jonathan Corbet <corbet@lwn.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@lwn.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@kernel.org>
Weird, I was sure I did that...will do it again...
Thanks,
jon
next prev parent reply other threads:[~2025-07-11 12:45 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-10 23:31 [PATCH v2 00/12] Thrash up the parser/output interface Jonathan Corbet
2025-07-10 23:31 ` [PATCH v2 01/12] docs: kdoc; Add a rudimentary class to represent output items Jonathan Corbet
2025-07-10 23:31 ` [PATCH v2 02/12] docs: kdoc: simplify the output-item passing Jonathan Corbet
2025-07-10 23:31 ` [PATCH v2 03/12] docs: kdoc: drop "sectionlist" Jonathan Corbet
2025-07-11 5:50 ` Mauro Carvalho Chehab
2025-07-10 23:31 ` [PATCH v2 04/12] docs: kdoc: Centralize handling of the item section list Jonathan Corbet
2025-07-11 5:52 ` Mauro Carvalho Chehab
2025-07-10 23:31 ` [PATCH v2 05/12] docs: kdoc: remove the "struct_actual" machinery Jonathan Corbet
2025-07-10 23:31 ` [PATCH v2 06/12] docs: kdoc: use self.entry.parameterlist directly in check_sections() Jonathan Corbet
2025-07-10 23:31 ` [PATCH v2 07/12] docs: kdoc: Coalesce parameter-list handling Jonathan Corbet
2025-07-11 5:54 ` Mauro Carvalho Chehab
2025-07-11 12:45 ` Jonathan Corbet [this message]
2025-07-10 23:31 ` [PATCH v2 08/12] docs: kdoc: Regularize the use of the declaration name Jonathan Corbet
2025-07-10 23:31 ` [PATCH v2 09/12] docs: kdoc: straighten up dump_declaration() Jonathan Corbet
2025-07-10 23:31 ` [PATCH v2 10/12] docs: kdoc: directly access the always-there KdocItem fields Jonathan Corbet
2025-07-10 23:31 ` [PATCH v2 11/12] docs: kdoc: clean up check_sections() Jonathan Corbet
2025-07-10 23:31 ` [PATCH v2 12/12] docs: kdoc: emit a warning for ancient versions of Python Jonathan Corbet
2025-07-11 5:49 ` Mauro Carvalho Chehab
2025-07-11 4:29 ` [PATCH v2 00/12] Thrash up the parser/output interface Akira Yokosawa
2025-07-11 7:29 ` Mauro Carvalho Chehab
2025-07-11 13:17 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8734b2yjyr.fsf@trenco.lwn.net \
--to=corbet@lwn.net \
--cc=akiyks@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.