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