linux-kernel - Re: [PATCH 0/9] A series of kernel-doc tweaks

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: <20250607115802.0ce61a17@foz.lan>
Date: Sat, 7 Jun 2025 11:58:02 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Jonathan Corbet <corbet@....net>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 0/9] A series of kernel-doc tweaks

Em Fri,  6 Jun 2025 10:34:29 -0600
Jonathan Corbet <corbet@....net> escreveu:

> I will freely confess that I merged the kernel-doc Python rewrite without
> fully understanding the code; at the time, the fact that it worked as
> advertised sufficed.  I *do* feel the need to understand this code, though,
> going forward, so I've dedicated some time to digging through it.
> 
> In the process, I've been making some adjustments to the code that, IMO,
> make it a bit more approachable - for myself and, hopefully, for others.
> The goal is to try to get functions to the point where people of limited
> mind (like me) can soak them up, make the code slightly more Pythonic, and
> removing redundant code.
> 
> Here is the first set of tweaks.  The output from "make htmldocs" remains
> entirely unchanged throughout the series.  The docs build is slightly
> faster afterward - but that's not the point.
> 
> Mauro, the more I dig into this the happier I am that you pushed this
> change through - it was far overdue.  Hopefully you don't mind me sweeping
> up a bit around the edges...

Sure, feel free to help improving it! The main goal of the conversion
was to make it as close as possible to the Perl version, being
bug-compatible. Due to that, there are several places where it can
(and should) be improved. It is now time to clean it up and improve
it ;-)

> 
> Jonathan Corbet (9):
>   docs: kdoc: simplify the PROTO continuation logic
>   docs: kdoc: move the core dispatch into a state table
>   docs: kdoc: remove the section_intro variable
>   docs: kdoc: simplify the kerneldoc recognition code
>   docs: kdoc: remove the KernelEntry::is_kernel_comment member
>   docs: kdoc: remove the KernelEntry::descr pseudo member
>   docs: kdoc: remove some ineffective code
>   docs: kdoc: move the declaration regexes out of process_name()
>   docs: kdoc: some final touches for process_name()
> 
>  scripts/lib/kdoc/kdoc_parser.py | 152 ++++++++++++++++----------------
>  1 file changed, 75 insertions(+), 77 deletions(-)
> 



Thanks,
Mauro