~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/scripts/sphinx-pre-install

Version: ~ [ linux-6.12-rc7 ] ~ [ linux-6.11.7 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.60 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.116 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.171 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.229 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.285 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.323 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.12 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

Diff markup

Differences between /scripts/sphinx-pre-install (Version linux-6.12-rc7) and /scripts/sphinx-pre-install (Version linux-5.3.18)


  1 #!/usr/bin/env perl                            !!   1 #!/usr/bin/perl
  2 # SPDX-License-Identifier: GPL-2.0-or-later         2 # SPDX-License-Identifier: GPL-2.0-or-later
  3 use strict;                                         3 use strict;
  4                                                     4 
  5 # Copyright (c) 2017-2020 Mauro Carvalho Cheha< !!   5 # Copyright (c) 2017-2019 Mauro Carvalho Chehab <mchehab@kernel.org>
  6 #                                                   6 #
  7                                                     7 
  8 my $prefix = "./";                                  8 my $prefix = "./";
  9 $prefix = "$ENV{'srctree'}/" if ($ENV{'srctree      9 $prefix = "$ENV{'srctree'}/" if ($ENV{'srctree'});
 10                                                    10 
 11 my $conf = $prefix . "Documentation/conf.py";      11 my $conf = $prefix . "Documentation/conf.py";
 12 my $requirement_file = $prefix . "Documentatio     12 my $requirement_file = $prefix . "Documentation/sphinx/requirements.txt";
 13 my $virtenv_prefix = "sphinx_";                    13 my $virtenv_prefix = "sphinx_";
 14                                                    14 
 15 #                                                  15 #
 16 # Static vars                                      16 # Static vars
 17 #                                                  17 #
 18                                                    18 
 19 my %missing;                                       19 my %missing;
 20 my $system_release;                                20 my $system_release;
 21 my $need = 0;                                      21 my $need = 0;
 22 my $optional = 0;                                  22 my $optional = 0;
 23 my $need_symlink = 0;                              23 my $need_symlink = 0;
 24 my $need_sphinx = 0;                               24 my $need_sphinx = 0;
 25 my $need_pip = 0;                              << 
 26 my $need_virtualenv = 0;                       << 
 27 my $rec_sphinx_upgrade = 0;                        25 my $rec_sphinx_upgrade = 0;
 28 my $verbose_warn_install = 1;                  << 
 29 my $install = "";                                  26 my $install = "";
 30 my $virtenv_dir = "";                              27 my $virtenv_dir = "";
 31 my $python_cmd = "";                           << 
 32 my $activate_cmd;                              << 
 33 my $min_version;                                   28 my $min_version;
 34 my $cur_version;                               << 
 35 my $rec_version = "3.4.3";                     << 
 36 my $latest_avail_ver;                          << 
 37                                                    29 
 38 #                                                  30 #
 39 # Command line arguments                           31 # Command line arguments
 40 #                                                  32 #
 41                                                    33 
 42 my $pdf = 1;                                       34 my $pdf = 1;
 43 my $virtualenv = 1;                                35 my $virtualenv = 1;
 44 my $version_check = 0;                             36 my $version_check = 0;
 45                                                    37 
 46 #                                                  38 #
 47 # List of required texlive packages on Fedora      39 # List of required texlive packages on Fedora and OpenSuse
 48 #                                                  40 #
 49                                                    41 
 50 my %texlive = (                                    42 my %texlive = (
 51         'amsfonts.sty'       => 'texlive-amsfo     43         'amsfonts.sty'       => 'texlive-amsfonts',
 52         'amsmath.sty'        => 'texlive-amsma     44         'amsmath.sty'        => 'texlive-amsmath',
 53         'amssymb.sty'        => 'texlive-amsfo     45         'amssymb.sty'        => 'texlive-amsfonts',
 54         'amsthm.sty'         => 'texlive-amscl     46         'amsthm.sty'         => 'texlive-amscls',
 55         'anyfontsize.sty'    => 'texlive-anyfo     47         'anyfontsize.sty'    => 'texlive-anyfontsize',
 56         'atbegshi.sty'       => 'texlive-oberd     48         'atbegshi.sty'       => 'texlive-oberdiek',
 57         'bm.sty'             => 'texlive-tools     49         'bm.sty'             => 'texlive-tools',
 58         'capt-of.sty'        => 'texlive-capt-     50         'capt-of.sty'        => 'texlive-capt-of',
 59         'cmap.sty'           => 'texlive-cmap'     51         'cmap.sty'           => 'texlive-cmap',
 60         'ecrm1000.tfm'       => 'texlive-ec',      52         'ecrm1000.tfm'       => 'texlive-ec',
 61         'eqparbox.sty'       => 'texlive-eqpar     53         'eqparbox.sty'       => 'texlive-eqparbox',
 62         'eu1enc.def'         => 'texlive-euenc     54         'eu1enc.def'         => 'texlive-euenc',
 63         'fancybox.sty'       => 'texlive-fancy     55         'fancybox.sty'       => 'texlive-fancybox',
 64         'fancyvrb.sty'       => 'texlive-fancy     56         'fancyvrb.sty'       => 'texlive-fancyvrb',
 65         'float.sty'          => 'texlive-float     57         'float.sty'          => 'texlive-float',
 66         'fncychap.sty'       => 'texlive-fncyc     58         'fncychap.sty'       => 'texlive-fncychap',
 67         'footnote.sty'       => 'texlive-mdwto     59         'footnote.sty'       => 'texlive-mdwtools',
 68         'framed.sty'         => 'texlive-frame     60         'framed.sty'         => 'texlive-framed',
 69         'luatex85.sty'       => 'texlive-luate     61         'luatex85.sty'       => 'texlive-luatex85',
 70         'multirow.sty'       => 'texlive-multi     62         'multirow.sty'       => 'texlive-multirow',
 71         'needspace.sty'      => 'texlive-needs     63         'needspace.sty'      => 'texlive-needspace',
 72         'palatino.sty'       => 'texlive-psnfs     64         'palatino.sty'       => 'texlive-psnfss',
 73         'parskip.sty'        => 'texlive-parsk     65         'parskip.sty'        => 'texlive-parskip',
 74         'polyglossia.sty'    => 'texlive-polyg     66         'polyglossia.sty'    => 'texlive-polyglossia',
 75         'tabulary.sty'       => 'texlive-tabul     67         'tabulary.sty'       => 'texlive-tabulary',
 76         'threeparttable.sty' => 'texlive-three     68         'threeparttable.sty' => 'texlive-threeparttable',
 77         'titlesec.sty'       => 'texlive-title     69         'titlesec.sty'       => 'texlive-titlesec',
 78         'ucs.sty'            => 'texlive-ucs',     70         'ucs.sty'            => 'texlive-ucs',
 79         'upquote.sty'        => 'texlive-upquo     71         'upquote.sty'        => 'texlive-upquote',
 80         'wrapfig.sty'        => 'texlive-wrapf     72         'wrapfig.sty'        => 'texlive-wrapfig',
 81         'ctexhook.sty'       => 'texlive-ctex' << 
 82 );                                                 73 );
 83                                                    74 
 84 #                                                  75 #
 85 # Subroutines that checks if a feature exists      76 # Subroutines that checks if a feature exists
 86 #                                                  77 #
 87                                                    78 
 88 sub check_missing(%)                               79 sub check_missing(%)
 89 {                                                  80 {
 90         my %map = %{$_[0]};                        81         my %map = %{$_[0]};
 91                                                    82 
 92         foreach my $prog (sort keys %missing)      83         foreach my $prog (sort keys %missing) {
 93                 my $is_optional = $missing{$pr     84                 my $is_optional = $missing{$prog};
 94                                                    85 
 95                 # At least on some LTS distros     86                 # At least on some LTS distros like CentOS 7, texlive doesn't
 96                 # provide all packages we need     87                 # provide all packages we need. When such distros are
 97                 # detected, we have to disable     88                 # detected, we have to disable PDF output.
 98                 #                                  89                 #
 99                 # So, we need to ignore the pa     90                 # So, we need to ignore the packages that distros would
100                 # need for LaTeX to work           91                 # need for LaTeX to work
101                 if ($is_optional == 2 && !$pdf     92                 if ($is_optional == 2 && !$pdf) {
102                         $optional--;               93                         $optional--;
103                         next;                      94                         next;
104                 }                                  95                 }
105                                                    96 
106                 if ($verbose_warn_install) {   !!  97                 if ($is_optional) {
107                         if ($is_optional) {    !!  98                         print "Warning: better to also install \"$prog\".\n";
108                                 print "Warning !!  99                 } else {
109                         } else {               !! 100                         print "ERROR: please install \"$prog\", otherwise, build won't work.\n";
110                                 print "ERROR:  << 
111                         }                      << 
112                 }                                 101                 }
113                 if (defined($map{$prog})) {       102                 if (defined($map{$prog})) {
114                         $install .= " " . $map    103                         $install .= " " . $map{$prog};
115                 } else {                          104                 } else {
116                         $install .= " " . $pro    105                         $install .= " " . $prog;
117                 }                                 106                 }
118         }                                         107         }
119                                                   108 
120         $install =~ s/^\s//;                      109         $install =~ s/^\s//;
121 }                                                 110 }
122                                                   111 
123 sub add_package($$)                               112 sub add_package($$)
124 {                                                 113 {
125         my $package = shift;                      114         my $package = shift;
126         my $is_optional = shift;                  115         my $is_optional = shift;
127                                                   116 
128         $missing{$package} = $is_optional;        117         $missing{$package} = $is_optional;
129         if ($is_optional) {                       118         if ($is_optional) {
130                 $optional++;                      119                 $optional++;
131         } else {                                  120         } else {
132                 $need++;                          121                 $need++;
133         }                                         122         }
134 }                                                 123 }
135                                                   124 
136 sub check_missing_file($$$)                       125 sub check_missing_file($$$)
137 {                                                 126 {
138         my $files = shift;                     !! 127         my $file = shift;
139         my $package = shift;                      128         my $package = shift;
140         my $is_optional = shift;                  129         my $is_optional = shift;
141                                                   130 
142         for (@$files) {                        !! 131         return if(-e $file);
143                 return if(-e $_);              << 
144         }                                      << 
145                                                   132 
146         add_package($package, $is_optional);      133         add_package($package, $is_optional);
147 }                                                 134 }
148                                                   135 
149 sub findprog($)                                   136 sub findprog($)
150 {                                                 137 {
151         foreach(split(/:/, $ENV{PATH})) {         138         foreach(split(/:/, $ENV{PATH})) {
152                 return "$_/$_[0]" if(-x "$_/$_    139                 return "$_/$_[0]" if(-x "$_/$_[0]");
153         }                                         140         }
154 }                                                 141 }
155                                                   142 
156 sub find_python_no_venv()                      << 
157 {                                              << 
158         my $prog = shift;                      << 
159                                                << 
160         my $cur_dir = qx(pwd);                 << 
161         $cur_dir =~ s/\s+$//;                  << 
162                                                << 
163         foreach my $dir (split(/:/, $ENV{PATH} << 
164                 next if ($dir =~ m,($cur_dir)/ << 
165                 return "$dir/python3" if(-x "$ << 
166         }                                      << 
167         foreach my $dir (split(/:/, $ENV{PATH} << 
168                 next if ($dir =~ m,($cur_dir)/ << 
169                 return "$dir/python" if(-x "$d << 
170         }                                      << 
171         return "python";                       << 
172 }                                              << 
173                                                << 
174 sub check_program($$)                             143 sub check_program($$)
175 {                                                 144 {
176         my $prog = shift;                         145         my $prog = shift;
177         my $is_optional = shift;                  146         my $is_optional = shift;
178                                                   147 
179         return $prog if findprog($prog);       !! 148         return if findprog($prog);
180                                                   149 
181         add_package($prog, $is_optional);         150         add_package($prog, $is_optional);
182 }                                                 151 }
183                                                   152 
184 sub check_perl_module($$)                         153 sub check_perl_module($$)
185 {                                                 154 {
186         my $prog = shift;                         155         my $prog = shift;
187         my $is_optional = shift;                  156         my $is_optional = shift;
188                                                   157 
189         my $err = system("perl -M$prog -e 1 2>    158         my $err = system("perl -M$prog -e 1 2>/dev/null /dev/null");
190         return if ($err == 0);                    159         return if ($err == 0);
191                                                   160 
192         add_package($prog, $is_optional);         161         add_package($prog, $is_optional);
193 }                                                 162 }
194                                                   163 
195 sub check_python_module($$)                       164 sub check_python_module($$)
196 {                                                 165 {
197         my $prog = shift;                         166         my $prog = shift;
198         my $is_optional = shift;                  167         my $is_optional = shift;
199                                                   168 
200         return if (!$python_cmd);              !! 169         my $err = system("python3 -c 'import $prog' 2>/dev/null /dev/null");
201                                                !! 170         return if ($err == 0);
202         my $err = system("$python_cmd -c 'impo !! 171         my $err = system("python -c 'import $prog' 2>/dev/null /dev/null");
203         return if ($err == 0);                    172         return if ($err == 0);
204                                                   173 
205         add_package($prog, $is_optional);         174         add_package($prog, $is_optional);
206 }                                                 175 }
207                                                   176 
208 sub check_rpm_missing($$)                         177 sub check_rpm_missing($$)
209 {                                                 178 {
210         my @pkgs = @{$_[0]};                      179         my @pkgs = @{$_[0]};
211         my $is_optional = $_[1];                  180         my $is_optional = $_[1];
212                                                   181 
213         foreach my $prog(@pkgs) {                 182         foreach my $prog(@pkgs) {
214                 my $err = system("rpm -q '$pro    183                 my $err = system("rpm -q '$prog' 2>/dev/null >/dev/null");
215                 add_package($prog, $is_optiona    184                 add_package($prog, $is_optional) if ($err);
216         }                                         185         }
217 }                                                 186 }
218                                                   187 
219 sub check_pacman_missing($$)                      188 sub check_pacman_missing($$)
220 {                                                 189 {
221         my @pkgs = @{$_[0]};                      190         my @pkgs = @{$_[0]};
222         my $is_optional = $_[1];                  191         my $is_optional = $_[1];
223                                                   192 
224         foreach my $prog(@pkgs) {                 193         foreach my $prog(@pkgs) {
225                 my $err = system("pacman -Q '$    194                 my $err = system("pacman -Q '$prog' 2>/dev/null >/dev/null");
226                 add_package($prog, $is_optiona    195                 add_package($prog, $is_optional) if ($err);
227         }                                         196         }
228 }                                                 197 }
229                                                   198 
230 sub check_missing_tex($)                          199 sub check_missing_tex($)
231 {                                                 200 {
232         my $is_optional = shift;                  201         my $is_optional = shift;
233         my $kpsewhich = findprog("kpsewhich");    202         my $kpsewhich = findprog("kpsewhich");
234                                                   203 
235         foreach my $prog(keys %texlive) {         204         foreach my $prog(keys %texlive) {
236                 my $package = $texlive{$prog};    205                 my $package = $texlive{$prog};
237                 if (!$kpsewhich) {                206                 if (!$kpsewhich) {
238                         add_package($package,     207                         add_package($package, $is_optional);
239                         next;                     208                         next;
240                 }                                 209                 }
241                 my $file = qx($kpsewhich $prog    210                 my $file = qx($kpsewhich $prog);
242                 add_package($package, $is_opti    211                 add_package($package, $is_optional) if ($file =~ /^\s*$/);
243         }                                         212         }
244 }                                                 213 }
245                                                   214 
246 sub get_sphinx_fname()                            215 sub get_sphinx_fname()
247 {                                                 216 {
248         my $fname = "sphinx-build";               217         my $fname = "sphinx-build";
249         return $fname if findprog($fname);        218         return $fname if findprog($fname);
250                                                   219 
251         $fname = "sphinx-build-3";                220         $fname = "sphinx-build-3";
252         if (findprog($fname)) {                   221         if (findprog($fname)) {
253                 $need_symlink = 1;                222                 $need_symlink = 1;
254                 return $fname;                    223                 return $fname;
255         }                                         224         }
256                                                   225 
                                                   >> 226         if ($virtualenv) {
                                                   >> 227                 my $prog = findprog("virtualenv-3");
                                                   >> 228                 $prog = findprog("virtualenv-3.5") if (!$prog);
                                                   >> 229 
                                                   >> 230                 check_program("virtualenv", 0) if (!$prog);
                                                   >> 231                 $need_sphinx = 1;
                                                   >> 232         } else {
                                                   >> 233                 add_package("python-sphinx", 0);
                                                   >> 234         }
                                                   >> 235 
257         return "";                                236         return "";
258 }                                                 237 }
259                                                   238 
260 sub get_sphinx_version($)                      !! 239 sub check_sphinx()
261 {                                                 240 {
262         my $cmd = shift;                       !! 241         my $rec_version;
263         my $ver;                               !! 242         my $cur_version;
264                                                   243 
265         open IN, "$cmd --version 2>&1 |";      !! 244         open IN, $conf or die "Can't open $conf";
266         while (<IN>) {                            245         while (<IN>) {
267                 if (m/^\s*sphinx-build\s+([\d\ !! 246                 if (m/^\s*needs_sphinx\s*=\s*[\'\"]([\d\.]+)[\'\"]/) {
268                         $ver=$1;               !! 247                         $min_version=$1;
269                         last;                  << 
270                 }                              << 
271                 # Sphinx 1.2.x uses a differen << 
272                 if (m/^\s*Sphinx.*\s+([\d\.]+) << 
273                         $ver=$1;               << 
274                         last;                     248                         last;
275                 }                                 249                 }
276         }                                         250         }
277         close IN;                                 251         close IN;
278         return $ver;                           << 
279 }                                              << 
280                                                   252 
281 sub check_sphinx()                             !! 253         die "Can't get needs_sphinx version from $conf" if (!$min_version);
282 {                                              !! 254 
283         open IN, $conf or die "Can't open $con !! 255         open IN, $requirement_file or die "Can't open $requirement_file";
284         while (<IN>) {                            256         while (<IN>) {
285                 if (m/^\s*needs_sphinx\s*=\s*[ !! 257                 if (m/^\s*Sphinx\s*==\s*([\d\.]+)$/) {
286                         $min_version=$1;       !! 258                         $rec_version=$1;
287                         last;                     259                         last;
288                 }                                 260                 }
289         }                                         261         }
290         close IN;                                 262         close IN;
291                                                   263 
292         die "Can't get needs_sphinx version fr !! 264         die "Can't get recommended sphinx version from $requirement_file" if (!$min_version);
293                                                   265 
294         $virtenv_dir = $virtenv_prefix . "late !! 266         $virtenv_dir = $virtenv_prefix . $rec_version;
295                                                   267 
296         my $sphinx = get_sphinx_fname();          268         my $sphinx = get_sphinx_fname();
297         if ($sphinx eq "") {                   !! 269         return if ($sphinx eq "");
298                 $need_sphinx = 1;              !! 270 
299                 return;                        !! 271         open IN, "$sphinx --version 2>&1 |" or die "$sphinx returned an error";
                                                   >> 272         while (<IN>) {
                                                   >> 273                 if (m/^\s*sphinx-build\s+([\d\.]+)$/) {
                                                   >> 274                         $cur_version=$1;
                                                   >> 275                         last;
                                                   >> 276                 }
                                                   >> 277                 # Sphinx 1.2.x uses a different format
                                                   >> 278                 if (m/^\s*Sphinx.*\s+([\d\.]+)$/) {
                                                   >> 279                         $cur_version=$1;
                                                   >> 280                         last;
                                                   >> 281                 }
300         }                                         282         }
                                                   >> 283         close IN;
301                                                   284 
302         $cur_version = get_sphinx_version($sph << 
303         die "$sphinx didn't return its version    285         die "$sphinx didn't return its version" if (!$cur_version);
304                                                   286 
305         if ($cur_version lt $min_version) {       287         if ($cur_version lt $min_version) {
306                 printf "ERROR: Sphinx version  !! 288                 printf "ERROR: Sphinx version is %s. It should be >= %s (recommended >= %s)\n",
307                        $cur_version, $min_vers !! 289                        $cur_version, $min_version, $rec_version;;
308                 $need_sphinx = 1;                 290                 $need_sphinx = 1;
309                 return;                           291                 return;
310         }                                         292         }
311                                                   293 
312         return if ($cur_version lt $rec_versio !! 294         if ($cur_version lt $rec_version) {
                                                   >> 295                 printf "Sphinx version %s\n", $cur_version;
                                                   >> 296                 print "Warning: It is recommended at least Sphinx version $rec_version.\n";
                                                   >> 297                 $rec_sphinx_upgrade = 1;
                                                   >> 298                 return;
                                                   >> 299         }
313                                                   300 
314         # On version check mode, just assume S    301         # On version check mode, just assume Sphinx has all mandatory deps
315         exit (0) if ($version_check);             302         exit (0) if ($version_check);
316 }                                                 303 }
317                                                   304 
318 #                                                 305 #
319 # Ancillary subroutines                           306 # Ancillary subroutines
320 #                                                 307 #
321                                                   308 
322 sub catcheck($)                                   309 sub catcheck($)
323 {                                                 310 {
324   my $res = "";                                   311   my $res = "";
325   $res = qx(cat $_[0]) if (-r $_[0]);             312   $res = qx(cat $_[0]) if (-r $_[0]);
326   return $res;                                    313   return $res;
327 }                                                 314 }
328                                                   315 
329 sub which($)                                      316 sub which($)
330 {                                                 317 {
331         my $file = shift;                         318         my $file = shift;
332         my @path = split ":", $ENV{PATH};         319         my @path = split ":", $ENV{PATH};
333                                                   320 
334         foreach my $dir(@path) {                  321         foreach my $dir(@path) {
335                 my $name = $dir.'/'.$file;        322                 my $name = $dir.'/'.$file;
336                 return $name if (-x $name );      323                 return $name if (-x $name );
337         }                                         324         }
338         return undef;                             325         return undef;
339 }                                                 326 }
340                                                   327 
341 #                                                 328 #
342 # Subroutines that check distro-specific hints    329 # Subroutines that check distro-specific hints
343 #                                                 330 #
344                                                   331 
345 sub give_debian_hints()                           332 sub give_debian_hints()
346 {                                                 333 {
347         my %map = (                               334         my %map = (
348                 "python-sphinx"         => "py    335                 "python-sphinx"         => "python3-sphinx",
349                 "yaml"                  => "py !! 336                 "sphinx_rtd_theme"      => "python3-sphinx-rtd-theme",
350                 "ensurepip"             => "py << 
351                 "virtualenv"            => "vi    337                 "virtualenv"            => "virtualenv",
352                 "dot"                   => "gr    338                 "dot"                   => "graphviz",
353                 "convert"               => "im    339                 "convert"               => "imagemagick",
354                 "Pod::Usage"            => "pe    340                 "Pod::Usage"            => "perl-modules",
355                 "xelatex"               => "te    341                 "xelatex"               => "texlive-xetex",
356                 "rsvg-convert"          => "li    342                 "rsvg-convert"          => "librsvg2-bin",
357         );                                        343         );
358                                                   344 
359         if ($pdf) {                               345         if ($pdf) {
360                 check_missing_file(["/usr/shar !! 346                 check_missing_file("/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf",
361                                    "texlive-la << 
362                                                << 
363                 check_missing_file(["/usr/shar << 
364                                    "fonts-deja    347                                    "fonts-dejavu", 2);
365                                                   348 
366                 check_missing_file(["/usr/shar !! 349                 check_missing_file("/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc",
367                                     "/usr/shar << 
368                                     "/usr/shar << 
369                                    "fonts-noto    350                                    "fonts-noto-cjk", 2);
370         }                                         351         }
371                                                   352 
372         check_program("dvipng", 2) if ($pdf);     353         check_program("dvipng", 2) if ($pdf);
373         check_missing(\%map);                     354         check_missing(\%map);
374                                                   355 
375         return if (!$need && !$optional);         356         return if (!$need && !$optional);
376         printf("You should run:\n") if ($verbo !! 357         printf("You should run:\n\n\tsudo apt-get install $install\n");
377         printf("\n\tsudo apt-get install $inst << 
378 }                                                 358 }
379                                                   359 
380 sub give_redhat_hints()                           360 sub give_redhat_hints()
381 {                                                 361 {
382         my %map = (                               362         my %map = (
383                 "python-sphinx"         => "py    363                 "python-sphinx"         => "python3-sphinx",
384                 "yaml"                  => "py !! 364                 "sphinx_rtd_theme"      => "python3-sphinx_rtd_theme",
385                 "virtualenv"            => "py    365                 "virtualenv"            => "python3-virtualenv",
386                 "dot"                   => "gr    366                 "dot"                   => "graphviz",
387                 "convert"               => "Im    367                 "convert"               => "ImageMagick",
388                 "Pod::Usage"            => "pe    368                 "Pod::Usage"            => "perl-Pod-Usage",
389                 "xelatex"               => "te    369                 "xelatex"               => "texlive-xetex-bin",
390                 "rsvg-convert"          => "li    370                 "rsvg-convert"          => "librsvg2-tools",
391         );                                        371         );
392                                                   372 
393         my @fedora26_opt_pkgs = (                 373         my @fedora26_opt_pkgs = (
394                 "graphviz-gd",          # Fedo    374                 "graphviz-gd",          # Fedora 26: needed for PDF support
395         );                                        375         );
396                                                   376 
397         my @fedora_tex_pkgs = (                   377         my @fedora_tex_pkgs = (
398                 "texlive-collection-fontsrecom    378                 "texlive-collection-fontsrecommended",
399                 "texlive-collection-latex",       379                 "texlive-collection-latex",
400                 "texlive-xecjk",                  380                 "texlive-xecjk",
401                 "dejavu-sans-fonts",              381                 "dejavu-sans-fonts",
402                 "dejavu-serif-fonts",             382                 "dejavu-serif-fonts",
403                 "dejavu-sans-mono-fonts",         383                 "dejavu-sans-mono-fonts",
404         );                                        384         );
405                                                   385 
406         #                                         386         #
407         # Checks valid for RHEL/CentOS version    387         # Checks valid for RHEL/CentOS version 7.x.
408         #                                         388         #
409         my $old = 0;                              389         my $old = 0;
410         my $rel;                                  390         my $rel;
411         my $noto_sans_redhat = "google-noto-sa << 
412         $rel = $1 if ($system_release =~ /rele    391         $rel = $1 if ($system_release =~ /release\s+(\d+)/);
413                                                   392 
414         if (!($system_release =~ /Fedora/)) {     393         if (!($system_release =~ /Fedora/)) {
415                 $map{"virtualenv"} = "python-v    394                 $map{"virtualenv"} = "python-virtualenv";
416                                                   395 
417                 if ($rel && $rel < 8) {           396                 if ($rel && $rel < 8) {
418                         $old = 1;                 397                         $old = 1;
419                         $pdf = 0;                 398                         $pdf = 0;
420                                                   399 
421                         printf("Note: texlive     400                         printf("Note: texlive packages on RHEL/CENTOS <= 7 are incomplete. Can't support PDF output\n");
422                         printf("If you want to    401                         printf("If you want to build PDF, please read:\n");
423                         printf("\thttps://www.    402                         printf("\thttps://www.systutorials.com/241660/how-to-install-tex-live-on-centos-7-linux/\n");
424                 }                                 403                 }
425         } else {                                  404         } else {
426                 if ($rel && $rel < 26) {          405                 if ($rel && $rel < 26) {
427                         $old = 1;                 406                         $old = 1;
428                 }                                 407                 }
429                 if ($rel && $rel >= 38) {      << 
430                         $noto_sans_redhat = "g << 
431                 }                              << 
432         }                                         408         }
433         if (!$rel) {                              409         if (!$rel) {
434                 printf("Couldn't identify rele    410                 printf("Couldn't identify release number\n");
435                 $old = 1;                         411                 $old = 1;
436                 $pdf = 0;                         412                 $pdf = 0;
437         }                                         413         }
438                                                   414 
439         if ($pdf) {                               415         if ($pdf) {
440                 check_missing_file(["/usr/shar !! 416                 check_missing_file("/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc",
441                                     "/usr/shar !! 417                                    "google-noto-sans-cjk-ttc-fonts", 2);
442                                    $noto_sans_ << 
443         }                                         418         }
444                                                   419 
445         check_rpm_missing(\@fedora26_opt_pkgs,    420         check_rpm_missing(\@fedora26_opt_pkgs, 2) if ($pdf && !$old);
446         check_rpm_missing(\@fedora_tex_pkgs, 2    421         check_rpm_missing(\@fedora_tex_pkgs, 2) if ($pdf);
447         check_missing_tex(2) if ($pdf);           422         check_missing_tex(2) if ($pdf);
448         check_missing(\%map);                     423         check_missing(\%map);
449                                                   424 
450         return if (!$need && !$optional);         425         return if (!$need && !$optional);
451                                                   426 
452         if (!$old) {                              427         if (!$old) {
453                 # dnf, for Fedora 18+             428                 # dnf, for Fedora 18+
454                 printf("You should run:\n") if !! 429                 printf("You should run:\n\n\tsudo dnf install -y $install\n");
455                 printf("\n\tsudo dnf install - << 
456         } else {                                  430         } else {
457                 # yum, for RHEL (and clones) o    431                 # yum, for RHEL (and clones) or Fedora version < 18
458                 printf("You should run:\n") if !! 432                 printf("You should run:\n\n\tsudo yum install -y $install\n");
459                 printf("\n\tsudo yum install - << 
460         }                                         433         }
461 }                                                 434 }
462                                                   435 
463 sub give_opensuse_hints()                         436 sub give_opensuse_hints()
464 {                                                 437 {
465         my %map = (                               438         my %map = (
466                 "python-sphinx"         => "py    439                 "python-sphinx"         => "python3-sphinx",
467                 "yaml"                  => "py !! 440                 "sphinx_rtd_theme"      => "python3-sphinx_rtd_theme",
468                 "virtualenv"            => "py    441                 "virtualenv"            => "python3-virtualenv",
469                 "dot"                   => "gr    442                 "dot"                   => "graphviz",
470                 "convert"               => "Im    443                 "convert"               => "ImageMagick",
471                 "Pod::Usage"            => "pe    444                 "Pod::Usage"            => "perl-Pod-Usage",
472                 "xelatex"               => "te    445                 "xelatex"               => "texlive-xetex-bin",
                                                   >> 446                 "rsvg-convert"          => "rsvg-view",
473         );                                        447         );
474                                                   448 
475         # On Tumbleweed, this package is also  << 
476         $map{"rsvg-convert"} = "rsvg-view" if  << 
477                                                << 
478         my @suse_tex_pkgs = (                     449         my @suse_tex_pkgs = (
479                 "texlive-babel-english",          450                 "texlive-babel-english",
480                 "texlive-caption",                451                 "texlive-caption",
481                 "texlive-colortbl",               452                 "texlive-colortbl",
482                 "texlive-courier",                453                 "texlive-courier",
483                 "texlive-dvips",                  454                 "texlive-dvips",
484                 "texlive-helvetic",               455                 "texlive-helvetic",
485                 "texlive-makeindex",              456                 "texlive-makeindex",
486                 "texlive-metafont",               457                 "texlive-metafont",
487                 "texlive-metapost",               458                 "texlive-metapost",
488                 "texlive-palatino",               459                 "texlive-palatino",
489                 "texlive-preview",                460                 "texlive-preview",
490                 "texlive-times",                  461                 "texlive-times",
491                 "texlive-zapfchan",               462                 "texlive-zapfchan",
492                 "texlive-zapfding",               463                 "texlive-zapfding",
493         );                                        464         );
494                                                   465 
495         $map{"latexmk"} = "texlive-latexmk-bin    466         $map{"latexmk"} = "texlive-latexmk-bin";
496                                                   467 
497         # FIXME: add support for installing CJ    468         # FIXME: add support for installing CJK fonts
498         #                                         469         #
499         # I tried hard, but was unable to find    470         # I tried hard, but was unable to find a way to install
500         # "Noto Sans CJK SC" on openSUSE          471         # "Noto Sans CJK SC" on openSUSE
501                                                   472 
502         check_rpm_missing(\@suse_tex_pkgs, 2)     473         check_rpm_missing(\@suse_tex_pkgs, 2) if ($pdf);
503         check_missing_tex(2) if ($pdf);           474         check_missing_tex(2) if ($pdf);
504         check_missing(\%map);                     475         check_missing(\%map);
505                                                   476 
506         return if (!$need && !$optional);         477         return if (!$need && !$optional);
507         printf("You should run:\n") if ($verbo !! 478         printf("You should run:\n\n\tsudo zypper install --no-recommends $install\n");
508         printf("\n\tsudo zypper install --no-r << 
509 }                                                 479 }
510                                                   480 
511 sub give_mageia_hints()                           481 sub give_mageia_hints()
512 {                                                 482 {
513         my %map = (                               483         my %map = (
514                 "python-sphinx"         => "py    484                 "python-sphinx"         => "python3-sphinx",
515                 "yaml"                  => "py !! 485                 "sphinx_rtd_theme"      => "python3-sphinx_rtd_theme",
516                 "virtualenv"            => "py    486                 "virtualenv"            => "python3-virtualenv",
517                 "dot"                   => "gr    487                 "dot"                   => "graphviz",
518                 "convert"               => "Im    488                 "convert"               => "ImageMagick",
519                 "Pod::Usage"            => "pe    489                 "Pod::Usage"            => "perl-Pod-Usage",
520                 "xelatex"               => "te    490                 "xelatex"               => "texlive",
521                 "rsvg-convert"          => "li !! 491                 "rsvg-convert"          => "librsvg2-tools",
522         );                                        492         );
523                                                   493 
524         my @tex_pkgs = (                          494         my @tex_pkgs = (
525                 "texlive-fontsextra",             495                 "texlive-fontsextra",
526         );                                        496         );
527                                                   497 
528         $map{"latexmk"} = "texlive-collection-    498         $map{"latexmk"} = "texlive-collection-basic";
529                                                   499 
530         my $packager_cmd;                      << 
531         my $noto_sans;                         << 
532         if ($system_release =~ /OpenMandriva/) << 
533                 $packager_cmd = "dnf install"; << 
534                 $noto_sans = "noto-sans-cjk-fo << 
535                 @tex_pkgs = ( "texlive-collect << 
536         } else {                               << 
537                 $packager_cmd = "urpmi";       << 
538                 $noto_sans = "google-noto-sans << 
539         }                                      << 
540                                                << 
541                                                << 
542         if ($pdf) {                               500         if ($pdf) {
543                 check_missing_file(["/usr/shar !! 501                 check_missing_file("/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc",
544                                     "/usr/shar !! 502                                    "google-noto-sans-cjk-ttc-fonts", 2);
545                                    $noto_sans, << 
546         }                                         503         }
547                                                   504 
548         check_rpm_missing(\@tex_pkgs, 2) if ($    505         check_rpm_missing(\@tex_pkgs, 2) if ($pdf);
549         check_missing(\%map);                     506         check_missing(\%map);
550                                                   507 
551         return if (!$need && !$optional);         508         return if (!$need && !$optional);
552         printf("You should run:\n") if ($verbo !! 509         printf("You should run:\n\n\tsudo urpmi $install\n");
553         printf("\n\tsudo $packager_cmd $instal << 
554 }                                                 510 }
555                                                   511 
556 sub give_arch_linux_hints()                       512 sub give_arch_linux_hints()
557 {                                                 513 {
558         my %map = (                               514         my %map = (
559                 "yaml"                  => "py !! 515                 "sphinx_rtd_theme"      => "python-sphinx_rtd_theme",
560                 "virtualenv"            => "py    516                 "virtualenv"            => "python-virtualenv",
561                 "dot"                   => "gr    517                 "dot"                   => "graphviz",
562                 "convert"               => "im    518                 "convert"               => "imagemagick",
563                 "xelatex"               => "te !! 519                 "xelatex"               => "texlive-bin",
564                 "latexmk"               => "te << 
565                 "rsvg-convert"          => "ex    520                 "rsvg-convert"          => "extra/librsvg",
566         );                                        521         );
567                                                   522 
568         my @archlinux_tex_pkgs = (                523         my @archlinux_tex_pkgs = (
569                 "texlive-core",                   524                 "texlive-core",
570                 "texlive-latexextra",             525                 "texlive-latexextra",
571                 "ttf-dejavu",                     526                 "ttf-dejavu",
572         );                                        527         );
573         check_pacman_missing(\@archlinux_tex_p    528         check_pacman_missing(\@archlinux_tex_pkgs, 2) if ($pdf);
574                                                   529 
575         if ($pdf) {                               530         if ($pdf) {
576                 check_missing_file(["/usr/shar !! 531                 check_missing_file("/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc",
577                                    "noto-fonts    532                                    "noto-fonts-cjk", 2);
578         }                                         533         }
579                                                   534 
580         check_missing(\%map);                     535         check_missing(\%map);
581                                                   536 
582         return if (!$need && !$optional);         537         return if (!$need && !$optional);
583         printf("You should run:\n") if ($verbo !! 538         printf("You should run:\n\n\tsudo pacman -S $install\n");
584         printf("\n\tsudo pacman -S $install\n" << 
585 }                                                 539 }
586                                                   540 
587 sub give_gentoo_hints()                           541 sub give_gentoo_hints()
588 {                                                 542 {
589         my %map = (                               543         my %map = (
590                 "yaml"                  => "de !! 544                 "sphinx_rtd_theme"      => "dev-python/sphinx_rtd_theme",
591                 "virtualenv"            => "de    545                 "virtualenv"            => "dev-python/virtualenv",
592                 "dot"                   => "me    546                 "dot"                   => "media-gfx/graphviz",
593                 "convert"               => "me    547                 "convert"               => "media-gfx/imagemagick",
594                 "xelatex"               => "de    548                 "xelatex"               => "dev-texlive/texlive-xetex media-fonts/dejavu",
595                 "rsvg-convert"          => "gn    549                 "rsvg-convert"          => "gnome-base/librsvg",
596         );                                        550         );
597                                                   551 
598         check_missing_file(["/usr/share/fonts/ !! 552         check_missing_file("/usr/share/fonts/dejavu/DejaVuSans.ttf",
599                            "media-fonts/dejavu    553                            "media-fonts/dejavu", 2) if ($pdf);
600                                                   554 
601         if ($pdf) {                               555         if ($pdf) {
602                 check_missing_file(["/usr/shar !! 556                 check_missing_file("/usr/share/fonts/noto-cjk/NotoSansCJKsc-Regular.otf",
603                                     "/usr/shar << 
604                                    "media-font    557                                    "media-fonts/noto-cjk", 2);
605         }                                         558         }
606                                                   559 
607         check_missing(\%map);                     560         check_missing(\%map);
608                                                   561 
609         return if (!$need && !$optional);         562         return if (!$need && !$optional);
610                                                   563 
611         printf("You should run:\n") if ($verbo !! 564         printf("You should run:\n\n");
612         printf("\n");                          << 
613                                                   565 
614         my $imagemagick = "media-gfx/imagemagi    566         my $imagemagick = "media-gfx/imagemagick svg png";
615         my $cairo = "media-gfx/graphviz cairo     567         my $cairo = "media-gfx/graphviz cairo pdf";
616         my $portage_imagemagick = "/etc/portag    568         my $portage_imagemagick = "/etc/portage/package.use/imagemagick";
617         my $portage_cairo = "/etc/portage/pack    569         my $portage_cairo = "/etc/portage/package.use/graphviz";
618                                                   570 
619         if (qx(grep imagemagick $portage_image !! 571         if (qx(cat $portage_imagemagick) ne "$imagemagick\n") {
620                 printf("\tsudo su -c 'echo \"$    572                 printf("\tsudo su -c 'echo \"$imagemagick\" > $portage_imagemagick'\n")
621         }                                         573         }
622         if (qx(grep graphviz $portage_cairo 2> !! 574         if (qx(cat $portage_cairo) ne  "$cairo\n") {
623                 printf("\tsudo su -c 'echo \"$    575                 printf("\tsudo su -c 'echo \"$cairo\" > $portage_cairo'\n");
624         }                                         576         }
625                                                   577 
626         printf("\tsudo emerge --ask $install\n    578         printf("\tsudo emerge --ask $install\n");
627                                                   579 
628 }                                                 580 }
629                                                   581 
630 sub check_distros()                               582 sub check_distros()
631 {                                                 583 {
632         # Distro-specific hints                   584         # Distro-specific hints
633         if ($system_release =~ /Red Hat Enterp    585         if ($system_release =~ /Red Hat Enterprise Linux/) {
634                 give_redhat_hints;                586                 give_redhat_hints;
635                 return;                           587                 return;
636         }                                         588         }
637         if ($system_release =~ /CentOS/) {        589         if ($system_release =~ /CentOS/) {
638                 give_redhat_hints;                590                 give_redhat_hints;
639                 return;                           591                 return;
640         }                                         592         }
641         if ($system_release =~ /Scientific Lin    593         if ($system_release =~ /Scientific Linux/) {
642                 give_redhat_hints;                594                 give_redhat_hints;
643                 return;                           595                 return;
644         }                                         596         }
645         if ($system_release =~ /Oracle Linux S    597         if ($system_release =~ /Oracle Linux Server/) {
646                 give_redhat_hints;                598                 give_redhat_hints;
647                 return;                           599                 return;
648         }                                         600         }
649         if ($system_release =~ /Fedora/) {        601         if ($system_release =~ /Fedora/) {
650                 give_redhat_hints;                602                 give_redhat_hints;
651                 return;                           603                 return;
652         }                                         604         }
653         if ($system_release =~ /Ubuntu/) {        605         if ($system_release =~ /Ubuntu/) {
654                 give_debian_hints;                606                 give_debian_hints;
655                 return;                           607                 return;
656         }                                         608         }
657         if ($system_release =~ /Debian/) {        609         if ($system_release =~ /Debian/) {
658                 give_debian_hints;                610                 give_debian_hints;
659                 return;                           611                 return;
660         }                                         612         }
661         if ($system_release =~ /openSUSE/) {      613         if ($system_release =~ /openSUSE/) {
662                 give_opensuse_hints;              614                 give_opensuse_hints;
663                 return;                           615                 return;
664         }                                         616         }
665         if ($system_release =~ /Mageia/) {        617         if ($system_release =~ /Mageia/) {
666                 give_mageia_hints;                618                 give_mageia_hints;
667                 return;                           619                 return;
668         }                                         620         }
669         if ($system_release =~ /OpenMandriva/) << 
670                 give_mageia_hints;             << 
671                 return;                        << 
672         }                                      << 
673         if ($system_release =~ /Arch Linux/) {    621         if ($system_release =~ /Arch Linux/) {
674                 give_arch_linux_hints;            622                 give_arch_linux_hints;
675                 return;                           623                 return;
676         }                                         624         }
677         if ($system_release =~ /Gentoo/) {        625         if ($system_release =~ /Gentoo/) {
678                 give_gentoo_hints;                626                 give_gentoo_hints;
679                 return;                           627                 return;
680         }                                         628         }
681                                                   629 
682         #                                         630         #
683         # Fall-back to generic hint code for o    631         # Fall-back to generic hint code for other distros
684         # That's far from ideal, specially for    632         # That's far from ideal, specially for LaTeX dependencies.
685         #                                         633         #
686         my %map = (                               634         my %map = (
687                 "sphinx-build" => "sphinx"        635                 "sphinx-build" => "sphinx"
688         );                                        636         );
689         check_missing_tex(2) if ($pdf);           637         check_missing_tex(2) if ($pdf);
690         check_missing(\%map);                     638         check_missing(\%map);
691         print "I don't know distro $system_rel    639         print "I don't know distro $system_release.\n";
692         print "So, I can't provide you a hint     640         print "So, I can't provide you a hint with the install procedure.\n";
693         print "There are likely missing depend    641         print "There are likely missing dependencies.\n";
694 }                                                 642 }
695                                                   643 
696 #                                                 644 #
697 # Common dependencies                             645 # Common dependencies
698 #                                                 646 #
699                                                   647 
700 sub deactivate_help()                          << 
701 {                                              << 
702         printf "\n    If you want to exit the  << 
703         printf "\tdeactivate\n";               << 
704 }                                              << 
705                                                << 
706 sub get_virtenv()                              << 
707 {                                              << 
708         my $ver;                               << 
709         my $min_activate = "$ENV{'PWD'}/${virt << 
710         my @activates = glob "$ENV{'PWD'}/${vi << 
711                                                << 
712         @activates = sort {$b cmp $a} @activat << 
713                                                << 
714         foreach my $f (@activates) {           << 
715                 next if ($f lt $min_activate); << 
716                                                << 
717                 my $sphinx_cmd = $f;           << 
718                 $sphinx_cmd =~ s/activate/sphi << 
719                 next if (! -f $sphinx_cmd);    << 
720                                                << 
721                 my $ver = get_sphinx_version($ << 
722                                                << 
723                 if (!$ver) {                   << 
724                         $f =~ s#/bin/activate# << 
725                         print("Warning: virtua << 
726                 }                              << 
727                                                << 
728                 if ($need_sphinx && ($ver ge $ << 
729                         return ($f, $ver);     << 
730                 } elsif ($ver gt $cur_version) << 
731                         return ($f, $ver);     << 
732                 }                              << 
733         }                                      << 
734         return ("", "");                       << 
735 }                                              << 
736                                                << 
737 sub recommend_sphinx_upgrade()                 << 
738 {                                              << 
739         my $venv_ver;                          << 
740                                                << 
741         # Avoid running sphinx-builds from ven << 
742         if ($cur_version && ($cur_version ge $ << 
743                 $latest_avail_ver = $cur_versi << 
744                 return;                        << 
745         }                                      << 
746                                                << 
747         # Get the highest version from sphinx_ << 
748         # corresponding command to activate th << 
749         ($activate_cmd, $venv_ver) = get_virte << 
750                                                << 
751         # Store the highest version from Sphin << 
752         if (($activate_cmd ne "") && ($venv_ve << 
753                 $latest_avail_ver = $venv_ver; << 
754         } else {                               << 
755                 $latest_avail_ver = $cur_versi << 
756         }                                      << 
757                                                << 
758         # As we don't know package version of  << 
759         # virtual environments, don't check if << 
760         if (!$virtualenv) {                    << 
761                 return if (!$latest_avail_ver) << 
762         }                                      << 
763                                                << 
764         # Either there are already a virtual e << 
765         $need_pip = 1;                         << 
766                                                << 
767         return if (!$latest_avail_ver);        << 
768                                                << 
769         # Return if the reason is due to an up << 
770         if ($latest_avail_ver lt $rec_version) << 
771                 $rec_sphinx_upgrade = 1;       << 
772         }                                      << 
773                                                << 
774         return $latest_avail_ver;              << 
775 }                                              << 
776                                                << 
777 #                                              << 
778 # The logic here is complex, as it have to dea << 
779 #       - minimal supported version;           << 
780 #       - minimal PDF version;                 << 
781 #       - recommended version.                 << 
782 # It also needs to work fine with both distro' << 
783 sub recommend_sphinx_version($)                << 
784 {                                              << 
785         my $virtualenv_cmd = shift;            << 
786                                                << 
787         # Version is OK. Nothing to do.        << 
788         if ($cur_version && ($cur_version ge $ << 
789                 return;                        << 
790         };                                     << 
791                                                << 
792         if (!$need_sphinx) {                   << 
793                 # sphinx-build is present and  << 
794                                                << 
795                 #only recommend enabling a new << 
796                 if ($latest_avail_ver gt $cur_ << 
797                         printf "\nYou may also << 
798                         printf "\tdeactivate\n << 
799                         printf "\t. $activate_ << 
800                         deactivate_help();     << 
801                                                << 
802                         return;                << 
803                 }                              << 
804                 return if ($latest_avail_ver g << 
805         }                                      << 
806                                                << 
807         if (!$virtualenv) {                    << 
808                 # No sphinx either via package << 
809                 # Compare the versions here, j << 
810                 # user to install it from the  << 
811                 return if (!$latest_avail_ver) << 
812                                                << 
813                 # User doesn't want a virtenv  << 
814                 # installed one via virtenv wi << 
815                 # So, print commands to enable << 
816                 if ($latest_avail_ver gt $cur_ << 
817                         printf "\nYou may also << 
818                         printf "\tdeactivate\n << 
819                         printf "\t. $activate_ << 
820                         deactivate_help();     << 
821                                                << 
822                         return;                << 
823                 }                              << 
824                 print "\n";                    << 
825         } else {                               << 
826                 $need++ if ($need_sphinx);     << 
827         }                                      << 
828                                                << 
829         # Suggest newer versions if current on << 
830         if ($latest_avail_ver && $latest_avail << 
831                 # If there's a good enough ver << 
832                 if ($latest_avail_ver ge $rec_ << 
833                         printf "\nNeed to acti << 
834                         printf "\t. $activate_ << 
835                         deactivate_help();     << 
836                                                << 
837                         return;                << 
838                 }                              << 
839                                                << 
840                 # Version is above the minimal << 
841                 # below the recommended one. S << 
842                                                << 
843                 if ($latest_avail_ver lt $rec_ << 
844                         print "Warning: It is  << 
845                 }                              << 
846         }                                      << 
847                                                << 
848         # At this point, either it needs Sphin << 
849         # both via pip                         << 
850                                                << 
851         if ($rec_sphinx_upgrade) {             << 
852                 if (!$virtualenv) {            << 
853                         print "Instead of inst << 
854                 } else {                       << 
855                         print "To upgrade Sphi << 
856                 }                              << 
857         } else {                               << 
858                 print "\nSphinx needs to be in << 
859         }                                      << 
860                                                << 
861         $python_cmd = find_python_no_venv();   << 
862                                                << 
863         printf "\t$virtualenv_cmd $virtenv_dir << 
864                                                << 
865         printf "\t. $virtenv_dir/bin/activate\ << 
866         printf "\tpip install -r $requirement_ << 
867         deactivate_help();                     << 
868                                                << 
869         printf "\n2) As a package with:\n";    << 
870                                                << 
871         my $old_need = $need;                  << 
872         my $old_optional = $optional;          << 
873         %missing = ();                         << 
874         $pdf = 0;                              << 
875         $optional = 0;                         << 
876         $install = "";                         << 
877         $verbose_warn_install = 0;             << 
878                                                << 
879         add_package("python-sphinx", 0);       << 
880                                                << 
881         check_distros();                       << 
882                                                << 
883         $need = $old_need;                     << 
884         $optional = $old_optional;             << 
885                                                << 
886         printf "\n    Please note that Sphinx  << 
887         printf "   warning when the same name  << 
888         printf "   structs, enums,...). This i << 
889         printf "\thttps://github.com/sphinx-do << 
890 }                                              << 
891                                                << 
892 sub check_needs()                                 648 sub check_needs()
893 {                                                 649 {
894         # Check if Sphinx is already accessibl !! 650         # Check for needed programs/tools
895         check_sphinx();                           651         check_sphinx();
896                                                   652 
897         if ($system_release) {                    653         if ($system_release) {
898                 print "Detected OS: $system_re !! 654                 print "Detected OS: $system_release.\n\n";
899         } else {                                  655         } else {
900                 print "Unknown OS\n";          !! 656                 print "Unknown OS\n\n";
901         }                                      << 
902         printf "Sphinx version: %s\n\n", $cur_ << 
903                                                << 
904         # Check python command line, trying fi << 
905         $python_cmd = findprog("python3");     << 
906         $python_cmd = check_program("python",  << 
907                                                << 
908         # Check the type of virtual env, depen << 
909         if ($python_cmd) {                     << 
910                 if ($virtualenv) {             << 
911                         my $tmp = qx($python_c << 
912                         if ($tmp =~ m/(\d+\.)( << 
913                                 if ($1 < 3) {  << 
914                                         # Fail << 
915                                         die "P << 
916                                 }              << 
917                                 if ($1 == 3 && << 
918                                         # Need << 
919                                         $need_ << 
920                                 }              << 
921                         } else {               << 
922                                 die "Warning:  << 
923                         }                      << 
924                 } else {                       << 
925                         add_package("python-sp << 
926                 }                              << 
927         }                                         657         }
928                                                   658 
929         my $venv_ver = recommend_sphinx_upgrad !! 659         print "To upgrade Sphinx, use:\n\n" if ($rec_sphinx_upgrade);
930                                                << 
931         my $virtualenv_cmd;                    << 
932                                                << 
933         if ($need_pip) {                       << 
934                 # Set virtualenv command line, << 
935                 if ($need_virtualenv) {        << 
936                         $virtualenv_cmd = find << 
937                         $virtualenv_cmd = find << 
938                         if (!$virtualenv_cmd)  << 
939                                 check_program( << 
940                                 $virtualenv_cm << 
941                         }                      << 
942                 } else {                       << 
943                         $virtualenv_cmd = "$py << 
944                         check_python_module("e << 
945                 }                              << 
946         }                                      << 
947                                                   660 
948         # Check for needed programs/tools         661         # Check for needed programs/tools
949         check_perl_module("Pod::Usage", 0);       662         check_perl_module("Pod::Usage", 0);
950         check_python_module("yaml", 0);        << 
951         check_program("make", 0);                 663         check_program("make", 0);
952         check_program("gcc", 0);                  664         check_program("gcc", 0);
                                                   >> 665         check_python_module("sphinx_rtd_theme", 1) if (!$virtualenv);
953         check_program("dot", 1);                  666         check_program("dot", 1);
954         check_program("convert", 1);              667         check_program("convert", 1);
955                                                   668 
956         # Extra PDF files - should use 2 for i    669         # Extra PDF files - should use 2 for is_optional
957         check_program("xelatex", 2) if ($pdf);    670         check_program("xelatex", 2) if ($pdf);
958         check_program("rsvg-convert", 2) if ($    671         check_program("rsvg-convert", 2) if ($pdf);
959         check_program("latexmk", 2) if ($pdf);    672         check_program("latexmk", 2) if ($pdf);
960                                                   673 
961         # Do distro-specific checks and output << 
962         check_distros();                          674         check_distros();
963                                                   675 
964         if (!$python_cmd) {                    << 
965                 if ($need == 1) {              << 
966                         die "Can't build as $n << 
967                 } elsif ($need) {              << 
968                         die "Can't build as $n << 
969                 }                              << 
970         }                                      << 
971                                                << 
972         # Check if sphinx-build is called sphi << 
973         if ($need_symlink) {                      676         if ($need_symlink) {
974                 printf "\tsudo ln -sf %s /usr/    677                 printf "\tsudo ln -sf %s /usr/bin/sphinx-build\n\n",
975                        which("sphinx-build-3")    678                        which("sphinx-build-3");
976         }                                         679         }
                                                   >> 680         if ($need_sphinx || $rec_sphinx_upgrade) {
                                                   >> 681                 my $min_activate = "$ENV{'PWD'}/${virtenv_prefix}${min_version}/bin/activate";
                                                   >> 682                 my @activates = glob "$ENV{'PWD'}/${virtenv_prefix}*/bin/activate";
                                                   >> 683 
                                                   >> 684                 @activates = sort {$b cmp $a} @activates;
                                                   >> 685 
                                                   >> 686                 if ($need_sphinx && scalar @activates > 0 && $activates[0] ge $min_activate) {
                                                   >> 687                         printf "\nNeed to activate a compatible Sphinx version on virtualenv with:\n";
                                                   >> 688                         printf "\t. $activates[0]\n";
                                                   >> 689                         exit (1);
                                                   >> 690                 } else {
                                                   >> 691                         my $rec_activate = "$virtenv_dir/bin/activate";
                                                   >> 692                         my $virtualenv = findprog("virtualenv-3");
                                                   >> 693                         $virtualenv = findprog("virtualenv-3.5") if (!$virtualenv);
                                                   >> 694                         $virtualenv = findprog("virtualenv") if (!$virtualenv);
                                                   >> 695                         $virtualenv = "virtualenv" if (!$virtualenv);
                                                   >> 696 
                                                   >> 697                         printf "\t$virtualenv $virtenv_dir\n";
                                                   >> 698                         printf "\t. $rec_activate\n";
                                                   >> 699                         printf "\tpip install -r $requirement_file\n";
977                                                   700 
978         recommend_sphinx_version($virtualenv_c !! 701                         $need++ if (!$rec_sphinx_upgrade);
                                                   >> 702                 }
                                                   >> 703         }
979         printf "\n";                              704         printf "\n";
980                                                   705 
981         print "All optional dependencies are m    706         print "All optional dependencies are met.\n" if (!$optional);
982                                                   707 
983         if ($need == 1) {                         708         if ($need == 1) {
984                 die "Can't build as $need mand    709                 die "Can't build as $need mandatory dependency is missing";
985         } elsif ($need) {                         710         } elsif ($need) {
986                 die "Can't build as $need mand    711                 die "Can't build as $need mandatory dependencies are missing";
987         }                                         712         }
988                                                   713 
989         print "Needed package dependencies are    714         print "Needed package dependencies are met.\n";
990 }                                                 715 }
991                                                   716 
992 #                                                 717 #
993 # Main                                            718 # Main
994 #                                                 719 #
995                                                   720 
996 while (@ARGV) {                                   721 while (@ARGV) {
997         my $arg = shift(@ARGV);                   722         my $arg = shift(@ARGV);
998                                                   723 
999         if ($arg eq "--no-virtualenv") {          724         if ($arg eq "--no-virtualenv") {
1000                 $virtualenv = 0;                 725                 $virtualenv = 0;
1001         } elsif ($arg eq "--no-pdf"){            726         } elsif ($arg eq "--no-pdf"){
1002                 $pdf = 0;                        727                 $pdf = 0;
1003         } elsif ($arg eq "--version-check"){     728         } elsif ($arg eq "--version-check"){
1004                 $version_check = 1;              729                 $version_check = 1;
1005         } else {                                 730         } else {
1006                 print "Usage:\n\t$0 <--no-vir    731                 print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf> <--version-check>\n\n";
1007                 print "Where:\n";                732                 print "Where:\n";
1008                 print "\t--no-virtualenv\t- R    733                 print "\t--no-virtualenv\t- Recommend installing Sphinx instead of using a virtualenv\n";
1009                 print "\t--version-check\t- i    734                 print "\t--version-check\t- if version is compatible, don't check for missing dependencies\n";
1010                 print "\t--no-pdf\t- don't ch    735                 print "\t--no-pdf\t- don't check for dependencies required to build PDF docs\n\n";
1011                 exit -1;                         736                 exit -1;
1012         }                                        737         }
1013 }                                                738 }
1014                                                  739 
1015 #                                                740 #
1016 # Determine the system type. There's no stand    741 # Determine the system type. There's no standard unique way that would
1017 # work with all distros with a minimal packag    742 # work with all distros with a minimal package install. So, several
1018 # methods are used here.                         743 # methods are used here.
1019 #                                                744 #
1020 # By default, it will use lsb_release functio    745 # By default, it will use lsb_release function. If not available, it will
1021 # fail back to reading the known different pl    746 # fail back to reading the known different places where the distro name
1022 # is stored                                      747 # is stored
1023 #                                                748 #
1024                                                  749 
1025 $system_release = qx(lsb_release -d) if which    750 $system_release = qx(lsb_release -d) if which("lsb_release");
1026 $system_release =~ s/Description:\s*// if ($s    751 $system_release =~ s/Description:\s*// if ($system_release);
1027 $system_release = catcheck("/etc/system-relea    752 $system_release = catcheck("/etc/system-release") if !$system_release;
1028 $system_release = catcheck("/etc/redhat-relea    753 $system_release = catcheck("/etc/redhat-release") if !$system_release;
1029 $system_release = catcheck("/etc/lsb-release"    754 $system_release = catcheck("/etc/lsb-release") if !$system_release;
1030 $system_release = catcheck("/etc/gentoo-relea    755 $system_release = catcheck("/etc/gentoo-release") if !$system_release;
1031                                               << 
1032 # This seems more common than LSB these days  << 
1033 if (!$system_release) {                       << 
1034         my %os_var;                           << 
1035         if (open IN, "cat /etc/os-release|")  << 
1036                 while (<IN>) {                << 
1037                         if (m/^([\w\d\_]+)=\" << 
1038                                 $os_var{$1}=$ << 
1039                         }                     << 
1040                 }                             << 
1041                 $system_release = $os_var{"NA << 
1042                 if (defined($os_var{"VERSION_ << 
1043                         $system_release .= "  << 
1044                 } else {                      << 
1045                         $system_release .= "  << 
1046                 }                             << 
1047         }                                     << 
1048 }                                             << 
1049 $system_release = catcheck("/etc/issue") if !    756 $system_release = catcheck("/etc/issue") if !$system_release;
1050 $system_release =~ s/\s+$//;                     757 $system_release =~ s/\s+$//;
1051                                                  758 
1052 check_needs;                                     759 check_needs;
                                                      

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php