Messages in this thread Patch in this message | | | From | Mauro Carvalho Chehab <> | Subject | [PATCH v2 5/5] scripts: sphinx-pre-install: place a warning for Sphinx >= 3.0 | Date | Sat, 2 Jul 2022 11:11:29 +0100 |
| |
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> ---
To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover. See [PATCH v2 0/5] at: https://lore.kernel.org/all/cover.1656756450.git.mchehab@kernel.org/
scripts/sphinx-pre-install | 4 ++++ 1 file changed, 4 insertions(+)
diff --git a/scripts/sphinx-pre-install b/scripts/sphinx-pre-install index 106d75425d3f..271c4eb1d702 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() -- 2.36.1
| |