Skip to content

additional fixes to kernel-doc.py

Mauro Carvalho Chehab linux-doc lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest6 patches 1 replyIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/6scripts/kernel-doc.py: Set an output format for --nonescripts/lib/kdoc/kdoc_files.py+4 -00 replies
2/6scripts/kernel-doc.py: adjust some coding style issuesscripts/kernel-doc.py scripts/lib/kdoc/kdoc_files.py scripts/lib/kdoc/kdoc_output.py+43 -140 replies
3/6scripts/lib/kdoc/kdoc_parser.py: fix Python compat with < v3.13scripts/lib/kdoc/kdoc_output.py scripts/lib/kdoc/kdoc_parser.py+6 -60 replies
4/6scripts/kernel-doc.py: move modulename to man classscripts/kernel-doc.py scripts/lib/kdoc/kdoc_files.py scripts/lib/kdoc/kdoc_output.py +1 more+11 -220 replies
5/6scripts/kernel-doc.py: properly handle KBUILD_BUILD_TIMESTAMPscripts/lib/kdoc/kdoc_files.py scripts/lib/kdoc/kdoc_output.py+21 -160 replies
6/6scripts/lib/kdoc/kdoc_parser.py: remove a python 3.9 dependencyscripts/lib/kdoc/kdoc_parser.py+1 -10 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

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

Hi Jon,

This series comes after:

https://lore.kernel.org/linux-doc/[email protected]/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(-)
Signature · 1 line
2.48.1