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