linux-kernel - Re: [PATCH 01/13] docs: Move the "features" tools to tools/doc

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250814075612.30ca0050@foz.lan>
Date: Thu, 14 Aug 2025 07:56:12 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH 01/13] docs: Move the "features" tools to tools/doc

Em Wed, 13 Aug 2025 16:42:42 -0700
Randy Dunlap <rdunlap@...radead.org> escreveu:

> On 8/13/25 4:38 PM, Mauro Carvalho Chehab wrote:
> > Em Wed, 13 Aug 2025 15:32:00 -0600
> > Jonathan Corbet <corbet@....net> escreveu:
> >   
> >> The scripts for managing the features docs are found in three different
> >> directories; unite them all under tools/doc and update references as
> >> needed.
> >>
> >> Signed-off-by: Jonathan Corbet <corbet@....net>
> >> ---
> >>  Documentation/sphinx/kernel_feat.py                           | 4 ++--
> >>  .../features/scripts => tools/doc}/features-refresh.sh        | 0
> >>  {scripts => tools/doc}/get_feat.pl                            | 2 +-  
> > 
> > This one is the next on my list to convert to Python, but I didn't
> > do any changes on it yet.  
> 
> Just curious, why does it need to be converted from shell to Python?
> I'm sure you will explain that in the patch description (or cover letter).

The rationale is the same as kernel-doc and get-abi: there is a Sphinx
extension that executes it. By converting it into Python and splitting
the code into an exec and a library, we can use the library directly at
the extension.

Besides that, the code in Python, specially after using modules and 
classes, become IMO clearer, making easier to maintain, specially if
we avoid functions inside functions, complex class inheritance, lamba
functions and multiple statements on a single line.

Thanks,
Mauro