Received-SPF: pass (google.com: domain of linux-kernel+bounces-58648-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
Content-Type: text/plain;
	charset=us-ascii
Precedence: bulk
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3774.400.31\))
Subject: Re: [PATCH v2] docs: scripts: sphinx-pre-install: Fix building docs
 with pyyaml package
From: Thorsten Blum <thorsten.blum@toblux.com>
In-Reply-To: <4c297f67-72e1-44d7-acb0-462ac261640d@oracle.com>
Date: Thu, 8 Feb 2024 21:15:01 +0100
Cc: corbet@lwn.net,
 linux-doc@vger.kernel.org,
 linux-kernel@vger.kernel.org,
 mchehab@kernel.org
Content-Transfer-Encoding: 7bit
Message-Id: <ED5D37EF-B353-4EA3-8AC9-7368BDD2CFD9@toblux.com>
References: <c6555e01-1945-410e-9950-53c40052626a@oracle.com>
 <20240208131305.52577-1-thorsten.blum@toblux.com>
 <4c297f67-72e1-44d7-acb0-462ac261640d@oracle.com>
To: Vegard Nossum <vegard.nossum@oracle.com>


> On Feb 8, 2024, at 17:37, Vegard Nossum <vegard.nossum@oracle.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