linux-kernel - Re: [PATCH v3 15/15] docs: conf.py: Check Sphinx and docutils version

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

Message-ID: <20250622200613.5ad18093@foz.lan>
Date: Sun, 22 Jun 2025 20:06:13 +0200
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Akira Yokosawa <akiyks@...il.com>
Cc: Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org, Linux
 Doc Mailing List <linux-doc@...r.kernel.org>
Subject: Re: [PATCH v3 15/15] docs: conf.py: Check Sphinx and docutils
 version

Em Sun, 22 Jun 2025 20:19:52 +0900
Akira Yokosawa <akiyks@...il.com> escreveu:

> > After check Sphinx release notes, it seems that the
> > version compatibility is given by:
> > 
> >         =======  ============   ============
> >         Sphinx   Min Docutils   Max Docutils
> >         Version  Version        Version
> >         -------  ------------   ------------
> >         3.4.3    >= 0.12.0      < 0.18.0
> >         4.0.0    >= 0.12.0      < 0.19.0
> >         6.0.0    >= 0.18.0      < 0.20.0
> >         7.0.0    >= 0.18.1      < 0.21.0
> >         7.2.0    >= 0.18.1      < 0.20.0
> >         7.4.0    >= 0.18.1      < 0.21.0
> >         8.0.0    >= 0.20.0      < 0.22.0
> >         8.2.3    >= 0.20.0      < 0.22.0
> >         =======  ============   ============
> >   
> 
> <nitpick>
> So this is what I see in the changelog (not looked into < 6.0.0):
> 
>          ================= ====================
>           Sphinx version     docutils version
>           (since)              min       max
>          ----------------- ------------ -------
>          6.0.0             >= 0.18      < 0.20
>          6.2.0             >= 0.18.1    < 0.20
> 	 7.0.1             >= 0.18.1    < 0.21
>          7.3.0             >= 0.18.1    < 0.22
> 	 7.4.0             >= 0.20      < 0.22
> 	 (up to 8.2.3)
>          ================= ====================
> 
> This Looks quite different from yours ...
> </nitpick>

Thanks for your feedback!

Getting this right is not too easy, specially since not all
changelog mentions docutil version. Btw, one of the factors I 
used when building my table were to check the release dates 
of Sphinx and docutils. So, I manually adjusted some entries,
as changelog usually say something like:

	Release 5.0.0 (released May 30, 2022)¶
	Dependencies

	5.0.0 b1

	    #10164: Support Docutils 0.18. Patch by Adam Turner.

But doesn't mention minimal supported version.

I'll re-check and adjust it as needed, if Jon decides to pick it.

Thanks,
Mauro