linux-kernel - Re: [PATCH v3] 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] [day] [month] [year] [list]

Message-ID: <87cysyznfz.fsf@meer.lwn.net>
Date: Wed, 14 Feb 2024 15:32:48 -0700
From: Jonathan Corbet <corbet@....net>
To: Thorsten Blum <thorsten.blum@...lux.com>, mchehab@...nel.org
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 vegard.nossum@...cle.com, Thorsten Blum <thorsten.blum@...lux.com>
Subject: Re: [PATCH v3] docs: scripts: sphinx-pre-install: Fix building docs
 with pyyaml package

Thorsten Blum <thorsten.blum@...lux.com> writes:

> 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 multiple distros to fix building the
> docs if you prefer to install Sphinx as a package.
>
> Signed-off-by: Thorsten Blum <thorsten.blum@...lux.com>
> Reviewed-by: Vegard Nossum <vegard.nossum@...cle.com>
> Tested-by: Vegard Nossum <vegard.nossum@...cle.com>
> ---
> Changes in v2:
> - s/pyyaml/yaml/ as suggested by Vegard Nossum
> - Make the check require the Python module; was optional
>
> Changes in v3:
> - Preserve Reviewed-by: and Tested-by: tags
> - Add pyyaml to openSUSE as suggested by Vegard Nossum
> ---
>  scripts/sphinx-pre-install | 4 ++++
>  1 file changed, 4 insertions(+)

Applied, thanks.

jon