Re: [PATCH RFC 00/13] Collect documention-related tools under tools/doc

From: Randy Dunlap
Date: Thu Aug 14 2025 - 22:53:46 EST




On 8/14/25 7:59 AM, Jani Nikula wrote:
> On Wed, 13 Aug 2025, Jonathan Corbet <corbet@xxxxxxx> 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/doc, 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.
>
> A wholehearted
>
> Acked-by: Jani Nikula <jani.nikula@xxxxxxxxx>
>
> on all of it.

and
Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
for the series.

along with using either of tools/doc/ or tools/docs/.

>> 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.
>
> lib/ contains code that's built into the kernel, I think lib/python
> would be out of place.

Would tools/docs/lib be OK?
I wouldn't tie it up to a specific language,
but I don't have a strong opinion either way.

> IMO tools/python (or tools/lib/python, no strong opinion) is more
> appropriate.

--
~Randy