From: Mauro Carvalho Chehab Date: Sat, 2 Jul 2022 10:11:29 +0000 (+0100) Subject: scripts: sphinx-pre-install: place a warning for Sphinx >= 3.0 X-Git-Tag: v6.0-rc1~161^2~42 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=02bba8ca90b1877ae47400c31002ceb498b0dd9f;p=thirdparty%2Flinux.git scripts: sphinx-pre-install: place a warning for Sphinx >= 3.0 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 Link: https://lore.kernel.org/r/085e0ada65c11da9303d07e70c510dc45f21315b.1656756450.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet --- diff --git a/scripts/sphinx-pre-install b/scripts/sphinx-pre-install index b9b7d5e301f43..ec84fc62774e7 100755 --- a/scripts/sphinx-pre-install +++ b/scripts/sphinx-pre-install @@ -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()