Changes in sphinx-pre-install

cc4adab164b772a34b3340d644b7c4728498581e - Merge tag 'v6.19-rc1' into msm-next

Tue, 20 Jan 2026 23:06:55 +0100

Merge tag 'v6.19-rc1' into msm-nextMerge Linux 6.19-rc1 in order to catch up with other changes (e.g. UBWCconfig database defining UBWC_6).Signed-off-by: Dmitry Baryshkov List of files: /linux/tools/docs/sphinx-pre-install

5add3c3c280a35f7e258e9cef7607db5a2e56fdc - Merge drm/drm-next into drm-xe-next

Fri, 19 Dec 2025 11:51:22 +0100

Merge drm/drm-next into drm-xe-nextBackmerging to bring in 6.19-rc1. An important upstream bugfix andto help unblock PTL CI.Signed-off-by: Thomas Hellström List of files: /linux/tools/docs/sphinx-pre-install

b8304863a3990d0f18c38e5b94191830a63ee1af - Merge drm/drm-next into drm-intel-next

Mon, 15 Dec 2025 14:24:02 +0100

Merge drm/drm-next into drm-intel-nextSync-up some display code needed for Async flips refactor.Signed-off-by: Rodrigo Vivi List of files: /linux/tools/docs/sphinx-pre-install

7f790dd21a931c61167f7bdc327aecf2cebad327 - Merge drm/drm-next into drm-misc-next

Mon, 15 Dec 2025 09:27:39 +0100

Merge drm/drm-next into drm-misc-nextLet's kickstart the v6.20 (7.0?) release cycle.Signed-off-by: Maxime Ripard List of files: /linux/tools/docs/sphinx-pre-install

24f171c7e145f43b9f187578e89b0982ce87e54c - Merge tag 'asoc-fix-v6.19-rc1' of https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound into for-linus

Sun, 21 Dec 2025 11:11:11 +0100

Merge tag 'asoc-fix-v6.19-rc1' of https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound into for-linusASoC: Fixes for v6.19We've been quite busy with fixes since the merge window, though not inany particularly exciting ways - the standout thing is the fix for _SXcontrols which were broken by a change to how we do clamping, otherwiseit's all fairly run of the mill fixes and quirks. List of files: /linux/tools/docs/sphinx-pre-install

84318277d6334c6981ab326d4acc87c6a6ddc9b8 - Merge remote-tracking branch 'drm/drm-fixes' into drm-misc-fixes

Mon, 15 Dec 2025 12:53:27 +0100

Merge remote-tracking branch 'drm/drm-fixes' into drm-misc-fixesPull in rc1 to include all changes since the merge window closed,and grab all fixes and changes from drm/drm-next.Signed-off-by: Maarten Lankhorst List of files: /linux/tools/docs/sphinx-pre-install

f96163865a1346b199cc38e827269296f0f24ab0 - Merge tag 'docs-6.19' of git://git.lwn.net/linux

Wed, 03 Dec 2025 20:34:28 +0100

Merge tag 'docs-6.19' of git://git.lwn.net/linuxPull documentation updates from Jonathan Corbet: "This has been another busy cycle for documentation, with a lot of build-system thrashing. That work should slow down from here on out. - The various scripts and tools for documentation were spread out in several directories; now they are (almost) all coalesced under tools/docs/. The holdout is the kernel-doc script, which cannot be easily moved without some further thought. - As the amount of Python code increases, we are accumulating modules that are imported by multiple programs. These modules have been pulled together under tools/lib/python/ -- at least, for documentation-related programs. There is other Python code in the tree that might eventually want to move toward this organization. - The Perl kernel-doc.pl script has been removed. It is no longer used by default, and nobody has missed it, least of all anybody who actually had to look at it. - The docs build was controlled by a complex mess of makefilese that few dared to touch. Mauro has moved that logic into a new program (tools/docs/sphinx-build-wrapper) that, with any luck at all, will be far easier to understand and maintain. - The get_feat.pl program, used to access information under Documentation/features/, has been rewritten in Python, bringing an end to the use of Perl in the docs subsystem. - The top-level README file has been reorganized into a more reader-friendly presentation. - A lot of Chinese translation additions - Typo fixes and documentation updates as usual"* tag 'docs-6.19' of git://git.lwn.net/linux: (164 commits) docs: makefile: move rustdoc check to the build wrapper README: restructure with role-based documentation and guidelines docs: kdoc: various fixes for grammar, spelling, punctuation docs: kdoc_parser: use '@' for Excess enum value docs: submitting-patches: Clarify that removal of Acks needs explanation too docs: kdoc_parser: add data/function attributes to ignore docs: MAINTAINERS: update Mauro's files/paths docs/zh_CN: Add wd719x.rst translation docs/zh_CN: Add libsas.rst translation get_feat.pl: remove it, as it got replaced by get_feat.py Documentation/sphinx/kernel_feat.py: use class directly tools/docs/get_feat.py: convert get_feat.pl to Python Documentation/admin-guide: fix typo and comment in cscope example docs/zh_CN: Add data-integrity.rst translation docs/zh_CN: Add blk-mq.rst translation docs/zh_CN: Add block/index.rst translation docs/zh_CN: Update the Chinese translation of kbuild.rst docs: bring some order to our Python module hierarchy docs: Move the python libraries to tools/lib/python Documentation/kernel-parameters: Move the kernel build options ... List of files: /linux/tools/docs/sphinx-pre-install

34a28245b6a5c4227b7122c0ff9b98d22b39f033 - Merge branch 'python-modules' into docs-mw

Tue, 18 Nov 2025 17:26:11 +0100

Merge branch 'python-modules' into docs-mwscripts/lib was always a bit of an awkward place for Python libraries; givethem a proper home under tools/lib/python. Put the modules fromtools/docs/lib there for good measure.The second patch ties them into a single package namespace. It would bemore aesthetically pleasing to add a kernel layer, so we could say: from kernel.kdoc import kdoc_parser...and have the kernel-specific stuff clearly marked, but that means addingan empty directory in the hierarchy, which isn't as pleasing.There are some other "Python library" directories hidden in the kerneltree; we may eventually want to encourage them to move as well. List of files: /linux/tools/docs/sphinx-pre-install

992a9df41ad7173588bf90e15b33d45db2811aea - docs: bring some order to our Python module hierarchy

Mon, 10 Nov 2025 23:04:30 +0100

docs: bring some order to our Python module hierarchyNow that we have tools/lib/python for our Python modules, turn them intoproper packages with a single namespace so that everything can just usetools/lib/python in sys.path. No functional change.Signed-off-by: Jonathan Corbet Message-ID: <20251110220430.726665-3-corbet@lwn.net> List of files: /linux/tools/docs/sphinx-pre-install

778b8ebe5192e7a7f00563a7456517dfa63e1d90 - docs: Move the python libraries to tools/lib/python

Mon, 10 Nov 2025 23:04:29 +0100

docs: Move the python libraries to tools/lib/python"scripts/lib" was always a bit of an awkward place for Python modules. Wealready have tools/lib; create a tools/lib/python, move the librariesthere, and update the users accordingly.While at it, move the contents of tools/docs/lib. Rather than make anotherdirectory, just put these documentation-oriented modules under "kdoc".Signed-off-by: Jonathan Corbet Message-ID: <20251110220430.726665-2-corbet@lwn.net> List of files: /linux/tools/docs/sphinx-pre-install

77a22121fe17fe78123d345350e0e301de7aed99 - Merge branch 'tools-final2' into docs-mw

Tue, 04 Nov 2025 00:25:22 +0100

Merge branch 'tools-final2' into docs-mwOur documentation-related tools are spread out over various directories;several are buried in the scripts/ dumping ground. That makes them harderto discover and harder to maintain.Recent work has started accumulating our documentation-related tools in/tools/docs. This series nearly completes that task, moving most of therest of our various utilities there, hopefully fixing up all of therelevant references in the process.The one exception is scripts/kernel-doc; that move turned up some otherproblems, so I have dropped it until those are ironed out.At the end, rather than move the old, Perl kernel-doc, I simply removed it. List of files: /linux/tools/docs/sphinx-pre-install

eaae0ad9720428cd9e2bf9a40fedf137db95184f - docs: move scripts/documentation-file-ref-check to tools/docs

Wed, 13 Aug 2025 19:16:28 +0200

docs: move scripts/documentation-file-ref-check to tools/docsAdd this script to the growing collection of documentation tools.Reviewed-by: Mauro Carvalho Chehab Acked-by: Jani Nikula Signed-off-by: Jonathan Corbet List of files: /linux/tools/docs/sphinx-pre-install

3df5affb4be217b161d21a76c5763417d1cf743b - Merge branch 'build-script' into docs-mw

Fri, 17 Oct 2025 22:11:30 +0200

Merge branch 'build-script' into docs-mwQuoth Mauro:This series should probably be called: "Move the trick-or-treat build hacks accumulated over time into a single place and document them."as this reflects its main goal. As such:- it places the jobserver logic on a library;- it removes sphinx/parallel-wrapper.sh;- the code now properly implements a jobserver-aware logic to do the parallelism when called via GNU make, failing back to "-j" when there's no jobserver;- converts check-variable-fonts.sh to Python and uses it via function call;- drops an extra script to generate man pages, adding a makefile target for it;- ensures that return code is 0 when PDF successfully builds;- about half of the script is comments and documentation.I tried to do my best to document all tricks that are inside thescript. This way, the docs build steps is now documented.It should be noticed that it is out of the scope of this seriesto change the implementation. Surely the process can be improved,but first let's consolidate and document everything on a singleplace.Such script was written in a way that it can be called eitherdirectly or via a Makefile. Running outside Makefile isinteresting specially when debug is needed. The command lineinterface replaces the need of having lots of env vars beforecalling sphinx-build: $ ./tools/docs/sphinx-build-wrapper --help usage: sphinx-build-wrapper [-h] [--sphinxdirs SPHINXDIRS [SPHINXDIRS ...]] [--conf CONF] [--builddir BUILDDIR] [--theme THEME] [--css CSS] [--paper {,a4,letter}] [-v] [-j JOBS] [-i] [-V [VENV]] {cleandocs,linkcheckdocs,htmldocs,epubdocs,texinfodocs,infodocs,mandocs,latexdocs,pdfdocs,xmldocs} Kernel documentation builder positional arguments: {cleandocs,linkcheckdocs,htmldocs,epubdocs,texinfodocs,infodocs,mandocs,latexdocs,pdfdocs,xmldocs} Documentation target to build options: -h, --help show this help message and exit --sphinxdirs SPHINXDIRS [SPHINXDIRS ...] Specific directories to build --conf CONF Sphinx configuration file --builddir BUILDDIR Sphinx configuration file --theme THEME Sphinx theme to use --css CSS Custom CSS file for HTML/EPUB --paper {,a4,letter} Paper size for LaTeX/PDF output -v, --verbose place build in verbose mode -j, --jobs JOBS Sets number of jobs to use with sphinx-build -i, --interactive Change latex default to run in interactive mode -V, --venv [VENV] If used, run Sphinx from a venv dir (default dir: sphinx_latest)the only mandatory argument is the target, which is identical with"make" targets.The call inside Makefile doesn't use the last four arguments. They'rethere to help identifying problems at the build: -v makes the output verbose; -j helps to test parallelism; -i runs latexmk in interactive mode, allowing to debug PDF build issues; -V is useful when testing it with different venvs.When used with GNU make (or some other make which implements jobserver),a call like: make -j htmldocswill make the wrapper to automatically use POSIX jobserver to claimthe number of available job slots, calling sphinx-build with a"-j" parameter reflecting it. ON such case, the default can beoverriden via SPHINXDIRS argument.Visiable changes when compared with the old behavior:When V=0, the only visible difference is that:- pdfdocs target now returns 0 on success, 1 on failures. This addresses an issue over the current process where we it always return success even on failures;- it will now print the name of PDF files that failed to build, if any.In verbose mode, sphinx-build-wrapper and sphinx-build command linesare now displayed. List of files: /linux/tools/docs/sphinx-pre-install

62ea383b449f3b51c3e0602c70ffa5fda29d3649 - tools/docs: sphinx-* break documentation bulds on openSUSE

Thu, 18 Sep 2025 13:54:57 +0200

tools/docs: sphinx-* break documentation bulds on openSUSEBefore this patch, building htmldocs on opensuseLEAP worksfine: # make htmldocs Available Python versions: /usr/bin/python3.11 Python 3.6.15 not supported. Changing to /usr/bin/python3.11 Python 3.6.15 not supported. Changing to /usr/bin/python3.11 Using alabaster theme Using Python kernel-doc ...As the logic detects that Python 3.6 is too old and recommendsintalling python311-Sphinx. If installed, documentation buildswork like a charm.Yet, some develpers complained that running python3.11 insteadof python3 should not happen. So, let's break the build to makethem happier: $ make htmldocs Python 3.6.15 not supported. Bailing out You could run, instead: /usr/bin/python3.11 tools/docs/sphinx-build-wrapper htmldocs \ --sphinxdirs=. --conf=conf.py --builddir=Documentation/output --theme= --css= \ --paper= Python 3.6.15 not supported. Bailing out make[2]: *** [Documentation/Makefile:76: htmldocs] Error 1 make[1]: *** [Makefile:1806: htmldocs] Error 2 make: *** [Makefile:248: __sub-make] Error 2It should be noticed that:1. after this change, sphinx-pre-install needs to be called by hand: $ /usr/bin/python3.11 tools/docs/sphinx-pre-install Detected OS: openSUSE Leap 15.6. Sphinx version: 7.2.6 All optional dependencies are met. Needed package dependencies are met.2. sphinx-build-wrapper will auto-detect python3.11 and suggest a way to build the docs using the parameters passed via make variables. In this specific example: /usr/bin/python3.11 tools/docs/sphinx-build-wrapper htmldocs --sphinxdirs=. --conf=conf.py --theme= --css= --paper=3. As this needs to be executed outside docs Makefile, it won't run the validation check scripts nor build Rust documentation if enabled, as the extra scripts are part of the docs Makefile.Signed-off-by: Mauro Carvalho Chehab Message-ID: <0635c311295300e9fb48c0ea607e2408910036e3.1758196090.git.mchehab+huawei@kernel.org>Signed-off-by: Jonathan Corbet List of files: /linux/tools/docs/sphinx-pre-install

82c294d453c0f065133da064f92a121500cc5643 - tools/docs,scripts: sphinx-*: prevent sphinx-build crashes

Thu, 18 Sep 2025 13:54:51 +0200

tools/docs,scripts: sphinx-*: prevent sphinx-build crashesOn a properly set system, LANG and LC_ALL is always defined.However, some distros like Debian, Gentoo and their variantsstart with those undefioned.When Sphinx tries to set a locale with: locale.setlocale(locale.LC_ALL, '')It raises an exception, making Sphinx fail. This is more likelyto happen with test containers.Add a logic to detect and workaround such issue by settinglocale to C.Signed-off-by: Mauro Carvalho Chehab Message-ID: <1d0afad8fe3d83182be3a08eb00dd71322e23e69.1758196090.git.mchehab+huawei@kernel.org>Signed-off-by: Jonathan Corbet List of files: /linux/tools/docs/sphinx-pre-install

adf9dc2592aad3e66b09cb412e60337477bafb0d - tools/docs: python_version: move version check from sphinx-pre-install

Thu, 18 Sep 2025 13:54:44 +0200

tools/docs: python_version: move version check from sphinx-pre-installThe sphinx-pre-install code has some logic to deal with Pythonversion, which ensures that a minimal version will be enforcedfor documentation build logic.Move it to a separate library to allow re-using its code.No functional changes.Signed-off-by: Mauro Carvalho Chehab Message-ID: Signed-off-by: Jonathan Corbet List of files: /linux/tools/docs/sphinx-pre-install

3f835cb123c30c1a60fa6e0ebbcda919d66fc142 - tools/docs: sphinx-pre-install: allow check for alternatives and bail out

Thu, 18 Sep 2025 13:54:43 +0200

tools/docs: sphinx-pre-install: allow check for alternatives and bail outThe caller script may not want an automatic execution of the newversion. Add two parameters to allow showing alternatives and tobail out if version is incompatible.Signed-off-by: Mauro Carvalho Chehab Message-ID: <19777bc710bf901ffbb0ad0f1bb57b18fc01b163.1758196090.git.mchehab+huawei@kernel.org>Signed-off-by: Jonathan Corbet List of files: /linux/tools/docs/sphinx-pre-install

4880eac5bc61c588221091fa9f98de02b8305810 - tools/docs: sphinx-pre-install: drop a debug print

Thu, 18 Sep 2025 13:54:42 +0200

tools/docs: sphinx-pre-install: drop a debug printThe version print at the lib was added for debugging purposes.Get rid of it.Signed-off-by: Mauro Carvalho Chehab Message-ID: <27f76a4df2b80c38d277d58a92c85c614544e013.1758196090.git.mchehab+huawei@kernel.org>Signed-off-by: Jonathan Corbet List of files: /linux/tools/docs/sphinx-pre-install

abd61d1ff8f0ea4cb099a1f3d5015dea7c8471cf - scripts: sphinx-pre-install: move it to tools/docs

Thu, 18 Sep 2025 13:54:41 +0200

scripts: sphinx-pre-install: move it to tools/docsAs we're reorganizing the place where doc scripts are located,move this one to tools/docs.No functional changes.Signed-off-by: Mauro Carvalho Chehab Message-ID: <5e2c40d3aebfd67b7ac7817f548bd1fa4ff661a8.1758196090.git.mchehab+huawei@kernel.org>Signed-off-by: Jonathan Corbet List of files: /linux/tools/docs/sphinx-pre-install