leandrof/linux
1
0
Fork 0
forked from Minki/linux
Code Issues Pull Requests Packages Projects Releases Wiki Activity

scripts: sphinx-pre-install: place a warning for Sphinx >= 3.0

Browse Source 
Newer versions of Sphinx have a known bug:
	https://github.com/sphinx-doc/sphinx/pull/8313

Those currently produces 11 false-positive warnings On Sphinx
version 3.1+.

While Sphinx fix is not applied, let's warn adventurers that would
be using Sphinx installed via distro packages.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Link: https://lore.kernel.org/r/085e0ada65c11da9303d07e70c510dc45f21315b.1656756450.git.mchehab@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Mauro Carvalho Chehab 2022-07-02 11:11:29 +01:00 committed by Jonathan Corbet
parent 6a5d7320fb
commit 02bba8ca90
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
scripts/sphinx-pre-install
View File

@ -902,6 +902,10 @@ sub recommend_sphinx_version($)
$need = $old_need;
$optional = $old_optional;
printf "\n Please note that Sphinx >= 3.0 will currently produce false-positive\n";
printf " warning when the same name is used for more than one type (functions,\n";
printf " structs, enums,...). This is known Sphinx bug. For more details, see:\n";
printf "\thttps://github.com/sphinx-doc/sphinx/pull/8313\n";
}
sub check_needs()