linux-kernel - [PATCH] Documentation: sphinx: Require alabaster <0.7.14

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>] [thread-next>] [day] [month] [year] [list]

Date: Thu, 11 Jan 2024 17:21:31 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	Linux Documentation <linux-doc@...r.kernel.org>
Cc: Jonathan Corbet <corbet@....net>,
	Randy Dunlap <rdunlap@...radead.org>,
	Vegard Nossum <vegard.nossum@...cle.com>,
	Attreyee M <tintinm2017@...il.com>,
	Adam Turner <9087854+aa-turner@...rs.noreply.github.com>,
	Bagas Sanjaya <bagasdotme@...il.com>
Subject: [PATCH] Documentation: sphinx: Require alabaster <0.7.14

Alabaster commit 640273fd3ca7 ("Drop support for Python 3.8 and
earlier") [1] bumps minimum Sphinx version to v3.4, which breaks
htmldocs build due to version incompatibility with Sphinx version used
in Linux kernel documentation (v2.4.4):

```
Sphinx version error:
The alabaster extension used by this project needs at least Sphinx v3.4; it therefore cannot be built with this version.
```

Fix the build error by requiring alabaster version less than 0.7.14 (in
other words, at most 0.7.13).

Link: https://github.com/sphinx-doc/alabaster/commit/640273fd3ca7cdc1528c591172fd9cce2ead911c [1]
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
 I'm noticing htmldocs error when trying to build current master (still in
 merge window). Is this patch OK for 6.8 material after v6.8-rc1 is released
 (as stabilizing fix)?

 Documentation/sphinx/requirements.txt | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/sphinx/requirements.txt b/Documentation/sphinx/requirements.txt
index 335b53df35e22f..b2ca7432437518 100644
--- a/Documentation/sphinx/requirements.txt
+++ b/Documentation/sphinx/requirements.txt
@@ -1,3 +1,5 @@
 # jinja2>=3.1 is not compatible with Sphinx<4.0
 jinja2<3.1
 Sphinx==2.4.4
+# alabaster>=0.7.14 is not compatible with Sphinx<3.4
+alabaster<0.7.14

base-commit: de927f6c0b07d9e698416c5b287c521b07694cac
-- 
An old man doll... just what I always wanted! - Clara