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