Re: [RFC v2 18/38] docs: sphinx/kernel_abi: use AbiParser directly

From: Jonathan Corbet
Date: Tue Feb 04 2025 - 12:13:32 EST


Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> writes:

> Hi Jon,

> As I'll be preparing such patches for merge along this week, I'd
> like to know what do you prefer in terms of directories:
>
> 1. Keep it as-is;
> 2. have a separate library directory for Python modules
> (scripts/lib?);
> 3. place python modules inside scripts/;
> 4. place python modules inside Documentation/sphinx (IMO a bad
> idea);
> 5. something else

Honestly, I'm not sure. I do feel that importing out of scripts/ is
inelegant at best; having a dedicated directory for modules meant to be
imported would be better. So maybe scripts/lib? Or lib/python, though
that might raise eyebrows elsewhere, dunno. Pick something you like,
and we'll give that a try.

> Btw, I'm considering to also submit later a patchset similar to
> this one converting kernel-doc to Python. I already started writing
> something like that (written from the scratch, following as much
> as possible what we have today on Perl to avoid regressions).
>
> I would probably split the code into separate classes to make the code
> more readable/maintainable (a base class, a class with rest output,
> another one with man output, and a few other helper classes).

I definitely approve of the idea - I've pondered doing such a thing, but
have never come close to finding the time. It's probably worth looking
at the rewrite Markus did years ago as a starting point?

Thanks,

jon