summaryrefslogtreecommitdiff
path: root/scripts/sphinx-pre-install
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2020-04-21 16:31:08 +0200
committerJonathan Corbet <corbet@lwn.net>2020-04-28 12:52:02 -0600
commit412b09ddadd34e9be0d9a26e6de252361fafc237 (patch)
treec7f6b6aafd6609fe13e9cb902abc7afa1950827c /scripts/sphinx-pre-install
parent2834a7412bb1a74722231d7198518f9456279156 (diff)
downloadlwn-412b09ddadd34e9be0d9a26e6de252361fafc237.tar.gz
lwn-412b09ddadd34e9be0d9a26e6de252361fafc237.zip
scripts: sphinx-pre-install: fix a bug when using with venv
When python3 creates a venv, it adds python into it! This causes any upgrade recommendation to look like this: /devel/v4l/docs/sphinx_1.7.9/bin/python3 -m venv sphinx_2.4.4 . sphinx_2.4.4/bin/activate pip install -r ./Documentation/sphinx/requirements.txt With is wrong (and it may not work). So, when recomending an upgrade, exclude the venv dir from the search path, and get the system's python. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/aa622ff71bebf6960fc0262fb90e7ebc7a999a02.1587478901.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts/sphinx-pre-install')
-rwxr-xr-xscripts/sphinx-pre-install20
1 files changed, 20 insertions, 0 deletions
diff --git a/scripts/sphinx-pre-install b/scripts/sphinx-pre-install
index 938b65d40fc8..987aebf7e3a0 100755
--- a/scripts/sphinx-pre-install
+++ b/scripts/sphinx-pre-install
@@ -148,6 +148,24 @@ sub findprog($)
}
}
+sub find_python_no_venv()
+{
+ my $prog = shift;
+
+ my $cur_dir = qx(pwd);
+ $cur_dir =~ s/\s+$//;
+
+ foreach my $dir (split(/:/, $ENV{PATH})) {
+ next if ($dir =~ m,($cur_dir)/sphinx,);
+ return "$dir/python3" if(-x "$dir/python3");
+ }
+ foreach my $dir (split(/:/, $ENV{PATH})) {
+ next if ($dir =~ m,($cur_dir)/sphinx,);
+ return "$dir/python" if(-x "$dir/python");
+ }
+ return "python";
+}
+
sub check_program($$)
{
my $prog = shift;
@@ -814,6 +832,8 @@ sub check_needs()
print "To upgrade Sphinx, use:\n\n" if ($rec_sphinx_upgrade);
+ $python_cmd = find_python_no_venv();
+
if ($need_venv) {
printf "\t$python_cmd -m venv $virtenv_dir\n";
} else {