Merge tag 'dma-mapping-5.3' of git://git.infradead.org/users/hch/dma-mapping

[linux.git] / scripts / sphinx-pre-install

diff --git a/scripts/sphinx-pre-install b/scripts/sphinx-pre-install
index 9be208db88d3a8647fb7c01b8ae785f33e673510..f230e65329a293a6cec6f32fc6aad412e728fdf9 100755 (executable)
--- a/scripts/sphinx-pre-install
+++ b/scripts/sphinx-pre-install
@@ -2,11 +2,15 @@
 # SPDX-License-Identifier: GPL-2.0-or-later
 use strict;
 
-# Copyright (c) 2017 Mauro Carvalho Chehab <mchehab@kernel.org>
+# Copyright (c) 2017-2019 Mauro Carvalho Chehab <mchehab@kernel.org>
 #
 
-my $conf = "Documentation/conf.py";
-my $requirement_file = "Documentation/sphinx/requirements.txt";
+my $prefix = "./";
+$prefix = "$ENV{'srctree'}/" if ($ENV{'srctree'});
+
+my $conf = $prefix . "Documentation/conf.py";
+my $requirement_file = $prefix . "Documentation/sphinx/requirements.txt";
+my $virtenv_prefix = "sphinx_";
 
 #
 # Static vars
@@ -20,7 +24,8 @@ my $need_symlink = 0;
 my $need_sphinx = 0;
 my $rec_sphinx_upgrade = 0;
 my $install = "";
-my $virtenv_dir = "sphinx_";
+my $virtenv_dir = "";
+my $min_version;
 
 #
 # Command line arguments
@@ -28,6 +33,7 @@ my $virtenv_dir = "sphinx_";
 
 my $pdf = 1;
 my $virtualenv = 1;
+my $version_check = 0;
 
 #
 # List of required texlive packages on Fedora and OpenSuse
@@ -221,7 +227,6 @@ sub get_sphinx_fname()
 
 sub check_sphinx()
 {
-       my $min_version;
        my $rec_version;
        my $cur_version;
 
@@ -247,7 +252,7 @@ sub check_sphinx()
 
        die "Can't get recommended sphinx version from $requirement_file" if (!$min_version);
 
-       $virtenv_dir .= $rec_version;
+       $virtenv_dir = $virtenv_prefix . $rec_version;
 
        my $sphinx = get_sphinx_fname();
        return if ($sphinx eq "");
@@ -268,20 +273,22 @@ sub check_sphinx()
 
        die "$sphinx didn't return its version" if (!$cur_version);
 
-       printf "Sphinx version %s (minimal: %s, recommended >= %s)\n",
-               $cur_version, $min_version, $rec_version;
-
        if ($cur_version lt $min_version) {
-               print "Warning: Sphinx version should be >= $min_version\n\n";
+               printf "ERROR: Sphinx version is %s. It should be >= %s (recommended >= %s)\n",
+                      $cur_version, $min_version, $rec_version;;
                $need_sphinx = 1;
                return;
        }
 
        if ($cur_version lt $rec_version) {
+               printf "Sphinx version %s\n", $cur_version;
                print "Warning: It is recommended at least Sphinx version $rec_version.\n";
-               print "         To upgrade, use:\n\n";
                $rec_sphinx_upgrade = 1;
+               return;
        }
+
+       # On version check mode, just assume Sphinx has all mandatory deps
+       exit (0) if ($version_check);
 }
 
 #
@@ -566,27 +573,18 @@ sub check_distros()
 
 sub check_needs()
 {
+       # Check for needed programs/tools
+       check_sphinx();
+
        if ($system_release) {
-               print "Detected OS: $system_release.\n";
+               print "Detected OS: $system_release.\n\n";
        } else {
-               print "Unknown OS\n";
+               print "Unknown OS\n\n";
        }
 
-       # RHEL 7.x and clones have Sphinx version 1.1.x and incomplete texlive
-       if (($system_release =~ /Red Hat Enterprise Linux/) ||
-           ($system_release =~ /CentOS/) ||
-           ($system_release =~ /Scientific Linux/) ||
-           ($system_release =~ /Oracle Linux Server/)) {
-               $virtualenv = 1;
-               $pdf = 0;
-
-               printf("NOTE: On this distro, Sphinx and TexLive shipped versions are incompatible\n");
-               printf("with doc build. So, use Sphinx via a Python virtual environment.\n\n");
-               printf("This script can't install a TexLive version that would provide PDF.\n");
-       }
+       print "To upgrade Sphinx, use:\n\n" if ($rec_sphinx_upgrade);
 
        # Check for needed programs/tools
-       check_sphinx();
        check_perl_module("Pod::Usage", 0);
        check_program("make", 0);
        check_program("gcc", 0);
@@ -604,18 +602,24 @@ sub check_needs()
                       which("sphinx-build-3");
        }
        if ($need_sphinx || $rec_sphinx_upgrade) {
-               my $activate = "$virtenv_dir/bin/activate";
-               if (-e "$ENV{'PWD'}/$activate") {
-                       printf "\nNeed to activate virtualenv with:\n";
-                       printf "\t. $activate\n";
+               my $min_activate = "$ENV{'PWD'}/${virtenv_prefix}${min_version}/bin/activate";
+               my @activates = glob "$ENV{'PWD'}/${virtenv_prefix}*/bin/activate";
+
+               @activates = sort {$b cmp $a} @activates;
+
+               if ($need_sphinx && scalar @activates > 0 && $activates[0] ge $min_activate) {
+                       printf "\nNeed to activate a compatible Sphinx version on virtualenv with:\n";
+                       printf "\t. $activates[0]\n";
+                       exit (1);
                } else {
+                       my $rec_activate = "$virtenv_dir/bin/activate";
                        my $virtualenv = findprog("virtualenv-3");
                        $virtualenv = findprog("virtualenv-3.5") if (!$virtualenv);
                        $virtualenv = findprog("virtualenv") if (!$virtualenv);
                        $virtualenv = "virtualenv" if (!$virtualenv);
 
                        printf "\t$virtualenv $virtenv_dir\n";
-                       printf "\t. $activate\n";
+                       printf "\t. $rec_activate\n";
                        printf "\tpip install -r $requirement_file\n";
 
                        $need++ if (!$rec_sphinx_upgrade);
@@ -623,7 +627,7 @@ sub check_needs()
        }
        printf "\n";
 
-       print "All optional dependenties are met.\n" if (!$optional);
+       print "All optional dependencies are met.\n" if (!$optional);
 
        if ($need == 1) {
                die "Can't build as $need mandatory dependency is missing";
@@ -645,8 +649,14 @@ while (@ARGV) {
                $virtualenv = 0;
        } elsif ($arg eq "--no-pdf"){
                $pdf = 0;
+       } elsif ($arg eq "--version-check"){
+               $version_check = 1;
        } else {
-               print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf>\n\n";
+               print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf> <--version-check>\n\n";
+               print "Where:\n";
+               print "\t--no-virtualenv\t- Recommend installing Sphinx instead of using a virtualenv\n";
+               print "\t--version-check\t- if version is compatible, don't check for missing dependencies\n";
+               print "\t--no-pdf\t- don't check for dependencies required to build PDF docs\n\n";
                exit -1;
        }
 }