summaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2025-08-12 17:52:40 +0200
committerJonathan Corbet <corbet@lwn.net>2025-08-13 10:19:17 -0600
commit8cd256524a920782268a0dd7e3e0404c34bfc65f (patch)
tree10b21d8e6be0edcd6dc74fd3ea4dda33ea763032 /scripts
parent6db1d3977baf7ac895033624897d38fb60cbe3f7 (diff)
scripts: sphinx-pre-install: better handle Python min version
Don't do any recommendations about Sphinx install with too old python versions. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/013aeb848ecc3f6b69b4518cf3d335bd2353b6e1.1754992972.git.mchehab+huawei@kernel.org
Diffstat (limited to 'scripts')
-rwxr-xr-xscripts/sphinx-pre-install.py20
1 files changed, 15 insertions, 5 deletions
diff --git a/scripts/sphinx-pre-install.py b/scripts/sphinx-pre-install.py
index 365590f81551..a5c777e529ec 100755
--- a/scripts/sphinx-pre-install.py
+++ b/scripts/sphinx-pre-install.py
@@ -92,6 +92,10 @@ class SphinxDependencyChecker:
# Some distros may not have a Sphinx shipped package compatible with
# our minimal requirements
self.package_supported = True
+
+ # Recommend a new python version
+ self.recommend_python = None
+
# Certain hints are meant to be shown only once
self.first_hint = True
@@ -511,11 +515,11 @@ class SphinxDependencyChecker:
print("ERROR: Distro not supported. Too old?")
return
- # TODO: check if RHEL8 still works.
- # On my tests with docker "redhat/ubi8" image, there's no
- # python3-sphinx (or similar) package. It comes with Python 3.6,
- # but there are other python packages over there, so it may be
- # possible to work with venv.
+ # RHEL 8 uses Python 3.6, which is not compatible with
+ # the build system anymore. Suggest Python 3.11
+ if rel == 8:
+ self.add_package("python39", 0)
+ self.recommend_python = True
if self.first_hint:
print("Note: RHEL-based distros typically require extra repositories.\n" \
@@ -596,6 +600,7 @@ class SphinxDependencyChecker:
# the build system anymore. Suggest Python 3.11
if rel == 15:
if not self.which(self.python_cmd):
+ self.recommend_python = True
self.add_package(self.python_cmd, 0)
progs.update({
@@ -1000,6 +1005,11 @@ class SphinxDependencyChecker:
# - recommended version.
# It also needs to work fine with both distro's package and venv/virtualenv
+ if self.recommend_python:
+ print("\nPython version is incompatible with doc build.\n" \
+ "Please upgrade it and re-run.\n")
+ return
+
# Version is OK. Nothing to do.
if self.cur_version != (0, 0, 0) and self.cur_version >= RECOMMENDED_VERSION:
return