linux-kernel - Re: [PATCH] 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]

Message-ID: <c6555e01-1945-410e-9950-53c40052626a@oracle.com>
Date: Thu, 8 Feb 2024 11:21:01 +0100
From: Vegard Nossum <vegard.nossum@...cle.com>
To: Thorsten Blum <thorsten.blum@...lux.com>,
        Jonathan Corbet
 <corbet@....net>,
        Mauro Carvalho Chehab <mchehab@...nel.org>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: scripts: sphinx-pre-install: Fix building docs with
 pyyaml package


On 07/02/2024 12:12, 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
> fix building the docs if you prefer to install Sphinx as a package.

Thanks for fixing this!

> @@ -955,6 +957,7 @@ sub check_needs()
>   	check_program("gcc", 0);
>   	check_program("dot", 1);
>   	check_program("convert", 1);
> +	check_python_module("pyyaml", 1);

Shouldn't this be just "yaml" instead of "pyyaml"? check_python_module()
is going to "import" that argument and the Python module itself is just
called "yaml".

Hm, but then it's going to add "yaml" to %missing, which keys on
packages, not modules... Maybe add an optional argument to
check_python_module() so that it knows both the Python module name and
the package name?

As usual, I could be wrong...


Vegard