linux-kernel - [PATCH] docs: freeze some package versions for sphinx virtualenv setup

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <20240226093854.47830-1-lukas.bulwahn@gmail.com>
Date: Mon, 26 Feb 2024 10:38:54 +0100
From: Lukas Bulwahn <lukas.bulwahn@...il.com>
To: Jonathan Corbet <corbet@....net>,
	Akira Yokosawa <akiyks@...il.com>,
	Jani Nikula <jani.nikula@...ux.intel.com>,
	linux-doc@...r.kernel.org,
	Vegard Nossum <vegard.nossum@...cle.com>,
	Mauro Carvalho Chehab <mchehab@...nel.org>
Cc: kernel-janitors@...r.kernel.org,
	linux-kernel@...r.kernel.org,
	Lukas Bulwahn <lukas.bulwahn@...il.com>
Subject: [PATCH] docs: freeze some package versions for sphinx virtualenv setup

If you currently follow the instructions for sphinx install:

    /usr/bin/python3 -m venv sphinx_2.4.4
    . sphinx_2.4.4/bin/activate
    pip install -r ./Documentation/sphinx/requirements.txt

you encounter an error during make htmldocs:

    Sphinx version error:
    The sphinxcontrib.applehelp extension used by this project needs
    at least Sphinx v5.0; it therefore cannot be built with this version.

Akira-san Yokosawa reported this already in January 2023 and Jani Nikula
was fast in providing a fix (see Link). This however remained as a thread
on the linux-doc mailing and was never turned into a patch for Jonathan to
pick up.

Fix some versions for the Sphinx 2.4.4 to continue to work.

Link: https://lore.kernel.org/linux-doc/cb72b3d6-de7a-4c8a-a99c-72d58a23f89c@gmail.com/
Reported-by: Akira Yokosawa <akiyks@...il.com>
Closes: https://lore.kernel.org/linux-doc/cb72b3d6-de7a-4c8a-a99c-72d58a23f89c@gmail.com/
Suggested-by: Jani Nikula <jani.nikula@...ux.intel.com>
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@...il.com>
---
 Documentation/sphinx/requirements.txt | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
index 5d47ed443949..0aa4fdb84632 100644
--- a/Documentation/sphinx/requirements.txt
+++ b/Documentation/sphinx/requirements.txt
@@ -2,5 +2,10 @@
 jinja2<3.1
 # alabaster>=0.7.14 is not compatible with Sphinx<=3.3
 alabaster<0.7.14
+sphinxcontrib-applehelp==1.0.4
+sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-htmlhelp==2.0.1
+sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-serializinghtml==1.1.5
 Sphinx==2.4.4
 pyyaml
-- 
2.43.2