summaryrefslogtreecommitdiff
path: root/scripts/sphinx-pre-install
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@kernel.org>2022-07-02 13:11:29 +0300
committerJonathan Corbet <corbet@lwn.net>2022-07-07 21:47:34 +0300
commit02bba8ca90b1877ae47400c31002ceb498b0dd9f (patch)
treebf10a18564bdc598c376163acfa0cf2906f6b7cc /scripts/sphinx-pre-install
parent6a5d7320fb75af071cde628e82ebc938575a2fd6 (diff)
downloadlinux-02bba8ca90b1877ae47400c31002ceb498b0dd9f.tar.xz
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 <mchehab@kernel.org> Link: https://lore.kernel.org/r/085e0ada65c11da9303d07e70c510dc45f21315b.1656756450.git.mchehab@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts/sphinx-pre-install')
-rwxr-xr-xscripts/sphinx-pre-install4
1 files changed, 4 insertions, 0 deletions
diff --git a/scripts/sphinx-pre-install b/scripts/sphinx-pre-install
index b9b7d5e301f4..ec84fc62774e 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()