linux-kernel - Re: [PATCH 00/13] Add kernel-doc modules to Documentation/tools

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: <874iooul86.fsf@trenco.lwn.net>
Date: Wed, 14 Jan 2026 11:01:45 -0700
From: Jonathan Corbet <corbet@....net>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, Nícolas F. R. A. Prado <nfraprado@...labora.com>,
 Randy Dunlap <rdunlap@...radead.org>,
 Shuah Khan <skhan@...uxfoundation.org>
Subject: Re: [PATCH 00/13] Add kernel-doc modules to Documentation/tools

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

> With this version, python files inside tools/ or scripts/
> can be documented, but there is a catch (probably due to PEP8):
>
>     - files must end with ".py"
>     - file names can't have "-".
>
> So, unfortunately, we can't document kernel-doc.py, except if
> we rename it to kernel_doc.py.

That is ... irritating ...

You've probably seen my other series to finally ... rename
kernel-doc.py.  We could certainly rename it to something different.
But I really dislike having language extensions on files meant to be
executed as commands; you shouldn't care what language it's written in
when you run it.

In the end, I'd say let's not worry about running autodoc on that file.
All there is to document is its command line, and we can certainly
maintain that separately.

jon