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