linux-toradex.git/tools/docs, branch master Linux kernel for Apalis and Colibri modules docs: test_doc_build: don't select urllib3 yanked version 2026-10-22T15:43:00+00:00 Mauro Carvalho Chehab mchehab+huawei@kernel.org 2026-10-15T08:57:21+00:00 ef6ef17ec4707d3814e22b8ad71e33e725b0a61f Trying to install urllib3 gives a warning about a yanked version: WARNING: The candidate selected for download or install is a yanked version: 'urllib3' candidate (version 2.0.0 at https://files.pythonhosted.org/packages/ca/25/fe81738a115a2f1005b19bd69b6253b7b5cd6c9119164f13f02ec627fc41/urllib3-2.0.0-py3-none-any.whl (from https://pypi.org/simple/urllib3/) (requires-python:>=3.7)) To avoid that, use the recommended replacement (2.0.2) which should be enough to avoid the warning while keep using the same minor. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <09dc30b251c726910ef192b0f750b1c476cf52d4.1792053090.git.mchehab+huawei@kernel.org> 
Trying to install urllib3 gives a warning about a yanked version:

	WARNING: The candidate selected for download or install is a yanked version: 'urllib3' candidate (version 2.0.0 at https://files.pythonhosted.org/packages/ca/25/fe81738a115a2f1005b19bd69b6253b7b5cd6c9119164f13f02ec627fc41/urllib3-2.0.0-py3-none-any.whl (from https://pypi.org/simple/urllib3/) (requires-python:>=3.7))

To avoid that, use the recommended replacement (2.0.2) which
should be enough to avoid the warning while keep using the same
minor.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <09dc30b251c726910ef192b0f750b1c476cf52d4.1792053090.git.mchehab+huawei@kernel.org>
docs: test_doc_build: address pylint warnings 2026-10-22T15:43:00+00:00 Mauro Carvalho Chehab mchehab+huawei@kernel.org 2026-10-15T08:57:20+00:00 53a25a6e41b7577abd68fb1ef8383c85d0f1ffd7 Address existing pylint issues. While here, adjust some line breaks using black suggestions. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <1a790b550a158bb3b00e5471ba7351eac5185ece.1792053090.git.mchehab+huawei@kernel.org> 
Address existing pylint issues.

While here, adjust some line breaks using black suggestions.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <1a790b550a158bb3b00e5471ba7351eac5185ece.1792053090.git.mchehab+huawei@kernel.org>
docs: test_doc_build: update it to support newer Sphinx versions 2026-10-22T15:43:00+00:00 Mauro Carvalho Chehab mchehab+huawei@kernel.org 2026-10-15T08:57:19+00:00 8aabf705193fd50129bedf3aa091ba578e4bcf7d Current version is 9.1.0. Update the script to handle it. As there were python deprecations on newer versions, add support for those. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <ea7c1a2a8b5adecc2f4d9ccee7ef1f32fa8d0d78.1792053090.git.mchehab+huawei@kernel.org> 
Current version is 9.1.0. Update the script to handle it. As there
were python deprecations on newer versions, add support for those.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <ea7c1a2a8b5adecc2f4d9ccee7ef1f32fa8d0d78.1792053090.git.mchehab+huawei@kernel.org>
docs: test_doc_build: better handle python version 2026-10-22T15:43:00+00:00 Mauro Carvalho Chehab mchehab+huawei@kernel.org 2026-10-15T08:57:18+00:00 5a5021d08be4a1ef70cb0c3ee6feb806b11c0196 Make the python version logic more generic to allow adding more python degradation changes on more recent Sphinx tools. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <871255ee391ceae0d24ed18f31c1e91589d139c7.1792053090.git.mchehab+huawei@kernel.org> 
Make the python version logic more generic to allow adding more
python degradation changes on more recent Sphinx tools.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <871255ee391ceae0d24ed18f31c1e91589d139c7.1792053090.git.mchehab+huawei@kernel.org>
doc tools: fix 'path' typos 2026-08-11T16:43:16+00:00 Randy Dunlap rdunlap@infradead.org 2026-08-06T05:56:34+00:00 0c56db4610768b1962d35a2927b53b9d51d9d8b8 Correct "patch" or "patches" to "path" or "paths" in comments. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260806055634.1293294-1-rdunlap@infradead.org> 
Correct "patch" or "patches" to "path" or "paths" in comments.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260806055634.1293294-1-rdunlap@infradead.org>
docs: sphinx-build-wrapper: include localversion in kernel version string 2026-08-11T15:44:20+00:00 Randy Dunlap rdunlap@infradead.org 2026-08-08T04:53:31+00:00 22a42ee5dad307d4236839e75929c86346cf42e3 Add any localversion* text to the kernel version string so that the docs index (home) page accurately indicates what the docs build version is. E.g.: 7.2.0-rc6-next-20260807 Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260808045331.326769-1-rdunlap@infradead.org> 
Add any localversion* text to the kernel version string
so that the docs index (home) page accurately indicates what
the docs build version is.

E.g.:
  7.2.0-rc6-next-20260807

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260808045331.326769-1-rdunlap@infradead.org>
docs: kdoc_diff: add a helper tool to help checking kdoc regressions 2026-03-30T16:54:13+00:00 Mauro Carvalho Chehab mchehab+huawei@kernel.org 2026-03-26T19:09:43+00:00 210a923aab5b81b6930715c4e845d58d406b154d Checking for regressions at kernel-doc can be hard. Add a helper tool to make such task easier. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <24b3116a78348b13a74d1ff5e141160ef9705dd3.1774551940.git.mchehab+huawei@kernel.org> 
Checking for regressions at kernel-doc can be hard. Add a helper
tool to make such task easier.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <24b3116a78348b13a74d1ff5e141160ef9705dd3.1774551940.git.mchehab+huawei@kernel.org>
doc tools: better handle KBUILD_VERBOSE 2026-03-30T16:03:40+00:00 Mauro Carvalho Chehab mchehab+huawei@kernel.org 2026-03-27T05:57:48+00:00 d642acfd597e3ec37138f9a8f5a634845e3612fd As reported by Jacob, there are troubles when KBUILD_VERBOSE is set at the environment. Fix it on both kernel-doc and sphinx-build-wrapper. Reported-by: Jacob Keller <jacob.e.keller@intel.com> Closes: https://lore.kernel.org/linux-doc/9367d899-53af-4d9c-9320-22fc4dbadca5@intel.com/ Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Tested-by: Jacob Keller <jacob.e.keller@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <7a99788db75630fb14828d612c0fd77c45ec1891.1774591065.git.mchehab+huawei@kernel.org> 
As reported by Jacob, there are troubles when KBUILD_VERBOSE is
set at the environment.

Fix it on both kernel-doc and sphinx-build-wrapper.

Reported-by: Jacob Keller <jacob.e.keller@intel.com>
Closes: https://lore.kernel.org/linux-doc/9367d899-53af-4d9c-9320-22fc4dbadca5@intel.com/
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tested-by: Jacob Keller <jacob.e.keller@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <7a99788db75630fb14828d612c0fd77c45ec1891.1774591065.git.mchehab+huawei@kernel.org>
docs: kernel-doc: add support to store output on a YAML file 2026-03-22T21:10:40+00:00 Mauro Carvalho Chehab mchehab+huawei@kernel.org 2026-03-18T09:11:14+00:00 01d6d7bf9672f1aeabbffaa3fbfb8017223ff878 Add a command line parameter and library support to optionally store: - KdocItem intermediate format after parsing; - man pages output; - rst output. inside a YAML file. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <ba54277b3c909867153b9547dfa33c1831ca35d9.1773823995.git.mchehab+huawei@kernel.org> 
Add a command line parameter and library support to optionally
store:
- KdocItem intermediate format after parsing;
- man pages output;
- rst output.

inside a YAML file.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <ba54277b3c909867153b9547dfa33c1831ca35d9.1773823995.git.mchehab+huawei@kernel.org>
tools/docs/checktransupdate.py: fix all issues reported by pylint 2026-03-22T20:55:21+00:00 Haoyang LIU tttturtleruss@gmail.com 2026-03-09T07:47:15+00:00 6108c809f4fd9dbb1a138ba4326d645cc3113a8d This patch fixes all issues reported by pylint, including: 1. Format issue in logging. 2. Variable name style issue. Fixes: 63e96ce050e5 ("scripts: fix all issues reported by pylint") Signed-off-by: Haoyang LIU <tttturtleruss@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260309074716.10739-1-tttturtleruss@gmail.com> 
This patch fixes all issues reported by pylint, including:
1. Format issue in logging.
2. Variable name style issue.

Fixes: 63e96ce050e5 ("scripts: fix all issues reported by pylint")
Signed-off-by: Haoyang LIU <tttturtleruss@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260309074716.10739-1-tttturtleruss@gmail.com>