Received-SPF: pass (google.com: domain of linux-kernel+bounces-128244-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
From: Jonathan Corbet <corbet@lwn.net>
To: Thorsten Blum <thorsten.blum@toblux.com>, Mauro Carvalho Chehab
 <mchehab@kernel.org>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Thorsten Blum
 <thorsten.blum@toblux.com>
Subject: Re: [PATCH] scripts: sphinx-pre-install: Add pyyaml hint to other
 distros
In-Reply-To: <20240323125837.2022-2-thorsten.blum@toblux.com>
References: <20240323125837.2022-2-thorsten.blum@toblux.com>
Date: Tue, 02 Apr 2024 09:30:07 -0600
Message-ID: <87ttkjwznk.fsf@meer.lwn.net>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain

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

> Extend commit 84b4cc8189f2 ("docs: scripts: sphinx-pre-install: Fix
> building docs with pyyaml package") and add pyyaml as an optional
> package to Mageia, ArchLinux, and Gentoo.
>
> 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.
>
> Signed-off-by: Thorsten Blum <thorsten.blum@toblux.com>
> ---
>  scripts/sphinx-pre-install | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/scripts/sphinx-pre-install b/scripts/sphinx-pre-install
> index 4c781617ffe6..d4f05216ca23 100755
> --- a/scripts/sphinx-pre-install
> +++ b/scripts/sphinx-pre-install
> @@ -514,6 +514,7 @@ sub give_mageia_hints()
>  {
>  	my %map = (
>  		"python-sphinx"		=> "python3-sphinx",
> +		"yaml"			=> "python3-yaml",
>  		"virtualenv"		=> "python3-virtualenv",
>  		"dot"			=> "graphviz",
>  		"convert"		=> "ImageMagick",
> @@ -557,6 +558,7 @@ sub give_mageia_hints()
>  sub give_arch_linux_hints()
>  {
>  	my %map = (
> +		"yaml"			=> "python-yaml",
>  		"virtualenv"		=> "python-virtualenv",
>  		"dot"			=> "graphviz",
>  		"convert"		=> "imagemagick",
> @@ -587,6 +589,7 @@ sub give_arch_linux_hints()
>  sub give_gentoo_hints()
>  {
>  	my %map = (
> +		"yaml"			=> "dev-python/pyyaml",
>  		"virtualenv"		=> "dev-python/virtualenv",
>  		"dot"			=> "media-gfx/graphviz",
>  		"convert"		=> "media-gfx/imagemagick",

Applied, thanks.

jon