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