linux-kernel - Re: [PATCH v2 00/10] Collect documentation-related tools under /tools/docs

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: <4b965910f35458a708ae3d810f1d766720f96c4f@intel.com>
Date: Fri, 24 Oct 2025 16:05:28 +0300
From: Jani Nikula <jani.nikula@...ux.intel.com>
To: Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org
Cc: linux-kernel@...r.kernel.org, Mauro Carvalho Chehab
 <mchehab+huawei@...nel.org>, Akira Yokosawa <akiyks@...il.com>, Randy
 Dunlap <rdunlap@...radead.org>, Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH v2 00/10] Collect documentation-related tools under
 /tools/docs

On Thu, 23 Oct 2025, Jonathan Corbet <corbet@....net> wrote:
> Our documentation-related tools are spread out over various directories;
> several are buried in the scripts/ dumping ground.  That makes them harder
> to discover and harder to maintain.
>
> Recently, the idea of creating a dedicated directory for documentation tools
> came up; I decided to see what it would look like.  This series creates a
> new directory, tools/docs, and moves various utilities there, hopefully
> fixing up all of the relevant references in the process.
>
> At the end, rather than move the old, Perl kernel-doc, I simply removed it.

FWIW,

Acked-by: Jani Nikula <jani.nikula@...el.com>

> The big elephant lurking in this small room is the home for Python modules;
> I left them under scripts/lib, but that is an even less appropriate place
> than it was before.  I would propose either tools/python or lib/python;
> thoughts on that matter welcome.

I think lib is for kernel code, so lib/python seems out of place.

I don't think tools/python emphasizes lib enough, and gut feeling says
it'll end up containing random python tools, which I think is the wrong
way to organize things.

tools/lib/python?

In any case, I think either tools/python or tools/lib/python is better
than, say, tools/docs/lib, because the python libraries should be geared
at being more generally useful than just for docs.


BR,
Jani.


-- 
Jani Nikula, Intel