linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org
Subject: [PATCH 0/6] additional fixes to kernel-doc.py
Date: Wed, 19 Feb 2025 14:57:35 +0100	[thread overview]
Message-ID: <cover.1739972906.git.mchehab+huawei@kernel.org> (raw)

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



             reply	other threads:[~2025-02-19 13:57 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-02-19 13:57 Mauro Carvalho Chehab [this message]
2025-02-19 13:57 ` [PATCH 1/6] scripts/kernel-doc.py: Set an output format for --none Mauro Carvalho Chehab
2025-02-19 13:57 ` [PATCH 2/6] scripts/kernel-doc.py: adjust some coding style issues Mauro Carvalho Chehab
2025-02-19 13:57 ` [PATCH 3/6] scripts/lib/kdoc/kdoc_parser.py: fix Python compat with < v3.13 Mauro Carvalho Chehab
2025-02-19 13:57 ` [PATCH 4/6] scripts/kernel-doc.py: move modulename to man class Mauro Carvalho Chehab
2025-02-19 13:57 ` [PATCH 5/6] scripts/kernel-doc.py: properly handle KBUILD_BUILD_TIMESTAMP Mauro Carvalho Chehab
2025-02-19 13:57 ` [PATCH 6/6] scripts/lib/kdoc/kdoc_parser.py: remove a python 3.9 dependency Mauro Carvalho Chehab
2025-02-21 20:24 ` [PATCH 0/6] additional fixes to kernel-doc.py Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1739972906.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).