[PATCH 0/6] additional fixes to kernel-doc.py

Mauro Carvalho Chehab posted 6 patches 10 months ago
scripts/kernel-doc.py           |  8 ++-
scripts/lib/kdoc/kdoc_files.py  | 19 ++-----
scripts/lib/kdoc/kdoc_output.py | 97 ++++++++++++++++++++++++---------
scripts/lib/kdoc/kdoc_parser.py | 15 ++---
4 files changed, 83 insertions(+), 56 deletions(-)
[PATCH 0/6] additional fixes to kernel-doc.py
Posted by Mauro Carvalho Chehab 10 months ago
Hi Jon,

This series comes after:

https://lore.kernel.org/linux-doc/cover.1739952783.git.mchehab+huawei@kernel.org/T/#t

it basically contains:

- a regression fix when -none/--none parameter is used;
- some backward-compatibility fixes;
- a fix to KBUILD_BUILD_TIMESTAMP, which also drops
  importing dateutil (*);
- a cleanup related to man modulename.

(*) despite almost everybody has it installed, dateutil is actually not
    part of the official Python libraries, so using it would require an
    extra dependency check.

While our minimal Python version is 3.9, I opted to make it compatible with
Python 3.6, as the only issue preventing 3.6 was a single string function
(removesuffix) that can be also served by rstrip().

After those changes, support for 3.6 on kernel-doc.py comes almost for 
free: both man and ReST output works with just Python 3.6 installed without
any additional modules.

So, no need to change any dependencies at scripts/sphinx-pre-install.

Mauro Carvalho Chehab (6):
  scripts/kernel-doc.py: Set an output format for --none
  scripts/kernel-doc.py: adjust some coding style issues
  scripts/lib/kdoc/kdoc_parser.py: fix Python compat with < v3.13
  scripts/kernel-doc.py: move modulename to man class
  scripts/kernel-doc.py: properly handle KBUILD_BUILD_TIMESTAMP
  scripts/lib/kdoc/kdoc_parser.py: remove a python 3.9 dependency

 scripts/kernel-doc.py           |  8 ++-
 scripts/lib/kdoc/kdoc_files.py  | 19 ++-----
 scripts/lib/kdoc/kdoc_output.py | 97 ++++++++++++++++++++++++---------
 scripts/lib/kdoc/kdoc_parser.py | 15 ++---
 4 files changed, 83 insertions(+), 56 deletions(-)

-- 
2.48.1
Re: [PATCH 0/6] additional fixes to kernel-doc.py
Posted by Jonathan Corbet 10 months ago
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> Hi Jon,
>
> This series comes after:
>
> https://lore.kernel.org/linux-doc/cover.1739952783.git.mchehab+huawei@kernel.org/T/#t

From the previous discussion, I was thinking that a new version of that
series was in the plan, right?  Just so I don't lose the plot...

Thanks,

jon