blob: 1fb88fdceec385d3cd5ca319cf61dc255d5909bc [file] [log] [blame]
Finn Behrensc25ce582020-11-23 15:15:33 +01001#!/usr/bin/env perl
Thomas Gleixnerc942fdd2019-05-27 08:55:06 +02002# SPDX-License-Identifier: GPL-2.0-or-later
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -03003use strict;
4
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +02005# Copyright (c) 2017-2020 Mauro Carvalho Chehab <mchehab@kernel.org>
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -03006#
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -03007
Mike Rapoport8c69b772019-06-24 08:25:07 +03008my $prefix = "./";
9$prefix = "$ENV{'srctree'}/" if ($ENV{'srctree'});
10
11my $conf = $prefix . "Documentation/conf.py";
12my $requirement_file = $prefix . "Documentation/sphinx/requirements.txt";
Mauro Carvalho Chehab44f42162019-05-29 20:09:24 -030013my $virtenv_prefix = "sphinx_";
Mauro Carvalho Chehab5be33182017-07-17 18:46:37 -030014
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -030015#
16# Static vars
17#
18
19my %missing;
20my $system_release;
21my $need = 0;
22my $optional = 0;
23my $need_symlink = 0;
24my $need_sphinx = 0;
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +020025my $need_pip = 0;
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +020026my $need_virtualenv = 0;
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +020027my $rec_sphinx_upgrade = 0;
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +010028my $verbose_warn_install = 1;
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -030029my $install = "";
Mauro Carvalho Chehab44f42162019-05-29 20:09:24 -030030my $virtenv_dir = "";
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +020031my $python_cmd = "";
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +020032my $activate_cmd;
Mauro Carvalho Chehab44f42162019-05-29 20:09:24 -030033my $min_version;
Mauro Carvalho Chehab2834a742020-04-21 16:31:07 +020034my $cur_version;
Mauro Carvalho Chehab1ef70ce2020-04-21 16:31:06 +020035my $rec_version = "1.7.9"; # PDF won't build here
36my $min_pdf_version = "2.4.4"; # Min version where pdf builds
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +020037my $latest_avail_ver;
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +020038
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -030039#
40# Command line arguments
41#
42
43my $pdf = 1;
44my $virtualenv = 1;
Mauro Carvalho Chehab9b88ad52019-05-29 20:09:26 -030045my $version_check = 0;
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -030046
47#
48# List of required texlive packages on Fedora and OpenSuse
49#
50
51my %texlive = (
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -030052 'amsfonts.sty' => 'texlive-amsfonts',
53 'amsmath.sty' => 'texlive-amsmath',
54 'amssymb.sty' => 'texlive-amsfonts',
55 'amsthm.sty' => 'texlive-amscls',
56 'anyfontsize.sty' => 'texlive-anyfontsize',
57 'atbegshi.sty' => 'texlive-oberdiek',
58 'bm.sty' => 'texlive-tools',
59 'capt-of.sty' => 'texlive-capt-of',
60 'cmap.sty' => 'texlive-cmap',
61 'ecrm1000.tfm' => 'texlive-ec',
62 'eqparbox.sty' => 'texlive-eqparbox',
63 'eu1enc.def' => 'texlive-euenc',
64 'fancybox.sty' => 'texlive-fancybox',
65 'fancyvrb.sty' => 'texlive-fancyvrb',
66 'float.sty' => 'texlive-float',
67 'fncychap.sty' => 'texlive-fncychap',
68 'footnote.sty' => 'texlive-mdwtools',
69 'framed.sty' => 'texlive-framed',
70 'luatex85.sty' => 'texlive-luatex85',
71 'multirow.sty' => 'texlive-multirow',
72 'needspace.sty' => 'texlive-needspace',
73 'palatino.sty' => 'texlive-psnfss',
74 'parskip.sty' => 'texlive-parskip',
75 'polyglossia.sty' => 'texlive-polyglossia',
76 'tabulary.sty' => 'texlive-tabulary',
77 'threeparttable.sty' => 'texlive-threeparttable',
78 'titlesec.sty' => 'texlive-titlesec',
79 'ucs.sty' => 'texlive-ucs',
80 'upquote.sty' => 'texlive-upquote',
81 'wrapfig.sty' => 'texlive-wrapfig',
Mauro Carvalho Chehab7baab962022-01-03 22:01:57 +010082 'ctexhook.sty' => 'texlive-ctex',
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -030083);
84
85#
86# Subroutines that checks if a feature exists
87#
88
89sub check_missing(%)
90{
91 my %map = %{$_[0]};
92
93 foreach my $prog (sort keys %missing) {
94 my $is_optional = $missing{$prog};
95
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -030096 # At least on some LTS distros like CentOS 7, texlive doesn't
97 # provide all packages we need. When such distros are
98 # detected, we have to disable PDF output.
99 #
100 # So, we need to ignore the packages that distros would
101 # need for LaTeX to work
102 if ($is_optional == 2 && !$pdf) {
103 $optional--;
104 next;
105 }
106
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +0100107 if ($verbose_warn_install) {
108 if ($is_optional) {
109 print "Warning: better to also install \"$prog\".\n";
110 } else {
111 print "ERROR: please install \"$prog\", otherwise, build won't work.\n";
112 }
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300113 }
114 if (defined($map{$prog})) {
115 $install .= " " . $map{$prog};
116 } else {
117 $install .= " " . $prog;
118 }
119 }
120
121 $install =~ s/^\s//;
122}
123
124sub add_package($$)
125{
126 my $package = shift;
127 my $is_optional = shift;
128
129 $missing{$package} = $is_optional;
130 if ($is_optional) {
131 $optional++;
132 } else {
133 $need++;
134 }
135}
136
137sub check_missing_file($$$)
138{
Jeremy MAUROff8fdb32019-10-02 15:33:39 +0200139 my $files = shift;
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300140 my $package = shift;
141 my $is_optional = shift;
142
Jeremy MAUROff8fdb32019-10-02 15:33:39 +0200143 for (@$files) {
144 return if(-e $_);
145 }
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300146
147 add_package($package, $is_optional);
148}
149
150sub findprog($)
151{
152 foreach(split(/:/, $ENV{PATH})) {
153 return "$_/$_[0]" if(-x "$_/$_[0]");
154 }
155}
156
Mauro Carvalho Chehab412b09d2020-04-21 16:31:08 +0200157sub find_python_no_venv()
158{
159 my $prog = shift;
160
161 my $cur_dir = qx(pwd);
162 $cur_dir =~ s/\s+$//;
163
164 foreach my $dir (split(/:/, $ENV{PATH})) {
165 next if ($dir =~ m,($cur_dir)/sphinx,);
166 return "$dir/python3" if(-x "$dir/python3");
167 }
168 foreach my $dir (split(/:/, $ENV{PATH})) {
169 next if ($dir =~ m,($cur_dir)/sphinx,);
170 return "$dir/python" if(-x "$dir/python");
171 }
172 return "python";
173}
174
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300175sub check_program($$)
176{
177 my $prog = shift;
178 my $is_optional = shift;
179
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200180 return $prog if findprog($prog);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300181
182 add_package($prog, $is_optional);
183}
184
185sub check_perl_module($$)
186{
187 my $prog = shift;
188 my $is_optional = shift;
189
190 my $err = system("perl -M$prog -e 1 2>/dev/null /dev/null");
191 return if ($err == 0);
192
193 add_package($prog, $is_optional);
194}
195
196sub check_python_module($$)
197{
198 my $prog = shift;
199 my $is_optional = shift;
200
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200201 return if (!$python_cmd);
202
203 my $err = system("$python_cmd -c 'import $prog' 2>/dev/null /dev/null");
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300204 return if ($err == 0);
205
206 add_package($prog, $is_optional);
207}
208
209sub check_rpm_missing($$)
210{
211 my @pkgs = @{$_[0]};
212 my $is_optional = $_[1];
213
214 foreach my $prog(@pkgs) {
215 my $err = system("rpm -q '$prog' 2>/dev/null >/dev/null");
216 add_package($prog, $is_optional) if ($err);
217 }
218}
219
220sub check_pacman_missing($$)
221{
222 my @pkgs = @{$_[0]};
223 my $is_optional = $_[1];
224
225 foreach my $prog(@pkgs) {
226 my $err = system("pacman -Q '$prog' 2>/dev/null >/dev/null");
227 add_package($prog, $is_optional) if ($err);
228 }
229}
230
231sub check_missing_tex($)
232{
233 my $is_optional = shift;
234 my $kpsewhich = findprog("kpsewhich");
235
236 foreach my $prog(keys %texlive) {
237 my $package = $texlive{$prog};
238 if (!$kpsewhich) {
239 add_package($package, $is_optional);
240 next;
241 }
242 my $file = qx($kpsewhich $prog);
243 add_package($package, $is_optional) if ($file =~ /^\s*$/);
244 }
245}
246
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300247sub get_sphinx_fname()
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300248{
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300249 my $fname = "sphinx-build";
250 return $fname if findprog($fname);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300251
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300252 $fname = "sphinx-build-3";
253 if (findprog($fname)) {
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300254 $need_symlink = 1;
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300255 return $fname;
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300256 }
257
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300258 return "";
259}
260
Mauro Carvalho Chehaba8b380c2020-04-21 16:31:05 +0200261sub get_sphinx_version($)
262{
263 my $cmd = shift;
264 my $ver;
265
266 open IN, "$cmd --version 2>&1 |";
267 while (<IN>) {
Jonathan Corbete9dfeed2021-04-15 16:01:50 -0600268 if (m/^\s*sphinx-build\s+([\d\.]+)((\+\/[\da-f]+)|(b\d+))?$/) {
Mauro Carvalho Chehaba8b380c2020-04-21 16:31:05 +0200269 $ver=$1;
270 last;
271 }
272 # Sphinx 1.2.x uses a different format
273 if (m/^\s*Sphinx.*\s+([\d\.]+)$/) {
274 $ver=$1;
275 last;
276 }
277 }
278 close IN;
279 return $ver;
280}
281
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300282sub check_sphinx()
283{
Mauro Carvalho Chehab1ef70ce2020-04-21 16:31:06 +0200284 my $default_version;
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300285
286 open IN, $conf or die "Can't open $conf";
287 while (<IN>) {
288 if (m/^\s*needs_sphinx\s*=\s*[\'\"]([\d\.]+)[\'\"]/) {
289 $min_version=$1;
290 last;
291 }
292 }
293 close IN;
294
295 die "Can't get needs_sphinx version from $conf" if (!$min_version);
296
297 open IN, $requirement_file or die "Can't open $requirement_file";
298 while (<IN>) {
299 if (m/^\s*Sphinx\s*==\s*([\d\.]+)$/) {
Mauro Carvalho Chehab1ef70ce2020-04-21 16:31:06 +0200300 $default_version=$1;
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300301 last;
302 }
303 }
304 close IN;
305
Mauro Carvalho Chehab1ef70ce2020-04-21 16:31:06 +0200306 die "Can't get default sphinx version from $requirement_file" if (!$default_version);
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300307
Mauro Carvalho Chehab1ef70ce2020-04-21 16:31:06 +0200308 $virtenv_dir = $virtenv_prefix . $default_version;
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300309
310 my $sphinx = get_sphinx_fname();
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200311 if ($sphinx eq "") {
312 $need_sphinx = 1;
313 return;
314 }
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300315
Mauro Carvalho Chehaba8b380c2020-04-21 16:31:05 +0200316 $cur_version = get_sphinx_version($sphinx);
317 die ("$sphinx returned an error") if (!$cur_version);
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300318
319 die "$sphinx didn't return its version" if (!$cur_version);
320
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300321 if ($cur_version lt $min_version) {
Mauro Carvalho Chehab9b88ad52019-05-29 20:09:26 -0300322 printf "ERROR: Sphinx version is %s. It should be >= %s (recommended >= %s)\n",
Mauro Carvalho Chehab1ef70ce2020-04-21 16:31:06 +0200323 $cur_version, $min_version, $default_version;
Mauro Carvalho Chehab77d09ad2019-05-22 18:43:46 -0300324 $need_sphinx = 1;
325 return;
326 }
327
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200328 return if ($cur_version lt $rec_version);
Mauro Carvalho Chehab9b88ad52019-05-29 20:09:26 -0300329
330 # On version check mode, just assume Sphinx has all mandatory deps
331 exit (0) if ($version_check);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300332}
333
334#
335# Ancillary subroutines
336#
337
338sub catcheck($)
339{
340 my $res = "";
341 $res = qx(cat $_[0]) if (-r $_[0]);
342 return $res;
343}
344
345sub which($)
346{
347 my $file = shift;
348 my @path = split ":", $ENV{PATH};
349
350 foreach my $dir(@path) {
351 my $name = $dir.'/'.$file;
352 return $name if (-x $name );
353 }
354 return undef;
355}
356
357#
358# Subroutines that check distro-specific hints
359#
360
361sub give_debian_hints()
362{
363 my %map = (
364 "python-sphinx" => "python3-sphinx",
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200365 "ensurepip" => "python3-venv",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300366 "virtualenv" => "virtualenv",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300367 "dot" => "graphviz",
368 "convert" => "imagemagick",
369 "Pod::Usage" => "perl-modules",
370 "xelatex" => "texlive-xetex",
Mauro Carvalho Chehab8e7d5d12017-07-17 18:46:40 -0300371 "rsvg-convert" => "librsvg2-bin",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300372 );
373
374 if ($pdf) {
Mauro Carvalho Chehab87d65762022-01-06 01:41:02 +0100375 check_missing_file(["/usr/share/texlive/texmf-dist/tex/latex/ctex/ctexhook.sty"],
376 "texlive-lang-chinese", 2);
377
Jeremy MAUROff8fdb32019-10-02 15:33:39 +0200378 check_missing_file(["/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf"],
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -0300379 "fonts-dejavu", 2);
Mauro Carvalho Chehab27eed922019-07-13 08:19:44 -0300380
Jeremy MAURO9692f2f2019-10-02 15:35:42 +0200381 check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc",
Mauro Carvalho Chehabbfc7f422020-04-14 18:56:10 +0200382 "/usr/share/fonts/opentype/noto/NotoSansCJK-Regular.ttc",
383 "/usr/share/fonts/opentype/noto/NotoSerifCJK-Regular.ttc"],
Mauro Carvalho Chehab27eed922019-07-13 08:19:44 -0300384 "fonts-noto-cjk", 2);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300385 }
386
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -0300387 check_program("dvipng", 2) if ($pdf);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300388 check_missing(\%map);
389
390 return if (!$need && !$optional);
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +0100391 printf("You should run:\n") if ($verbose_warn_install);
392 printf("\n\tsudo apt-get install $install\n");
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300393}
394
395sub give_redhat_hints()
396{
397 my %map = (
398 "python-sphinx" => "python3-sphinx",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300399 "virtualenv" => "python3-virtualenv",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300400 "dot" => "graphviz",
401 "convert" => "ImageMagick",
402 "Pod::Usage" => "perl-Pod-Usage",
403 "xelatex" => "texlive-xetex-bin",
Mauro Carvalho Chehab8e7d5d12017-07-17 18:46:40 -0300404 "rsvg-convert" => "librsvg2-tools",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300405 );
406
Mauro Carvalho Chehab5d889532017-07-17 18:46:39 -0300407 my @fedora26_opt_pkgs = (
408 "graphviz-gd", # Fedora 26: needed for PDF support
409 );
410
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300411 my @fedora_tex_pkgs = (
412 "texlive-collection-fontsrecommended",
413 "texlive-collection-latex",
Mauro Carvalho Chehab27eed922019-07-13 08:19:44 -0300414 "texlive-xecjk",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300415 "dejavu-sans-fonts",
416 "dejavu-serif-fonts",
417 "dejavu-sans-mono-fonts",
418 );
419
Mauro Carvalho Chehab9b756a92017-07-24 09:09:24 -0300420 #
421 # Checks valid for RHEL/CentOS version 7.x.
422 #
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -0300423 my $old = 0;
424 my $rel;
425 $rel = $1 if ($system_release =~ /release\s+(\d+)/);
426
Mauro Carvalho Chehabb3084672019-07-13 08:50:24 -0300427 if (!($system_release =~ /Fedora/)) {
Mauro Carvalho Chehab9b756a92017-07-24 09:09:24 -0300428 $map{"virtualenv"} = "python-virtualenv";
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -0300429
430 if ($rel && $rel < 8) {
431 $old = 1;
432 $pdf = 0;
433
434 printf("Note: texlive packages on RHEL/CENTOS <= 7 are incomplete. Can't support PDF output\n");
435 printf("If you want to build PDF, please read:\n");
436 printf("\thttps://www.systutorials.com/241660/how-to-install-tex-live-on-centos-7-linux/\n");
437 }
438 } else {
439 if ($rel && $rel < 26) {
440 $old = 1;
441 }
442 }
443 if (!$rel) {
444 printf("Couldn't identify release number\n");
445 $old = 1;
446 $pdf = 0;
Mauro Carvalho Chehab9b756a92017-07-24 09:09:24 -0300447 }
448
Mauro Carvalho Chehab27eed922019-07-13 08:19:44 -0300449 if ($pdf) {
Jeremy MAUROff8fdb32019-10-02 15:33:39 +0200450 check_missing_file(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc"],
Mauro Carvalho Chehab27eed922019-07-13 08:19:44 -0300451 "google-noto-sans-cjk-ttc-fonts", 2);
452 }
453
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -0300454 check_rpm_missing(\@fedora26_opt_pkgs, 2) if ($pdf && !$old);
455 check_rpm_missing(\@fedora_tex_pkgs, 2) if ($pdf);
456 check_missing_tex(2) if ($pdf);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300457 check_missing(\%map);
458
459 return if (!$need && !$optional);
Mauro Carvalho Chehab9b756a92017-07-24 09:09:24 -0300460
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -0300461 if (!$old) {
Mauro Carvalho Chehab9b756a92017-07-24 09:09:24 -0300462 # dnf, for Fedora 18+
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +0100463 printf("You should run:\n") if ($verbose_warn_install);
464 printf("\n\tsudo dnf install -y $install\n");
Mauro Carvalho Chehab9b756a92017-07-24 09:09:24 -0300465 } else {
466 # yum, for RHEL (and clones) or Fedora version < 18
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +0100467 printf("You should run:\n") if ($verbose_warn_install);
468 printf("\n\tsudo yum install -y $install\n");
Mauro Carvalho Chehab9b756a92017-07-24 09:09:24 -0300469 }
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300470}
471
472sub give_opensuse_hints()
473{
474 my %map = (
475 "python-sphinx" => "python3-sphinx",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300476 "virtualenv" => "python3-virtualenv",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300477 "dot" => "graphviz",
478 "convert" => "ImageMagick",
479 "Pod::Usage" => "perl-Pod-Usage",
480 "xelatex" => "texlive-xetex-bin",
481 );
482
Mauro Carvalho Chehabb3df6222020-04-14 18:56:09 +0200483 # On Tumbleweed, this package is also named rsvg-convert
484 $map{"rsvg-convert"} = "rsvg-view" if (!($system_release =~ /Tumbleweed/));
485
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300486 my @suse_tex_pkgs = (
487 "texlive-babel-english",
488 "texlive-caption",
489 "texlive-colortbl",
490 "texlive-courier",
491 "texlive-dvips",
492 "texlive-helvetic",
493 "texlive-makeindex",
494 "texlive-metafont",
495 "texlive-metapost",
496 "texlive-palatino",
497 "texlive-preview",
498 "texlive-times",
499 "texlive-zapfchan",
500 "texlive-zapfding",
501 );
502
Mauro Carvalho Chehab353290a2019-07-13 08:19:44 -0300503 $map{"latexmk"} = "texlive-latexmk-bin";
504
Mauro Carvalho Chehab27eed922019-07-13 08:19:44 -0300505 # FIXME: add support for installing CJK fonts
506 #
507 # I tried hard, but was unable to find a way to install
508 # "Noto Sans CJK SC" on openSUSE
509
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -0300510 check_rpm_missing(\@suse_tex_pkgs, 2) if ($pdf);
511 check_missing_tex(2) if ($pdf);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300512 check_missing(\%map);
513
514 return if (!$need && !$optional);
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +0100515 printf("You should run:\n") if ($verbose_warn_install);
516 printf("\n\tsudo zypper install --no-recommends $install\n");
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300517}
518
Mauro Carvalho Chehab800d4082017-07-21 13:20:41 -0300519sub give_mageia_hints()
520{
521 my %map = (
522 "python-sphinx" => "python3-sphinx",
Mauro Carvalho Chehab800d4082017-07-21 13:20:41 -0300523 "virtualenv" => "python3-virtualenv",
Mauro Carvalho Chehab800d4082017-07-21 13:20:41 -0300524 "dot" => "graphviz",
525 "convert" => "ImageMagick",
526 "Pod::Usage" => "perl-Pod-Usage",
527 "xelatex" => "texlive",
Mauro Carvalho Chehabd6ebf182020-04-14 18:56:12 +0200528 "rsvg-convert" => "librsvg2",
Mauro Carvalho Chehab800d4082017-07-21 13:20:41 -0300529 );
530
531 my @tex_pkgs = (
532 "texlive-fontsextra",
533 );
534
Mauro Carvalho Chehab353290a2019-07-13 08:19:44 -0300535 $map{"latexmk"} = "texlive-collection-basic";
536
Mauro Carvalho Chehabd6ebf182020-04-14 18:56:12 +0200537 my $packager_cmd;
538 my $noto_sans;
539 if ($system_release =~ /OpenMandriva/) {
540 $packager_cmd = "dnf install";
541 $noto_sans = "noto-sans-cjk-fonts";
542 @tex_pkgs = ( "texlive-collection-fontsextra" );
543 } else {
544 $packager_cmd = "urpmi";
545 $noto_sans = "google-noto-sans-cjk-ttc-fonts";
546 }
547
548
Mauro Carvalho Chehab27eed922019-07-13 08:19:44 -0300549 if ($pdf) {
Mauro Carvalho Chehabd6ebf182020-04-14 18:56:12 +0200550 check_missing_file(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc",
551 "/usr/share/fonts/TTF/NotoSans-Regular.ttf"],
552 $noto_sans, 2);
Mauro Carvalho Chehab27eed922019-07-13 08:19:44 -0300553 }
554
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -0300555 check_rpm_missing(\@tex_pkgs, 2) if ($pdf);
Mauro Carvalho Chehab800d4082017-07-21 13:20:41 -0300556 check_missing(\%map);
557
558 return if (!$need && !$optional);
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +0100559 printf("You should run:\n") if ($verbose_warn_install);
560 printf("\n\tsudo $packager_cmd $install\n");
Mauro Carvalho Chehab800d4082017-07-21 13:20:41 -0300561}
562
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300563sub give_arch_linux_hints()
564{
565 my %map = (
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300566 "virtualenv" => "python-virtualenv",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300567 "dot" => "graphviz",
568 "convert" => "imagemagick",
569 "xelatex" => "texlive-bin",
Louis Taylor0d0da9a2019-11-02 18:45:11 +0000570 "latexmk" => "texlive-core",
Mauro Carvalho Chehab8e7d5d12017-07-17 18:46:40 -0300571 "rsvg-convert" => "extra/librsvg",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300572 );
573
574 my @archlinux_tex_pkgs = (
575 "texlive-core",
576 "texlive-latexextra",
577 "ttf-dejavu",
578 );
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -0300579 check_pacman_missing(\@archlinux_tex_pkgs, 2) if ($pdf);
580
Mauro Carvalho Chehab27eed922019-07-13 08:19:44 -0300581 if ($pdf) {
Jeremy MAUROff8fdb32019-10-02 15:33:39 +0200582 check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc"],
Mauro Carvalho Chehab27eed922019-07-13 08:19:44 -0300583 "noto-fonts-cjk", 2);
584 }
585
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300586 check_missing(\%map);
587
588 return if (!$need && !$optional);
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +0100589 printf("You should run:\n") if ($verbose_warn_install);
590 printf("\n\tsudo pacman -S $install\n");
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300591}
592
593sub give_gentoo_hints()
594{
595 my %map = (
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300596 "virtualenv" => "dev-python/virtualenv",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300597 "dot" => "media-gfx/graphviz",
598 "convert" => "media-gfx/imagemagick",
599 "xelatex" => "dev-texlive/texlive-xetex media-fonts/dejavu",
Mauro Carvalho Chehab8e7d5d12017-07-17 18:46:40 -0300600 "rsvg-convert" => "gnome-base/librsvg",
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300601 );
602
Jeremy MAUROff8fdb32019-10-02 15:33:39 +0200603 check_missing_file(["/usr/share/fonts/dejavu/DejaVuSans.ttf"],
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -0300604 "media-fonts/dejavu", 2) if ($pdf);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300605
Mauro Carvalho Chehab27eed922019-07-13 08:19:44 -0300606 if ($pdf) {
Mauro Carvalho Chehabe45a6312020-04-14 18:56:11 +0200607 check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJKsc-Regular.otf",
608 "/usr/share/fonts/noto-cjk/NotoSerifCJK-Regular.ttc"],
Mauro Carvalho Chehab27eed922019-07-13 08:19:44 -0300609 "media-fonts/noto-cjk", 2);
610 }
611
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300612 check_missing(\%map);
613
614 return if (!$need && !$optional);
Mauro Carvalho Chehabbba1e4c2017-07-17 18:46:41 -0300615
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +0100616 printf("You should run:\n") if ($verbose_warn_install);
617 printf("\n");
Mauro Carvalho Chehab4ea96d52019-07-13 08:19:44 -0300618
619 my $imagemagick = "media-gfx/imagemagick svg png";
620 my $cairo = "media-gfx/graphviz cairo pdf";
621 my $portage_imagemagick = "/etc/portage/package.use/imagemagick";
622 my $portage_cairo = "/etc/portage/package.use/graphviz";
623
Mauro Carvalho Chehabe45a6312020-04-14 18:56:11 +0200624 if (qx(grep imagemagick $portage_imagemagick 2>/dev/null) eq "") {
Mauro Carvalho Chehab4ea96d52019-07-13 08:19:44 -0300625 printf("\tsudo su -c 'echo \"$imagemagick\" > $portage_imagemagick'\n")
626 }
Mauro Carvalho Chehabe45a6312020-04-14 18:56:11 +0200627 if (qx(grep graphviz $portage_cairo 2>/dev/null) eq "") {
Mauro Carvalho Chehab4ea96d52019-07-13 08:19:44 -0300628 printf("\tsudo su -c 'echo \"$cairo\" > $portage_cairo'\n");
629 }
630
Mauro Carvalho Chehabbba1e4c2017-07-17 18:46:41 -0300631 printf("\tsudo emerge --ask $install\n");
632
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300633}
634
635sub check_distros()
636{
637 # Distro-specific hints
638 if ($system_release =~ /Red Hat Enterprise Linux/) {
639 give_redhat_hints;
640 return;
641 }
Mauro Carvalho Chehab9b756a92017-07-24 09:09:24 -0300642 if ($system_release =~ /CentOS/) {
643 give_redhat_hints;
644 return;
645 }
646 if ($system_release =~ /Scientific Linux/) {
647 give_redhat_hints;
648 return;
649 }
650 if ($system_release =~ /Oracle Linux Server/) {
651 give_redhat_hints;
652 return;
653 }
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300654 if ($system_release =~ /Fedora/) {
655 give_redhat_hints;
656 return;
657 }
658 if ($system_release =~ /Ubuntu/) {
659 give_debian_hints;
660 return;
661 }
662 if ($system_release =~ /Debian/) {
663 give_debian_hints;
664 return;
665 }
666 if ($system_release =~ /openSUSE/) {
667 give_opensuse_hints;
668 return;
669 }
Mauro Carvalho Chehab800d4082017-07-21 13:20:41 -0300670 if ($system_release =~ /Mageia/) {
671 give_mageia_hints;
672 return;
673 }
Mauro Carvalho Chehabd6ebf182020-04-14 18:56:12 +0200674 if ($system_release =~ /OpenMandriva/) {
675 give_mageia_hints;
676 return;
677 }
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300678 if ($system_release =~ /Arch Linux/) {
679 give_arch_linux_hints;
680 return;
681 }
682 if ($system_release =~ /Gentoo/) {
683 give_gentoo_hints;
684 return;
685 }
686
687 #
688 # Fall-back to generic hint code for other distros
689 # That's far from ideal, specially for LaTeX dependencies.
690 #
691 my %map = (
692 "sphinx-build" => "sphinx"
693 );
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -0300694 check_missing_tex(2) if ($pdf);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300695 check_missing(\%map);
696 print "I don't know distro $system_release.\n";
697 print "So, I can't provide you a hint with the install procedure.\n";
698 print "There are likely missing dependencies.\n";
699}
700
701#
702# Common dependencies
703#
704
Shuah Khan2730ce02019-09-18 18:37:54 -0600705sub deactivate_help()
706{
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +0100707 printf "\n If you want to exit the virtualenv, you can use:\n";
Shuah Khan2730ce02019-09-18 18:37:54 -0600708 printf "\tdeactivate\n";
709}
710
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200711sub get_virtenv()
712{
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200713 my $ver;
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200714 my $min_activate = "$ENV{'PWD'}/${virtenv_prefix}${min_version}/bin/activate";
715 my @activates = glob "$ENV{'PWD'}/${virtenv_prefix}*/bin/activate";
716
717 @activates = sort {$b cmp $a} @activates;
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200718
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200719 foreach my $f (@activates) {
720 next if ($f lt $min_activate);
721
722 my $sphinx_cmd = $f;
723 $sphinx_cmd =~ s/activate/sphinx-build/;
724 next if (! -f $sphinx_cmd);
725
726 my $ver = get_sphinx_version($sphinx_cmd);
Mauro Carvalho Chehabed2133b2022-07-02 11:11:26 +0100727
728 if (!$ver) {
729 $f =~ s#/bin/activate##;
730 print("Warning: virtual environment $f is not working.\nPython version upgrade? Remove it with:\n\n\trm -rf $f\n\n");
731 }
732
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200733 if ($need_sphinx && ($ver ge $min_version)) {
734 return ($f, $ver);
735 } elsif ($ver gt $cur_version) {
736 return ($f, $ver);
737 }
738 }
739 return ("", "");
740}
741
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200742sub recommend_sphinx_upgrade()
743{
744 my $venv_ver;
745
746 # Avoid running sphinx-builds from venv if $cur_version is good
747 if ($cur_version && ($cur_version ge $rec_version)) {
748 $latest_avail_ver = $cur_version;
749 return;
750 }
751
752 # Get the highest version from sphinx_*/bin/sphinx-build and the
753 # corresponding command to activate the venv/virtenv
Mauro Carvalho Chehab7c2d45a2022-07-02 11:11:25 +0100754 ($activate_cmd, $venv_ver) = get_virtenv();
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200755
756 # Store the highest version from Sphinx existing virtualenvs
757 if (($activate_cmd ne "") && ($venv_ver gt $cur_version)) {
758 $latest_avail_ver = $venv_ver;
759 } else {
760 $latest_avail_ver = $cur_version if ($cur_version);
761 }
762
763 # As we don't know package version of Sphinx, and there's no
764 # virtual environments, don't check if upgrades are needed
765 if (!$virtualenv) {
766 return if (!$latest_avail_ver);
767 }
768
769 # Either there are already a virtual env or a new one should be created
770 $need_pip = 1;
771
Mauro Carvalho Chehab7c2d45a2022-07-02 11:11:25 +0100772 return if (!$latest_avail_ver);
773
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200774 # Return if the reason is due to an upgrade or not
775 if ($latest_avail_ver lt $rec_version) {
776 $rec_sphinx_upgrade = 1;
777 }
Mauro Carvalho Chehab7c2d45a2022-07-02 11:11:25 +0100778
779 return $latest_avail_ver;
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200780}
781
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200782#
783# The logic here is complex, as it have to deal with different versions:
784# - minimal supported version;
785# - minimal PDF version;
786# - recommended version.
787# It also needs to work fine with both distro's package and venv/virtualenv
788sub recommend_sphinx_version($)
789{
790 my $virtualenv_cmd = shift;
791
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200792 # Version is OK. Nothing to do.
Mauro Carvalho Chehab5b27d252022-07-02 11:11:27 +0100793 if ($cur_version && ($cur_version ge $rec_version)) {
794 if ($cur_version lt $min_pdf_version) {
795 print "note: If you want pdf, you need at least Sphinx $min_pdf_version.\n";
796 }
797 return;
798 };
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200799
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200800 if (!$need_sphinx) {
801 # sphinx-build is present and its version is >= $min_version
802
803 #only recommend enabling a newer virtenv version if makes sense.
804 if ($latest_avail_ver gt $cur_version) {
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200805 printf "\nYou may also use the newer Sphinx version $latest_avail_ver with:\n";
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200806 printf "\tdeactivate\n" if ($ENV{'PWD'} =~ /${virtenv_prefix}/);
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200807 printf "\t. $activate_cmd\n";
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200808 deactivate_help();
809
810 return;
811 }
812 return if ($latest_avail_ver ge $rec_version);
813 }
814
815 if (!$virtualenv) {
816 # No sphinx either via package or via virtenv. As we can't
817 # Compare the versions here, just return, recommending the
818 # user to install it from the package distro.
819 return if (!$latest_avail_ver);
820
821 # User doesn't want a virtenv recommendation, but he already
822 # installed one via virtenv with a newer version.
823 # So, print commands to enable it
824 if ($latest_avail_ver gt $cur_version) {
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200825 printf "\nYou may also use the Sphinx virtualenv version $latest_avail_ver with:\n";
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200826 printf "\tdeactivate\n" if ($ENV{'PWD'} =~ /${virtenv_prefix}/);
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200827 printf "\t. $activate_cmd\n";
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200828 deactivate_help();
829
830 return;
831 }
832 print "\n";
833 } else {
834 $need++ if ($need_sphinx);
835 }
836
837 # Suggest newer versions if current ones are too old
Mauro Carvalho Chehab7c2d45a2022-07-02 11:11:25 +0100838 if ($latest_avail_ver && $latest_avail_ver ge $min_version) {
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200839 # If there's a good enough version, ask the user to enable it
840 if ($latest_avail_ver ge $rec_version) {
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200841 printf "\nNeed to activate Sphinx (version $latest_avail_ver) on virtualenv with:\n";
842 printf "\t. $activate_cmd\n";
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200843 deactivate_help();
844
Mauro Carvalho Chehab5b27d252022-07-02 11:11:27 +0100845 if ($latest_avail_ver lt $min_pdf_version) {
846 print "note: If you want pdf, you need at least Sphinx $min_pdf_version.\n";
847 }
848
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200849 return;
850 }
851
852 # Version is above the minimal required one, but may be
853 # below the recommended one. So, print warnings/notes
854
855 if ($latest_avail_ver lt $rec_version) {
856 print "Warning: It is recommended at least Sphinx version $rec_version.\n";
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200857 }
858 }
859
860 # At this point, either it needs Sphinx or upgrade is recommended,
861 # both via pip
862
863 if ($rec_sphinx_upgrade) {
864 if (!$virtualenv) {
865 print "Instead of install/upgrade Python Sphinx pkg, you could use pip/pypi with:\n\n";
866 } else {
867 print "To upgrade Sphinx, use:\n\n";
868 }
869 } else {
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +0100870 print "\nSphinx needs to be installed either:\n1) via pip/pypi with:\n\n";
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200871 }
872
873 $python_cmd = find_python_no_venv();
874
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200875 printf "\t$virtualenv_cmd $virtenv_dir\n";
876
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200877 printf "\t. $virtenv_dir/bin/activate\n";
878 printf "\tpip install -r $requirement_file\n";
879 deactivate_help();
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +0100880
881 printf "\n2) As a package with:\n";
882
883 my $old_need = $need;
884 my $old_optional = $optional;
885 %missing = ();
886 $pdf = 0;
887 $optional = 0;
888 $install = "";
889 $verbose_warn_install = 0;
890
891 add_package("python-sphinx", 0);
Mauro Carvalho Chehab6a5d7322022-07-02 11:11:28 +0100892
893 check_distros();
894
895 $need = $old_need;
896 $optional = $old_optional;
897
Mauro Carvalho Chehab02bba8c2022-07-02 11:11:29 +0100898 printf "\n Please note that Sphinx >= 3.0 will currently produce false-positive\n";
899 printf " warning when the same name is used for more than one type (functions,\n";
900 printf " structs, enums,...). This is known Sphinx bug. For more details, see:\n";
901 printf "\thttps://github.com/sphinx-doc/sphinx/pull/8313\n";
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200902}
903
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300904sub check_needs()
905{
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200906 # Check if Sphinx is already accessible from current environment
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300907 check_sphinx();
Mauro Carvalho Chehab9b88ad52019-05-29 20:09:26 -0300908
909 if ($system_release) {
Mauro Carvalho Chehabec43a272020-04-21 18:27:58 +0200910 print "Detected OS: $system_release.\n";
Mauro Carvalho Chehab9b88ad52019-05-29 20:09:26 -0300911 } else {
Mauro Carvalho Chehabec43a272020-04-21 18:27:58 +0200912 print "Unknown OS\n";
Mauro Carvalho Chehab9b88ad52019-05-29 20:09:26 -0300913 }
Mauro Carvalho Chehabec43a272020-04-21 18:27:58 +0200914 printf "Sphinx version: %s\n\n", $cur_version if ($cur_version);
Mauro Carvalho Chehab9b88ad52019-05-29 20:09:26 -0300915
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200916 # Check python command line, trying first python3
917 $python_cmd = findprog("python3");
918 $python_cmd = check_program("python", 0) if (!$python_cmd);
919
920 # Check the type of virtual env, depending on Python version
921 if ($python_cmd) {
922 if ($virtualenv) {
923 my $tmp = qx($python_cmd --version 2>&1);
924 if ($tmp =~ m/(\d+\.)(\d+\.)/) {
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200925 if ($1 < 3) {
Jonathan Corbet4217e502021-02-01 17:17:14 -0700926 # Fail if it finds python2 (or worse)
927 die "Python 3 is required to build the kernel docs\n";
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200928 }
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200929 if ($1 == 3 && $2 < 3) {
930 # Need Python 3.3 or upper for venv
931 $need_virtualenv = 1;
932 }
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200933 } else {
934 die "Warning: couldn't identify $python_cmd version!";
935 }
936 } else {
937 add_package("python-sphinx", 0);
938 }
939 }
940
Mauro Carvalho Chehab7c2d45a2022-07-02 11:11:25 +0100941 my $venv_ver = recommend_sphinx_upgrade();
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200942
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200943 my $virtualenv_cmd;
Mauro Carvalho Chehaba5f785f2021-05-25 15:27:28 +0200944
945 if ($need_pip) {
946 # Set virtualenv command line, if python < 3.3
947 if ($need_virtualenv) {
948 $virtualenv_cmd = findprog("virtualenv-3");
949 $virtualenv_cmd = findprog("virtualenv-3.5") if (!$virtualenv_cmd);
950 if (!$virtualenv_cmd) {
951 check_program("virtualenv", 0);
952 $virtualenv_cmd = "virtualenv";
953 }
954 } else {
955 $virtualenv_cmd = "$python_cmd -m venv";
956 check_python_module("ensurepip", 0);
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200957 }
958 }
959
Mauro Carvalho Chehab9b88ad52019-05-29 20:09:26 -0300960 # Check for needed programs/tools
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300961 check_perl_module("Pod::Usage", 0);
962 check_program("make", 0);
963 check_program("gcc", 0);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300964 check_program("dot", 1);
965 check_program("convert", 1);
Mauro Carvalho Chehab56e5a632019-07-13 09:37:16 -0300966
967 # Extra PDF files - should use 2 for is_optional
968 check_program("xelatex", 2) if ($pdf);
969 check_program("rsvg-convert", 2) if ($pdf);
970 check_program("latexmk", 2) if ($pdf);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300971
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200972 # Do distro-specific checks and output distro-install commands
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300973 check_distros();
974
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200975 if (!$python_cmd) {
976 if ($need == 1) {
977 die "Can't build as $need mandatory dependency is missing";
978 } elsif ($need) {
979 die "Can't build as $need mandatory dependencies are missing";
980 }
981 }
982
983 # Check if sphinx-build is called sphinx-build-3
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300984 if ($need_symlink) {
985 printf "\tsudo ln -sf %s /usr/bin/sphinx-build\n\n",
986 which("sphinx-build-3");
987 }
Mauro Carvalho Chehab2f9c5022020-04-14 18:56:13 +0200988
Mauro Carvalho Chehabe5089912021-05-25 15:27:27 +0200989 recommend_sphinx_version($virtualenv_cmd);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300990 printf "\n";
991
Bjorn Helgaas54002b52019-05-30 16:59:14 -0500992 print "All optional dependencies are met.\n" if (!$optional);
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -0300993
994 if ($need == 1) {
995 die "Can't build as $need mandatory dependency is missing";
996 } elsif ($need) {
997 die "Can't build as $need mandatory dependencies are missing";
998 }
999
1000 print "Needed package dependencies are met.\n";
1001}
1002
1003#
1004# Main
1005#
1006
1007while (@ARGV) {
1008 my $arg = shift(@ARGV);
1009
1010 if ($arg eq "--no-virtualenv") {
1011 $virtualenv = 0;
1012 } elsif ($arg eq "--no-pdf"){
1013 $pdf = 0;
Mauro Carvalho Chehab9b88ad52019-05-29 20:09:26 -03001014 } elsif ($arg eq "--version-check"){
1015 $version_check = 1;
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -03001016 } else {
Mauro Carvalho Chehab9b88ad52019-05-29 20:09:26 -03001017 print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf> <--version-check>\n\n";
1018 print "Where:\n";
1019 print "\t--no-virtualenv\t- Recommend installing Sphinx instead of using a virtualenv\n";
1020 print "\t--version-check\t- if version is compatible, don't check for missing dependencies\n";
1021 print "\t--no-pdf\t- don't check for dependencies required to build PDF docs\n\n";
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -03001022 exit -1;
1023 }
1024}
1025
1026#
1027# Determine the system type. There's no standard unique way that would
1028# work with all distros with a minimal package install. So, several
1029# methods are used here.
1030#
1031# By default, it will use lsb_release function. If not available, it will
1032# fail back to reading the known different places where the distro name
1033# is stored
1034#
1035
1036$system_release = qx(lsb_release -d) if which("lsb_release");
1037$system_release =~ s/Description:\s*// if ($system_release);
1038$system_release = catcheck("/etc/system-release") if !$system_release;
1039$system_release = catcheck("/etc/redhat-release") if !$system_release;
1040$system_release = catcheck("/etc/lsb-release") if !$system_release;
1041$system_release = catcheck("/etc/gentoo-release") if !$system_release;
Mauro Carvalho Chehabd14d0c12020-04-14 18:56:08 +02001042
1043# This seems more common than LSB these days
1044if (!$system_release) {
1045 my %os_var;
1046 if (open IN, "cat /etc/os-release|") {
1047 while (<IN>) {
1048 if (m/^([\w\d\_]+)=\"?([^\"]*)\"?\n/) {
1049 $os_var{$1}=$2;
1050 }
1051 }
1052 $system_release = $os_var{"NAME"};
1053 if (defined($os_var{"VERSION_ID"})) {
1054 $system_release .= " " . $os_var{"VERSION_ID"} if (defined($os_var{"VERSION_ID"}));
1055 } else {
1056 $system_release .= " " . $os_var{"VERSION"};
1057 }
1058 }
1059}
Mauro Carvalho Chehab24071ac2017-07-17 18:46:36 -03001060$system_release = catcheck("/etc/issue") if !$system_release;
1061$system_release =~ s/\s+$//;
1062
1063check_needs;