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 $files = 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 for (@$files) {
143 return if(-e $_); 132 return if(-e $_);
144 } 133 }
145 134
146 add_package($package, $is_optional); 135 add_package($package, $is_optional);
147 } 136 }
148 137
149 sub findprog($) 138 sub findprog($)
150 { 139 {
151 foreach(split(/:/, $ENV{PATH})) { 140 foreach(split(/:/, $ENV{PATH})) {
152 return "$_/$_[0]" if(-x "$_/$_ 141 return "$_/$_[0]" if(-x "$_/$_[0]");
153 } 142 }
154 } 143 }
155 144
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($$) 145 sub check_program($$)
175 { 146 {
176 my $prog = shift; 147 my $prog = shift;
177 my $is_optional = shift; 148 my $is_optional = shift;
178 149
179 return $prog if findprog($prog); !! 150 return if findprog($prog);
180 151
181 add_package($prog, $is_optional); 152 add_package($prog, $is_optional);
182 } 153 }
183 154
184 sub check_perl_module($$) 155 sub check_perl_module($$)
185 { 156 {
186 my $prog = shift; 157 my $prog = shift;
187 my $is_optional = shift; 158 my $is_optional = shift;
188 159
189 my $err = system("perl -M$prog -e 1 2> 160 my $err = system("perl -M$prog -e 1 2>/dev/null /dev/null");
190 return if ($err == 0); 161 return if ($err == 0);
191 162
192 add_package($prog, $is_optional); 163 add_package($prog, $is_optional);
193 } 164 }
194 165
195 sub check_python_module($$) 166 sub check_python_module($$)
196 { 167 {
197 my $prog = shift; 168 my $prog = shift;
198 my $is_optional = shift; 169 my $is_optional = shift;
199 170
200 return if (!$python_cmd); !! 171 my $err = system("python3 -c 'import $prog' 2>/dev/null /dev/null");
201 !! 172 return if ($err == 0);
202 my $err = system("$python_cmd -c 'impo !! 173 my $err = system("python -c 'import $prog' 2>/dev/null /dev/null");
203 return if ($err == 0); 174 return if ($err == 0);
204 175
205 add_package($prog, $is_optional); 176 add_package($prog, $is_optional);
206 } 177 }
207 178
208 sub check_rpm_missing($$) 179 sub check_rpm_missing($$)
209 { 180 {
210 my @pkgs = @{$_[0]}; 181 my @pkgs = @{$_[0]};
211 my $is_optional = $_[1]; 182 my $is_optional = $_[1];
212 183
213 foreach my $prog(@pkgs) { 184 foreach my $prog(@pkgs) {
214 my $err = system("rpm -q '$pro 185 my $err = system("rpm -q '$prog' 2>/dev/null >/dev/null");
215 add_package($prog, $is_optiona 186 add_package($prog, $is_optional) if ($err);
216 } 187 }
217 } 188 }
218 189
219 sub check_pacman_missing($$) 190 sub check_pacman_missing($$)
220 { 191 {
221 my @pkgs = @{$_[0]}; 192 my @pkgs = @{$_[0]};
222 my $is_optional = $_[1]; 193 my $is_optional = $_[1];
223 194
224 foreach my $prog(@pkgs) { 195 foreach my $prog(@pkgs) {
225 my $err = system("pacman -Q '$ 196 my $err = system("pacman -Q '$prog' 2>/dev/null >/dev/null");
226 add_package($prog, $is_optiona 197 add_package($prog, $is_optional) if ($err);
227 } 198 }
228 } 199 }
229 200
230 sub check_missing_tex($) 201 sub check_missing_tex($)
231 { 202 {
232 my $is_optional = shift; 203 my $is_optional = shift;
233 my $kpsewhich = findprog("kpsewhich"); 204 my $kpsewhich = findprog("kpsewhich");
234 205
235 foreach my $prog(keys %texlive) { 206 foreach my $prog(keys %texlive) {
236 my $package = $texlive{$prog}; 207 my $package = $texlive{$prog};
237 if (!$kpsewhich) { 208 if (!$kpsewhich) {
238 add_package($package, 209 add_package($package, $is_optional);
239 next; 210 next;
240 } 211 }
241 my $file = qx($kpsewhich $prog 212 my $file = qx($kpsewhich $prog);
242 add_package($package, $is_opti 213 add_package($package, $is_optional) if ($file =~ /^\s*$/);
243 } 214 }
244 } 215 }
245 216
246 sub get_sphinx_fname() 217 sub get_sphinx_fname()
247 { 218 {
248 my $fname = "sphinx-build"; 219 my $fname = "sphinx-build";
249 return $fname if findprog($fname); 220 return $fname if findprog($fname);
250 221
251 $fname = "sphinx-build-3"; 222 $fname = "sphinx-build-3";
252 if (findprog($fname)) { 223 if (findprog($fname)) {
253 $need_symlink = 1; 224 $need_symlink = 1;
254 return $fname; 225 return $fname;
255 } 226 }
256 227
>> 228 if ($virtualenv) {
>> 229 my $prog = findprog("virtualenv-3");
>> 230 $prog = findprog("virtualenv-3.5") if (!$prog);
>> 231
>> 232 check_program("virtualenv", 0) if (!$prog);
>> 233 $need_sphinx = 1;
>> 234 } else {
>> 235 add_package("python-sphinx", 0);
>> 236 }
>> 237
257 return ""; 238 return "";
258 } 239 }
259 240
260 sub get_sphinx_version($) !! 241 sub check_sphinx()
261 { 242 {
262 my $cmd = shift; !! 243 my $rec_version;
263 my $ver; !! 244 my $cur_version;
264 245
265 open IN, "$cmd --version 2>&1 |"; !! 246 open IN, $conf or die "Can't open $conf";
266 while (<IN>) { 247 while (<IN>) {
267 if (m/^\s*sphinx-build\s+([\d\ !! 248 if (m/^\s*needs_sphinx\s*=\s*[\'\"]([\d\.]+)[\'\"]/) {
268 $ver=$1; !! 249 $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; 250 last;
275 } 251 }
276 } 252 }
277 close IN; 253 close IN;
278 return $ver; <<
279 } <<
280 254
281 sub check_sphinx() !! 255 die "Can't get needs_sphinx version from $conf" if (!$min_version);
282 { !! 256
283 open IN, $conf or die "Can't open $con !! 257 open IN, $requirement_file or die "Can't open $requirement_file";
284 while (<IN>) { 258 while (<IN>) {
285 if (m/^\s*needs_sphinx\s*=\s*[ !! 259 if (m/^\s*Sphinx\s*==\s*([\d\.]+)$/) {
286 $min_version=$1; !! 260 $rec_version=$1;
287 last; 261 last;
288 } 262 }
289 } 263 }
290 close IN; 264 close IN;
291 265
292 die "Can't get needs_sphinx version fr !! 266 die "Can't get recommended sphinx version from $requirement_file" if (!$min_version);
293 267
294 $virtenv_dir = $virtenv_prefix . "late !! 268 $virtenv_dir = $virtenv_prefix . $rec_version;
295 269
296 my $sphinx = get_sphinx_fname(); 270 my $sphinx = get_sphinx_fname();
297 if ($sphinx eq "") { !! 271 return if ($sphinx eq "");
298 $need_sphinx = 1; !! 272
299 return; !! 273 open IN, "$sphinx --version 2>&1 |" or die "$sphinx returned an error";
>> 274 while (<IN>) {
>> 275 if (m/^\s*sphinx-build\s+([\d\.]+)(\+\/[\da-f]+)?$/) {
>> 276 $cur_version=$1;
>> 277 last;
>> 278 }
>> 279 # Sphinx 1.2.x uses a different format
>> 280 if (m/^\s*Sphinx.*\s+([\d\.]+)$/) {
>> 281 $cur_version=$1;
>> 282 last;
>> 283 }
300 } 284 }
>> 285 close IN;
301 286
302 $cur_version = get_sphinx_version($sph <<
303 die "$sphinx didn't return its version 287 die "$sphinx didn't return its version" if (!$cur_version);
304 288
305 if ($cur_version lt $min_version) { 289 if ($cur_version lt $min_version) {
306 printf "ERROR: Sphinx version !! 290 printf "ERROR: Sphinx version is %s. It should be >= %s (recommended >= %s)\n",
307 $cur_version, $min_vers !! 291 $cur_version, $min_version, $rec_version;;
308 $need_sphinx = 1; 292 $need_sphinx = 1;
309 return; 293 return;
310 } 294 }
311 295
312 return if ($cur_version lt $rec_versio !! 296 if ($cur_version lt $rec_version) {
>> 297 printf "Sphinx version %s\n", $cur_version;
>> 298 print "Warning: It is recommended at least Sphinx version $rec_version.\n";
>> 299 $rec_sphinx_upgrade = 1;
>> 300 return;
>> 301 }
313 302
314 # On version check mode, just assume S 303 # On version check mode, just assume Sphinx has all mandatory deps
315 exit (0) if ($version_check); 304 exit (0) if ($version_check);
316 } 305 }
317 306
318 # 307 #
319 # Ancillary subroutines 308 # Ancillary subroutines
320 # 309 #
321 310
322 sub catcheck($) 311 sub catcheck($)
323 { 312 {
324 my $res = ""; 313 my $res = "";
325 $res = qx(cat $_[0]) if (-r $_[0]); 314 $res = qx(cat $_[0]) if (-r $_[0]);
326 return $res; 315 return $res;
327 } 316 }
328 317
329 sub which($) 318 sub which($)
330 { 319 {
331 my $file = shift; 320 my $file = shift;
332 my @path = split ":", $ENV{PATH}; 321 my @path = split ":", $ENV{PATH};
333 322
334 foreach my $dir(@path) { 323 foreach my $dir(@path) {
335 my $name = $dir.'/'.$file; 324 my $name = $dir.'/'.$file;
336 return $name if (-x $name ); 325 return $name if (-x $name );
337 } 326 }
338 return undef; 327 return undef;
339 } 328 }
340 329
341 # 330 #
342 # Subroutines that check distro-specific hints 331 # Subroutines that check distro-specific hints
343 # 332 #
344 333
345 sub give_debian_hints() 334 sub give_debian_hints()
346 { 335 {
347 my %map = ( 336 my %map = (
348 "python-sphinx" => "py 337 "python-sphinx" => "python3-sphinx",
349 "yaml" => "py !! 338 "sphinx_rtd_theme" => "python3-sphinx-rtd-theme",
350 "ensurepip" => "py <<
351 "virtualenv" => "vi 339 "virtualenv" => "virtualenv",
352 "dot" => "gr 340 "dot" => "graphviz",
353 "convert" => "im 341 "convert" => "imagemagick",
354 "Pod::Usage" => "pe 342 "Pod::Usage" => "perl-modules",
355 "xelatex" => "te 343 "xelatex" => "texlive-xetex",
356 "rsvg-convert" => "li 344 "rsvg-convert" => "librsvg2-bin",
357 ); 345 );
358 346
359 if ($pdf) { 347 if ($pdf) {
360 check_missing_file(["/usr/shar <<
361 "texlive-la <<
362 <<
363 check_missing_file(["/usr/shar 348 check_missing_file(["/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf"],
364 "fonts-deja 349 "fonts-dejavu", 2);
365 350
366 check_missing_file(["/usr/shar 351 check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc",
367 "/usr/shar !! 352 "/usr/share/fonts/opentype/noto/NotoSerifCJK-Regular.ttc"],
368 "/usr/shar <<
369 "fonts-noto 353 "fonts-noto-cjk", 2);
370 } 354 }
371 355
372 check_program("dvipng", 2) if ($pdf); 356 check_program("dvipng", 2) if ($pdf);
373 check_missing(\%map); 357 check_missing(\%map);
374 358
375 return if (!$need && !$optional); 359 return if (!$need && !$optional);
376 printf("You should run:\n") if ($verbo !! 360 printf("You should run:\n\n\tsudo apt-get install $install\n");
377 printf("\n\tsudo apt-get install $inst <<
378 } 361 }
379 362
380 sub give_redhat_hints() 363 sub give_redhat_hints()
381 { 364 {
382 my %map = ( 365 my %map = (
383 "python-sphinx" => "py 366 "python-sphinx" => "python3-sphinx",
384 "yaml" => "py !! 367 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme",
385 "virtualenv" => "py 368 "virtualenv" => "python3-virtualenv",
386 "dot" => "gr 369 "dot" => "graphviz",
387 "convert" => "Im 370 "convert" => "ImageMagick",
388 "Pod::Usage" => "pe 371 "Pod::Usage" => "perl-Pod-Usage",
389 "xelatex" => "te 372 "xelatex" => "texlive-xetex-bin",
390 "rsvg-convert" => "li 373 "rsvg-convert" => "librsvg2-tools",
391 ); 374 );
392 375
393 my @fedora26_opt_pkgs = ( 376 my @fedora26_opt_pkgs = (
394 "graphviz-gd", # Fedo 377 "graphviz-gd", # Fedora 26: needed for PDF support
395 ); 378 );
396 379
397 my @fedora_tex_pkgs = ( 380 my @fedora_tex_pkgs = (
398 "texlive-collection-fontsrecom 381 "texlive-collection-fontsrecommended",
399 "texlive-collection-latex", 382 "texlive-collection-latex",
400 "texlive-xecjk", 383 "texlive-xecjk",
401 "dejavu-sans-fonts", 384 "dejavu-sans-fonts",
402 "dejavu-serif-fonts", 385 "dejavu-serif-fonts",
403 "dejavu-sans-mono-fonts", 386 "dejavu-sans-mono-fonts",
404 ); 387 );
405 388
406 # 389 #
407 # Checks valid for RHEL/CentOS version 390 # Checks valid for RHEL/CentOS version 7.x.
408 # 391 #
409 my $old = 0; 392 my $old = 0;
410 my $rel; 393 my $rel;
411 my $noto_sans_redhat = "google-noto-sa <<
412 $rel = $1 if ($system_release =~ /rele 394 $rel = $1 if ($system_release =~ /release\s+(\d+)/);
413 395
414 if (!($system_release =~ /Fedora/)) { 396 if (!($system_release =~ /Fedora/)) {
415 $map{"virtualenv"} = "python-v 397 $map{"virtualenv"} = "python-virtualenv";
416 398
417 if ($rel && $rel < 8) { 399 if ($rel && $rel < 8) {
418 $old = 1; 400 $old = 1;
419 $pdf = 0; 401 $pdf = 0;
420 402
421 printf("Note: texlive 403 printf("Note: texlive packages on RHEL/CENTOS <= 7 are incomplete. Can't support PDF output\n");
422 printf("If you want to 404 printf("If you want to build PDF, please read:\n");
423 printf("\thttps://www. 405 printf("\thttps://www.systutorials.com/241660/how-to-install-tex-live-on-centos-7-linux/\n");
424 } 406 }
425 } else { 407 } else {
426 if ($rel && $rel < 26) { 408 if ($rel && $rel < 26) {
427 $old = 1; 409 $old = 1;
428 } 410 }
429 if ($rel && $rel >= 38) { <<
430 $noto_sans_redhat = "g <<
431 } <<
432 } 411 }
433 if (!$rel) { 412 if (!$rel) {
434 printf("Couldn't identify rele 413 printf("Couldn't identify release number\n");
435 $old = 1; 414 $old = 1;
436 $pdf = 0; 415 $pdf = 0;
437 } 416 }
438 417
439 if ($pdf) { 418 if ($pdf) {
440 check_missing_file(["/usr/shar !! 419 check_missing_file(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc"],
441 "/usr/shar !! 420 "google-noto-sans-cjk-ttc-fonts", 2);
442 $noto_sans_ <<
443 } 421 }
444 422
445 check_rpm_missing(\@fedora26_opt_pkgs, 423 check_rpm_missing(\@fedora26_opt_pkgs, 2) if ($pdf && !$old);
446 check_rpm_missing(\@fedora_tex_pkgs, 2 424 check_rpm_missing(\@fedora_tex_pkgs, 2) if ($pdf);
447 check_missing_tex(2) if ($pdf); 425 check_missing_tex(2) if ($pdf);
448 check_missing(\%map); 426 check_missing(\%map);
449 427
450 return if (!$need && !$optional); 428 return if (!$need && !$optional);
451 429
452 if (!$old) { 430 if (!$old) {
453 # dnf, for Fedora 18+ 431 # dnf, for Fedora 18+
454 printf("You should run:\n") if !! 432 printf("You should run:\n\n\tsudo dnf install -y $install\n");
455 printf("\n\tsudo dnf install - <<
456 } else { 433 } else {
457 # yum, for RHEL (and clones) o 434 # yum, for RHEL (and clones) or Fedora version < 18
458 printf("You should run:\n") if !! 435 printf("You should run:\n\n\tsudo yum install -y $install\n");
459 printf("\n\tsudo yum install - <<
460 } 436 }
461 } 437 }
462 438
463 sub give_opensuse_hints() 439 sub give_opensuse_hints()
464 { 440 {
465 my %map = ( 441 my %map = (
466 "python-sphinx" => "py 442 "python-sphinx" => "python3-sphinx",
467 "yaml" => "py !! 443 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme",
468 "virtualenv" => "py 444 "virtualenv" => "python3-virtualenv",
469 "dot" => "gr 445 "dot" => "graphviz",
470 "convert" => "Im 446 "convert" => "ImageMagick",
471 "Pod::Usage" => "pe 447 "Pod::Usage" => "perl-Pod-Usage",
472 "xelatex" => "te 448 "xelatex" => "texlive-xetex-bin",
>> 449 "rsvg-convert" => "rsvg-view",
473 ); 450 );
474 451
475 # On Tumbleweed, this package is also <<
476 $map{"rsvg-convert"} = "rsvg-view" if <<
477 <<
478 my @suse_tex_pkgs = ( 452 my @suse_tex_pkgs = (
479 "texlive-babel-english", 453 "texlive-babel-english",
480 "texlive-caption", 454 "texlive-caption",
481 "texlive-colortbl", 455 "texlive-colortbl",
482 "texlive-courier", 456 "texlive-courier",
483 "texlive-dvips", 457 "texlive-dvips",
484 "texlive-helvetic", 458 "texlive-helvetic",
485 "texlive-makeindex", 459 "texlive-makeindex",
486 "texlive-metafont", 460 "texlive-metafont",
487 "texlive-metapost", 461 "texlive-metapost",
488 "texlive-palatino", 462 "texlive-palatino",
489 "texlive-preview", 463 "texlive-preview",
490 "texlive-times", 464 "texlive-times",
491 "texlive-zapfchan", 465 "texlive-zapfchan",
492 "texlive-zapfding", 466 "texlive-zapfding",
493 ); 467 );
494 468
495 $map{"latexmk"} = "texlive-latexmk-bin 469 $map{"latexmk"} = "texlive-latexmk-bin";
496 470
497 # FIXME: add support for installing CJ 471 # FIXME: add support for installing CJK fonts
498 # 472 #
499 # I tried hard, but was unable to find 473 # I tried hard, but was unable to find a way to install
500 # "Noto Sans CJK SC" on openSUSE 474 # "Noto Sans CJK SC" on openSUSE
501 475
502 check_rpm_missing(\@suse_tex_pkgs, 2) 476 check_rpm_missing(\@suse_tex_pkgs, 2) if ($pdf);
503 check_missing_tex(2) if ($pdf); 477 check_missing_tex(2) if ($pdf);
504 check_missing(\%map); 478 check_missing(\%map);
505 479
506 return if (!$need && !$optional); 480 return if (!$need && !$optional);
507 printf("You should run:\n") if ($verbo !! 481 printf("You should run:\n\n\tsudo zypper install --no-recommends $install\n");
508 printf("\n\tsudo zypper install --no-r <<
509 } 482 }
510 483
511 sub give_mageia_hints() 484 sub give_mageia_hints()
512 { 485 {
513 my %map = ( 486 my %map = (
514 "python-sphinx" => "py 487 "python-sphinx" => "python3-sphinx",
515 "yaml" => "py !! 488 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme",
516 "virtualenv" => "py 489 "virtualenv" => "python3-virtualenv",
517 "dot" => "gr 490 "dot" => "graphviz",
518 "convert" => "Im 491 "convert" => "ImageMagick",
519 "Pod::Usage" => "pe 492 "Pod::Usage" => "perl-Pod-Usage",
520 "xelatex" => "te 493 "xelatex" => "texlive",
521 "rsvg-convert" => "li !! 494 "rsvg-convert" => "librsvg2-tools",
522 ); 495 );
523 496
524 my @tex_pkgs = ( 497 my @tex_pkgs = (
525 "texlive-fontsextra", 498 "texlive-fontsextra",
526 ); 499 );
527 500
528 $map{"latexmk"} = "texlive-collection- 501 $map{"latexmk"} = "texlive-collection-basic";
529 502
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) { 503 if ($pdf) {
543 check_missing_file(["/usr/shar !! 504 check_missing_file(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc"],
544 "/usr/shar !! 505 "google-noto-sans-cjk-ttc-fonts", 2);
545 $noto_sans, <<
546 } 506 }
547 507
548 check_rpm_missing(\@tex_pkgs, 2) if ($ 508 check_rpm_missing(\@tex_pkgs, 2) if ($pdf);
549 check_missing(\%map); 509 check_missing(\%map);
550 510
551 return if (!$need && !$optional); 511 return if (!$need && !$optional);
552 printf("You should run:\n") if ($verbo !! 512 printf("You should run:\n\n\tsudo urpmi $install\n");
553 printf("\n\tsudo $packager_cmd $instal <<
554 } 513 }
555 514
556 sub give_arch_linux_hints() 515 sub give_arch_linux_hints()
557 { 516 {
558 my %map = ( 517 my %map = (
559 "yaml" => "py !! 518 "sphinx_rtd_theme" => "python-sphinx_rtd_theme",
560 "virtualenv" => "py 519 "virtualenv" => "python-virtualenv",
561 "dot" => "gr 520 "dot" => "graphviz",
562 "convert" => "im 521 "convert" => "imagemagick",
563 "xelatex" => "te !! 522 "xelatex" => "texlive-bin",
564 "latexmk" => "te 523 "latexmk" => "texlive-core",
565 "rsvg-convert" => "ex 524 "rsvg-convert" => "extra/librsvg",
566 ); 525 );
567 526
568 my @archlinux_tex_pkgs = ( 527 my @archlinux_tex_pkgs = (
569 "texlive-core", 528 "texlive-core",
570 "texlive-latexextra", 529 "texlive-latexextra",
571 "ttf-dejavu", 530 "ttf-dejavu",
572 ); 531 );
573 check_pacman_missing(\@archlinux_tex_p 532 check_pacman_missing(\@archlinux_tex_pkgs, 2) if ($pdf);
574 533
575 if ($pdf) { 534 if ($pdf) {
576 check_missing_file(["/usr/shar 535 check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc"],
577 "noto-fonts 536 "noto-fonts-cjk", 2);
578 } 537 }
579 538
580 check_missing(\%map); 539 check_missing(\%map);
581 540
582 return if (!$need && !$optional); 541 return if (!$need && !$optional);
583 printf("You should run:\n") if ($verbo !! 542 printf("You should run:\n\n\tsudo pacman -S $install\n");
584 printf("\n\tsudo pacman -S $install\n" <<
585 } 543 }
586 544
587 sub give_gentoo_hints() 545 sub give_gentoo_hints()
588 { 546 {
589 my %map = ( 547 my %map = (
590 "yaml" => "de !! 548 "sphinx_rtd_theme" => "dev-python/sphinx_rtd_theme",
591 "virtualenv" => "de 549 "virtualenv" => "dev-python/virtualenv",
592 "dot" => "me 550 "dot" => "media-gfx/graphviz",
593 "convert" => "me 551 "convert" => "media-gfx/imagemagick",
594 "xelatex" => "de 552 "xelatex" => "dev-texlive/texlive-xetex media-fonts/dejavu",
595 "rsvg-convert" => "gn 553 "rsvg-convert" => "gnome-base/librsvg",
596 ); 554 );
597 555
598 check_missing_file(["/usr/share/fonts/ 556 check_missing_file(["/usr/share/fonts/dejavu/DejaVuSans.ttf"],
599 "media-fonts/dejavu 557 "media-fonts/dejavu", 2) if ($pdf);
600 558
601 if ($pdf) { 559 if ($pdf) {
602 check_missing_file(["/usr/shar 560 check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJKsc-Regular.otf",
603 "/usr/shar 561 "/usr/share/fonts/noto-cjk/NotoSerifCJK-Regular.ttc"],
604 "media-font 562 "media-fonts/noto-cjk", 2);
605 } 563 }
606 564
607 check_missing(\%map); 565 check_missing(\%map);
608 566
609 return if (!$need && !$optional); 567 return if (!$need && !$optional);
610 568
611 printf("You should run:\n") if ($verbo !! 569 printf("You should run:\n\n");
612 printf("\n"); <<
613 570
614 my $imagemagick = "media-gfx/imagemagi 571 my $imagemagick = "media-gfx/imagemagick svg png";
615 my $cairo = "media-gfx/graphviz cairo 572 my $cairo = "media-gfx/graphviz cairo pdf";
616 my $portage_imagemagick = "/etc/portag 573 my $portage_imagemagick = "/etc/portage/package.use/imagemagick";
617 my $portage_cairo = "/etc/portage/pack 574 my $portage_cairo = "/etc/portage/package.use/graphviz";
618 575
619 if (qx(grep imagemagick $portage_image 576 if (qx(grep imagemagick $portage_imagemagick 2>/dev/null) eq "") {
620 printf("\tsudo su -c 'echo \"$ 577 printf("\tsudo su -c 'echo \"$imagemagick\" > $portage_imagemagick'\n")
621 } 578 }
622 if (qx(grep graphviz $portage_cairo 2> 579 if (qx(grep graphviz $portage_cairo 2>/dev/null) eq "") {
623 printf("\tsudo su -c 'echo \"$ 580 printf("\tsudo su -c 'echo \"$cairo\" > $portage_cairo'\n");
624 } 581 }
625 582
626 printf("\tsudo emerge --ask $install\n 583 printf("\tsudo emerge --ask $install\n");
627 584
628 } 585 }
629 586
630 sub check_distros() 587 sub check_distros()
631 { 588 {
632 # Distro-specific hints 589 # Distro-specific hints
633 if ($system_release =~ /Red Hat Enterp 590 if ($system_release =~ /Red Hat Enterprise Linux/) {
634 give_redhat_hints; 591 give_redhat_hints;
635 return; 592 return;
636 } 593 }
637 if ($system_release =~ /CentOS/) { 594 if ($system_release =~ /CentOS/) {
638 give_redhat_hints; 595 give_redhat_hints;
639 return; 596 return;
640 } 597 }
641 if ($system_release =~ /Scientific Lin 598 if ($system_release =~ /Scientific Linux/) {
642 give_redhat_hints; 599 give_redhat_hints;
643 return; 600 return;
644 } 601 }
645 if ($system_release =~ /Oracle Linux S 602 if ($system_release =~ /Oracle Linux Server/) {
646 give_redhat_hints; 603 give_redhat_hints;
647 return; 604 return;
648 } 605 }
649 if ($system_release =~ /Fedora/) { 606 if ($system_release =~ /Fedora/) {
650 give_redhat_hints; 607 give_redhat_hints;
651 return; 608 return;
652 } 609 }
653 if ($system_release =~ /Ubuntu/) { 610 if ($system_release =~ /Ubuntu/) {
654 give_debian_hints; 611 give_debian_hints;
655 return; 612 return;
656 } 613 }
657 if ($system_release =~ /Debian/) { 614 if ($system_release =~ /Debian/) {
658 give_debian_hints; 615 give_debian_hints;
659 return; 616 return;
660 } 617 }
661 if ($system_release =~ /openSUSE/) { 618 if ($system_release =~ /openSUSE/) {
662 give_opensuse_hints; 619 give_opensuse_hints;
663 return; 620 return;
664 } 621 }
665 if ($system_release =~ /Mageia/) { 622 if ($system_release =~ /Mageia/) {
666 give_mageia_hints; 623 give_mageia_hints;
667 return; 624 return;
668 } 625 }
669 if ($system_release =~ /OpenMandriva/) <<
670 give_mageia_hints; <<
671 return; <<
672 } <<
673 if ($system_release =~ /Arch Linux/) { 626 if ($system_release =~ /Arch Linux/) {
674 give_arch_linux_hints; 627 give_arch_linux_hints;
675 return; 628 return;
676 } 629 }
677 if ($system_release =~ /Gentoo/) { 630 if ($system_release =~ /Gentoo/) {
678 give_gentoo_hints; 631 give_gentoo_hints;
679 return; 632 return;
680 } 633 }
681 634
682 # 635 #
683 # Fall-back to generic hint code for o 636 # Fall-back to generic hint code for other distros
684 # That's far from ideal, specially for 637 # That's far from ideal, specially for LaTeX dependencies.
685 # 638 #
686 my %map = ( 639 my %map = (
687 "sphinx-build" => "sphinx" 640 "sphinx-build" => "sphinx"
688 ); 641 );
689 check_missing_tex(2) if ($pdf); 642 check_missing_tex(2) if ($pdf);
690 check_missing(\%map); 643 check_missing(\%map);
691 print "I don't know distro $system_rel 644 print "I don't know distro $system_release.\n";
692 print "So, I can't provide you a hint 645 print "So, I can't provide you a hint with the install procedure.\n";
693 print "There are likely missing depend 646 print "There are likely missing dependencies.\n";
694 } 647 }
695 648
696 # 649 #
697 # Common dependencies 650 # Common dependencies
698 # 651 #
699 652
700 sub deactivate_help() 653 sub deactivate_help()
701 { 654 {
702 printf "\n If you want to exit the !! 655 printf "\tIf you want to exit the virtualenv, you can use:\n";
703 printf "\tdeactivate\n"; 656 printf "\tdeactivate\n";
704 } 657 }
705 658
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() 659 sub check_needs()
893 { 660 {
894 # Check if Sphinx is already accessibl !! 661 # Check for needed programs/tools
895 check_sphinx(); 662 check_sphinx();
896 663
897 if ($system_release) { 664 if ($system_release) {
898 print "Detected OS: $system_re !! 665 print "Detected OS: $system_release.\n\n";
899 } else { 666 } else {
900 print "Unknown OS\n"; !! 667 print "Unknown OS\n\n";
901 } 668 }
902 printf "Sphinx version: %s\n\n", $cur_ <<
903 669
904 # Check python command line, trying fi !! 670 print "To upgrade Sphinx, use:\n\n" if ($rec_sphinx_upgrade);
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 } <<
928 <<
929 my $venv_ver = recommend_sphinx_upgrad <<
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 671
948 # Check for needed programs/tools 672 # Check for needed programs/tools
949 check_perl_module("Pod::Usage", 0); 673 check_perl_module("Pod::Usage", 0);
950 check_python_module("yaml", 0); <<
951 check_program("make", 0); 674 check_program("make", 0);
952 check_program("gcc", 0); 675 check_program("gcc", 0);
>> 676 check_python_module("sphinx_rtd_theme", 1) if (!$virtualenv);
953 check_program("dot", 1); 677 check_program("dot", 1);
954 check_program("convert", 1); 678 check_program("convert", 1);
955 679
956 # Extra PDF files - should use 2 for i 680 # Extra PDF files - should use 2 for is_optional
957 check_program("xelatex", 2) if ($pdf); 681 check_program("xelatex", 2) if ($pdf);
958 check_program("rsvg-convert", 2) if ($ 682 check_program("rsvg-convert", 2) if ($pdf);
959 check_program("latexmk", 2) if ($pdf); 683 check_program("latexmk", 2) if ($pdf);
960 684
961 # Do distro-specific checks and output <<
962 check_distros(); 685 check_distros();
963 686
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) { 687 if ($need_symlink) {
974 printf "\tsudo ln -sf %s /usr/ 688 printf "\tsudo ln -sf %s /usr/bin/sphinx-build\n\n",
975 which("sphinx-build-3") 689 which("sphinx-build-3");
976 } 690 }
>> 691 if ($need_sphinx || $rec_sphinx_upgrade) {
>> 692 my $min_activate = "$ENV{'PWD'}/${virtenv_prefix}${min_version}/bin/activate";
>> 693 my @activates = glob "$ENV{'PWD'}/${virtenv_prefix}*/bin/activate";
>> 694
>> 695 @activates = sort {$b cmp $a} @activates;
>> 696
>> 697 if ($need_sphinx && scalar @activates > 0 && $activates[0] ge $min_activate) {
>> 698 printf "\nNeed to activate a compatible Sphinx version on virtualenv with:\n";
>> 699 printf "\t. $activates[0]\n";
>> 700 deactivate_help();
>> 701 exit (1);
>> 702 } else {
>> 703 my $rec_activate = "$virtenv_dir/bin/activate";
>> 704 my $virtualenv = findprog("virtualenv-3");
>> 705 my $rec_python3 = "";
>> 706 $virtualenv = findprog("virtualenv-3.5") if (!$virtualenv);
>> 707 $virtualenv = findprog("virtualenv") if (!$virtualenv);
>> 708 $virtualenv = "virtualenv" if (!$virtualenv);
>> 709
>> 710 my $rel = "";
>> 711 if (index($system_release, "Ubuntu") != -1) {
>> 712 $rel = $1 if ($system_release =~ /Ubuntu\s+(\d+)[.]/);
>> 713 if ($rel && $rel >= 16) {
>> 714 $rec_python3 = " -p python3";
>> 715 }
>> 716 }
>> 717 if (index($system_release, "Debian") != -1) {
>> 718 $rel = $1 if ($system_release =~ /Debian\s+(\d+)/);
>> 719 if ($rel && $rel >= 7) {
>> 720 $rec_python3 = " -p python3";
>> 721 }
>> 722 }
>> 723
>> 724 printf "\t$virtualenv$rec_python3 $virtenv_dir\n";
>> 725 printf "\t. $rec_activate\n";
>> 726 printf "\tpip install -r $requirement_file\n";
>> 727 deactivate_help();
977 728
978 recommend_sphinx_version($virtualenv_c !! 729 $need++ if (!$rec_sphinx_upgrade);
>> 730 }
>> 731 }
979 printf "\n"; 732 printf "\n";
980 733
981 print "All optional dependencies are m 734 print "All optional dependencies are met.\n" if (!$optional);
982 735
983 if ($need == 1) { 736 if ($need == 1) {
984 die "Can't build as $need mand 737 die "Can't build as $need mandatory dependency is missing";
985 } elsif ($need) { 738 } elsif ($need) {
986 die "Can't build as $need mand 739 die "Can't build as $need mandatory dependencies are missing";
987 } 740 }
988 741
989 print "Needed package dependencies are 742 print "Needed package dependencies are met.\n";
990 } 743 }
991 744
992 # 745 #
993 # Main 746 # Main
994 # 747 #
995 748
996 while (@ARGV) { 749 while (@ARGV) {
997 my $arg = shift(@ARGV); 750 my $arg = shift(@ARGV);
998 751
999 if ($arg eq "--no-virtualenv") { 752 if ($arg eq "--no-virtualenv") {
1000 $virtualenv = 0; 753 $virtualenv = 0;
1001 } elsif ($arg eq "--no-pdf"){ 754 } elsif ($arg eq "--no-pdf"){
1002 $pdf = 0; 755 $pdf = 0;
1003 } elsif ($arg eq "--version-check"){ 756 } elsif ($arg eq "--version-check"){
1004 $version_check = 1; 757 $version_check = 1;
1005 } else { 758 } else {
1006 print "Usage:\n\t$0 <--no-vir 759 print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf> <--version-check>\n\n";
1007 print "Where:\n"; 760 print "Where:\n";
1008 print "\t--no-virtualenv\t- R 761 print "\t--no-virtualenv\t- Recommend installing Sphinx instead of using a virtualenv\n";
1009 print "\t--version-check\t- i 762 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 763 print "\t--no-pdf\t- don't check for dependencies required to build PDF docs\n\n";
1011 exit -1; 764 exit -1;
1012 } 765 }
1013 } 766 }
1014 767
1015 # 768 #
1016 # Determine the system type. There's no stand 769 # Determine the system type. There's no standard unique way that would
1017 # work with all distros with a minimal packag 770 # work with all distros with a minimal package install. So, several
1018 # methods are used here. 771 # methods are used here.
1019 # 772 #
1020 # By default, it will use lsb_release functio 773 # By default, it will use lsb_release function. If not available, it will
1021 # fail back to reading the known different pl 774 # fail back to reading the known different places where the distro name
1022 # is stored 775 # is stored
1023 # 776 #
1024 777
1025 $system_release = qx(lsb_release -d) if which 778 $system_release = qx(lsb_release -d) if which("lsb_release");
1026 $system_release =~ s/Description:\s*// if ($s 779 $system_release =~ s/Description:\s*// if ($system_release);
1027 $system_release = catcheck("/etc/system-relea 780 $system_release = catcheck("/etc/system-release") if !$system_release;
1028 $system_release = catcheck("/etc/redhat-relea 781 $system_release = catcheck("/etc/redhat-release") if !$system_release;
1029 $system_release = catcheck("/etc/lsb-release" 782 $system_release = catcheck("/etc/lsb-release") if !$system_release;
1030 $system_release = catcheck("/etc/gentoo-relea 783 $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 ! 784 $system_release = catcheck("/etc/issue") if !$system_release;
1050 $system_release =~ s/\s+$//; 785 $system_release =~ s/\s+$//;
1051 786
1052 check_needs; 787 check_needs;
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.