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