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