linux-kernel - Re: [PATCH v2] docs: drop the version constraints for sphinx and dependencies

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]

Date: Sun, 03 Mar 2024 08:17:59 -0700
From: Jonathan Corbet <corbet@....net>
To: Lukas Bulwahn <lukas.bulwahn@...il.com>, Mauro Carvalho Chehab
 <mchehab@...nel.org>, Vegard Nossum <vegard.nossum@...cle.com>, Akira
 Yokosawa <akiyks@...il.com>, Jani Nikula <jani.nikula@...ux.intel.com>,
 Randy Dunlap <rdunlap@...radead.org>, linux-doc@...r.kernel.org
Cc: linux-kernel@...r.kernel.org, Lukas Bulwahn <lukas.bulwahn@...il.com>
Subject: Re: [PATCH v2] docs: drop the version constraints for sphinx and
 dependencies

Lukas Bulwahn <lukas.bulwahn@...il.com> writes:

> As discussed (see Links), there is some inertia to move to the recent
> Sphinx versions for the doc build environment.
>
> As first step, drop the version constraints and the related comments. As
> sphinx depends on jinja2, jinja2 is pulled in automatically. So drop that.
> Then, the sphinx-pre-install script will fail though with:
>
>   Can't get default sphinx version from ./Documentation/sphinx/requirements.txt at ./scripts/sphinx-pre-install line 305.
>
> The script simply expects to parse a version constraint with Sphinx in the
> requirements.txt. That version is used in the script for suggesting the
> virtualenv directory name.
>
> To suggest a virtualenv directory name, when there is no version given in
> the requirements.txt, one could try to guess the version that would be
> downloaded with 'pip install -r Documentation/sphinx/requirements.txt'.
> However, there seems no simple way to get that version without actually
> setting up the venv and running pip. So, instead, name the directory with
> the fixed name 'sphinx_latest'.
>
> Finally update the Sphinx build documentation to reflect this directory
> name change.
>
> Link: https://lore.kernel.org/linux-doc/874jf4m384.fsf@meer.lwn.net/
> Link: https://lore.kernel.org/linux-doc/20240226093854.47830-1-lukas.bulwahn@gmail.com/
> Reviewed-by: Akira Yokosawa <akiyks@...il.com>
> Tested-by: Vegard Nossum <vegard.nossum@...cle.com>
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@...il.com>
> ---
> v1 -> v2:
>   drop jinja2 as suggested by Vegard.
>   add tags from v1 review
>
>  Documentation/doc-guide/sphinx.rst    | 11 ++++++-----
>  Documentation/sphinx/requirements.txt |  7 ++-----
>  scripts/sphinx-pre-install            | 19 +++----------------
>  3 files changed, 11 insertions(+), 26 deletions(-)

I've applied this - thanks.

jon