linux-kernel - Re: [PATCH v2] docs: scripts: sphinx-pre-install: Fix building docs with pyyaml package

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: Thu, 8 Feb 2024 21:15:01 +0100
From: Thorsten Blum <thorsten.blum@...lux.com>
To: Vegard Nossum <vegard.nossum@...cle.com>
Cc: corbet@....net,
 linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org,
 mchehab@...nel.org
Subject: Re: [PATCH v2] docs: scripts: sphinx-pre-install: Fix building docs
 with pyyaml package


> On Feb 8, 2024, at 17:37, Vegard Nossum <vegard.nossum@...cle.com> wrote:
> 
> On 08/02/2024 14:13, Thorsten Blum wrote:
>> The Python module pyyaml is required to build the docs, but it is only
>> listed in Documentation/sphinx/requirements.txt and is therefore missing
>> when Sphinx is installed as a package and not via pip/pypi.
>> Add pyyaml as an optional package for Debian- and Red Hat-based distros to
> s/optional/required/ ? Given...

The commit message should be correct. The system package is optional, but the
Python module itself is required.

> Can/should we add it to give_opensuse_hints() as well, given that it
> also apparently allows you to install Sphinx via the distro package
> manager? (Not sure about mageia/arch/gentoo.)

Yes, I'll submit a v3 shortly.

Thanks,
Thorsten