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 <mchehab@kernel.org> 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 $rel = $1 if ($system_release =~ /release\s+(\d+)/); 425 426 if (!($system_release =~ /Fedora/)) { 427 $map{"virtualenv"} = "python-virtualenv"; 428 429 if ($rel && $rel < 8) { 430 $old = 1; 431 $pdf = 0; 432 433 printf("Note: texlive packages on RHEL/CENTOS <= 7 are incomplete. Can't support PDF output\n"); 434 printf("If you want to build PDF, please read:\n"); 435 printf("\thttps://www.systutorials.com/241660/how-to-install-tex-live-on-centos-7-linux/\n"); 436 } 437 } else { 438 if ($rel && $rel < 26) { 439 $old = 1; 440 } 441 } 442 if (!$rel) { 443 printf("Couldn't identify release number\n"); 444 $old = 1; 445 $pdf = 0; 446 } 447 448 if ($pdf) { 449 check_missing_file(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc"], 450 "google-noto-sans-cjk-ttc-fonts", 2); 451 } 452 453 check_rpm_missing(\@fedora26_opt_pkgs, 2) if ($pdf && !$old); 454 check_rpm_missing(\@fedora_tex_pkgs, 2) if ($pdf); 455 check_missing_tex(2) if ($pdf); 456 check_missing(\%map); 457 458 return if (!$need && !$optional); 459 460 if (!$old) { 461 # dnf, for Fedora 18+ 462 printf("You should run:\n") if ($verbose_warn_install); 463 printf("\n\tsudo dnf install -y $install\n"); 464 } else { 465 # yum, for RHEL (and clones) or Fedora version < 18 466 printf("You should run:\n") if ($verbose_warn_install); 467 printf("\n\tsudo yum install -y $install\n"); 468 } 469} 470 471sub give_opensuse_hints() 472{ 473 my %map = ( 474 "python-sphinx" => "python3-sphinx", 475 "virtualenv" => "python3-virtualenv", 476 "dot" => "graphviz", 477 "convert" => "ImageMagick", 478 "Pod::Usage" => "perl-Pod-Usage", 479 "xelatex" => "texlive-xetex-bin", 480 ); 481 482 # On Tumbleweed, this package is also named rsvg-convert 483 $map{"rsvg-convert"} = "rsvg-view" if (!($system_release =~ /Tumbleweed/)); 484 485 my @suse_tex_pkgs = ( 486 "texlive-babel-english", 487 "texlive-caption", 488 "texlive-colortbl", 489 "texlive-courier", 490 "texlive-dvips", 491 "texlive-helvetic", 492 "texlive-makeindex", 493 "texlive-metafont", 494 "texlive-metapost", 495 "texlive-palatino", 496 "texlive-preview", 497 "texlive-times", 498 "texlive-zapfchan", 499 "texlive-zapfding", 500 ); 501 502 $map{"latexmk"} = "texlive-latexmk-bin"; 503 504 # FIXME: add support for installing CJK fonts 505 # 506 # I tried hard, but was unable to find a way to install 507 # "Noto Sans CJK SC" on openSUSE 508 509 check_rpm_missing(\@suse_tex_pkgs, 2) if ($pdf); 510 check_missing_tex(2) if ($pdf); 511 check_missing(\%map); 512 513 return if (!$need && !$optional); 514 printf("You should run:\n") if ($verbose_warn_install); 515 printf("\n\tsudo zypper install --no-recommends $install\n"); 516} 517 518sub give_mageia_hints() 519{ 520 my %map = ( 521 "python-sphinx" => "python3-sphinx", 522 "virtualenv" => "python3-virtualenv", 523 "dot" => "graphviz", 524 "convert" => "ImageMagick", 525 "Pod::Usage" => "perl-Pod-Usage", 526 "xelatex" => "texlive", 527 "rsvg-convert" => "librsvg2", 528 ); 529 530 my @tex_pkgs = ( 531 "texlive-fontsextra", 532 ); 533 534 $map{"latexmk"} = "texlive-collection-basic"; 535 536 my $packager_cmd; 537 my $noto_sans; 538 if ($system_release =~ /OpenMandriva/) { 539 $packager_cmd = "dnf install"; 540 $noto_sans = "noto-sans-cjk-fonts"; 541 @tex_pkgs = ( "texlive-collection-fontsextra" ); 542 } else { 543 $packager_cmd = "urpmi"; 544 $noto_sans = "google-noto-sans-cjk-ttc-fonts"; 545 } 546 547 548 if ($pdf) { 549 check_missing_file(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc", 550 "/usr/share/fonts/TTF/NotoSans-Regular.ttf"], 551 $noto_sans, 2); 552 } 553 554 check_rpm_missing(\@tex_pkgs, 2) if ($pdf); 555 check_missing(\%map); 556 557 return if (!$need && !$optional); 558 printf("You should run:\n") if ($verbose_warn_install); 559 printf("\n\tsudo $packager_cmd $install\n"); 560} 561 562sub give_arch_linux_hints() 563{ 564 my %map = ( 565 "virtualenv" => "python-virtualenv", 566 "dot" => "graphviz", 567 "convert" => "imagemagick", 568 "xelatex" => "texlive-bin", 569 "latexmk" => "texlive-core", 570 "rsvg-convert" => "extra/librsvg", 571 ); 572 573 my @archlinux_tex_pkgs = ( 574 "texlive-core", 575 "texlive-latexextra", 576 "ttf-dejavu", 577 ); 578 check_pacman_missing(\@archlinux_tex_pkgs, 2) if ($pdf); 579 580 if ($pdf) { 581 check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc"], 582 "noto-fonts-cjk", 2); 583 } 584 585 check_missing(\%map); 586 587 return if (!$need && !$optional); 588 printf("You should run:\n") if ($verbose_warn_install); 589 printf("\n\tsudo pacman -S $install\n"); 590} 591 592sub give_gentoo_hints() 593{ 594 my %map = ( 595 "virtualenv" => "dev-python/virtualenv", 596 "dot" => "media-gfx/graphviz", 597 "convert" => "media-gfx/imagemagick", 598 "xelatex" => "dev-texlive/texlive-xetex media-fonts/dejavu", 599 "rsvg-convert" => "gnome-base/librsvg", 600 ); 601 602 check_missing_file(["/usr/share/fonts/dejavu/DejaVuSans.ttf"], 603 "media-fonts/dejavu", 2) if ($pdf); 604 605 if ($pdf) { 606 check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJKsc-Regular.otf", 607 "/usr/share/fonts/noto-cjk/NotoSerifCJK-Regular.ttc"], 608 "media-fonts/noto-cjk", 2); 609 } 610 611 check_missing(\%map); 612 613 return if (!$need && !$optional); 614 615 printf("You should run:\n") if ($verbose_warn_install); 616 printf("\n"); 617 618 my $imagemagick = "media-gfx/imagemagick svg png"; 619 my $cairo = "media-gfx/graphviz cairo pdf"; 620 my $portage_imagemagick = "/etc/portage/package.use/imagemagick"; 621 my $portage_cairo = "/etc/portage/package.use/graphviz"; 622 623 if (qx(grep imagemagick $portage_imagemagick 2>/dev/null) eq "") { 624 printf("\tsudo su -c 'echo \"$imagemagick\" > $portage_imagemagick'\n") 625 } 626 if (qx(grep graphviz $portage_cairo 2>/dev/null) eq "") { 627 printf("\tsudo su -c 'echo \"$cairo\" > $portage_cairo'\n"); 628 } 629 630 printf("\tsudo emerge --ask $install\n"); 631 632} 633 634sub check_distros() 635{ 636 # Distro-specific hints 637 if ($system_release =~ /Red Hat Enterprise Linux/) { 638 give_redhat_hints; 639 return; 640 } 641 if ($system_release =~ /CentOS/) { 642 give_redhat_hints; 643 return; 644 } 645 if ($system_release =~ /Scientific Linux/) { 646 give_redhat_hints; 647 return; 648 } 649 if ($system_release =~ /Oracle Linux Server/) { 650 give_redhat_hints; 651 return; 652 } 653 if ($system_release =~ /Fedora/) { 654 give_redhat_hints; 655 return; 656 } 657 if ($system_release =~ /Ubuntu/) { 658 give_debian_hints; 659 return; 660 } 661 if ($system_release =~ /Debian/) { 662 give_debian_hints; 663 return; 664 } 665 if ($system_release =~ /openSUSE/) { 666 give_opensuse_hints; 667 return; 668 } 669 if ($system_release =~ /Mageia/) { 670 give_mageia_hints; 671 return; 672 } 673 if ($system_release =~ /OpenMandriva/) { 674 give_mageia_hints; 675 return; 676 } 677 if ($system_release =~ /Arch Linux/) { 678 give_arch_linux_hints; 679 return; 680 } 681 if ($system_release =~ /Gentoo/) { 682 give_gentoo_hints; 683 return; 684 } 685 686 # 687 # Fall-back to generic hint code for other distros 688 # That's far from ideal, specially for LaTeX dependencies. 689 # 690 my %map = ( 691 "sphinx-build" => "sphinx" 692 ); 693 check_missing_tex(2) if ($pdf); 694 check_missing(\%map); 695 print "I don't know distro $system_release.\n"; 696 print "So, I can't provide you a hint with the install procedure.\n"; 697 print "There are likely missing dependencies.\n"; 698} 699 700# 701# Common dependencies 702# 703 704sub deactivate_help() 705{ 706 printf "\n If you want to exit the virtualenv, you can use:\n"; 707 printf "\tdeactivate\n"; 708} 709 710sub get_virtenv() 711{ 712 my $ver; 713 my $min_activate = "$ENV{'PWD'}/${virtenv_prefix}${min_version}/bin/activate"; 714 my @activates = glob "$ENV{'PWD'}/${virtenv_prefix}*/bin/activate"; 715 716 @activates = sort {$b cmp $a} @activates; 717 718 foreach my $f (@activates) { 719 next if ($f lt $min_activate); 720 721 my $sphinx_cmd = $f; 722 $sphinx_cmd =~ s/activate/sphinx-build/; 723 next if (! -f $sphinx_cmd); 724 725 my $ver = get_sphinx_version($sphinx_cmd); 726 727 if (!$ver) { 728 $f =~ s#/bin/activate##; 729 print("Warning: virtual environment $f is not working.\nPython version upgrade? Remove it with:\n\n\trm -rf $f\n\n"); 730 } 731 732 if ($need_sphinx && ($ver ge $min_version)) { 733 return ($f, $ver); 734 } elsif ($ver gt $cur_version) { 735 return ($f, $ver); 736 } 737 } 738 return ("", ""); 739} 740 741sub recommend_sphinx_upgrade() 742{ 743 my $venv_ver; 744 745 # Avoid running sphinx-builds from venv if $cur_version is good 746 if ($cur_version && ($cur_version ge $rec_version)) { 747 $latest_avail_ver = $cur_version; 748 return; 749 } 750 751 # Get the highest version from sphinx_*/bin/sphinx-build and the 752 # corresponding command to activate the venv/virtenv 753 ($activate_cmd, $venv_ver) = get_virtenv(); 754 755 # Store the highest version from Sphinx existing virtualenvs 756 if (($activate_cmd ne "") && ($venv_ver gt $cur_version)) { 757 $latest_avail_ver = $venv_ver; 758 } else { 759 $latest_avail_ver = $cur_version if ($cur_version); 760 } 761 762 # As we don't know package version of Sphinx, and there's no 763 # virtual environments, don't check if upgrades are needed 764 if (!$virtualenv) { 765 return if (!$latest_avail_ver); 766 } 767 768 # Either there are already a virtual env or a new one should be created 769 $need_pip = 1; 770 771 return if (!$latest_avail_ver); 772 773 # Return if the reason is due to an upgrade or not 774 if ($latest_avail_ver lt $rec_version) { 775 $rec_sphinx_upgrade = 1; 776 } 777 778 return $latest_avail_ver; 779} 780 781# 782# The logic here is complex, as it have to deal with different versions: 783# - minimal supported version; 784# - minimal PDF version; 785# - recommended version. 786# It also needs to work fine with both distro's package and venv/virtualenv 787sub recommend_sphinx_version($) 788{ 789 my $virtualenv_cmd = shift; 790 791 # Version is OK. Nothing to do. 792 if ($cur_version && ($cur_version ge $rec_version)) { 793 return; 794 }; 795 796 if (!$need_sphinx) { 797 # sphinx-build is present and its version is >= $min_version 798 799 #only recommend enabling a newer virtenv version if makes sense. 800 if ($latest_avail_ver gt $cur_version) { 801 printf "\nYou may also use the newer Sphinx version $latest_avail_ver with:\n"; 802 printf "\tdeactivate\n" if ($ENV{'PWD'} =~ /${virtenv_prefix}/); 803 printf "\t. $activate_cmd\n"; 804 deactivate_help(); 805 806 return; 807 } 808 return if ($latest_avail_ver ge $rec_version); 809 } 810 811 if (!$virtualenv) { 812 # No sphinx either via package or via virtenv. As we can't 813 # Compare the versions here, just return, recommending the 814 # user to install it from the package distro. 815 return if (!$latest_avail_ver); 816 817 # User doesn't want a virtenv recommendation, but he already 818 # installed one via virtenv with a newer version. 819 # So, print commands to enable it 820 if ($latest_avail_ver gt $cur_version) { 821 printf "\nYou may also use the Sphinx virtualenv version $latest_avail_ver with:\n"; 822 printf "\tdeactivate\n" if ($ENV{'PWD'} =~ /${virtenv_prefix}/); 823 printf "\t. $activate_cmd\n"; 824 deactivate_help(); 825 826 return; 827 } 828 print "\n"; 829 } else { 830 $need++ if ($need_sphinx); 831 } 832 833 # Suggest newer versions if current ones are too old 834 if ($latest_avail_ver && $latest_avail_ver ge $min_version) { 835 # If there's a good enough version, ask the user to enable it 836 if ($latest_avail_ver ge $rec_version) { 837 printf "\nNeed to activate Sphinx (version $latest_avail_ver) on virtualenv with:\n"; 838 printf "\t. $activate_cmd\n"; 839 deactivate_help(); 840 841 return; 842 } 843 844 # Version is above the minimal required one, but may be 845 # below the recommended one. So, print warnings/notes 846 847 if ($latest_avail_ver lt $rec_version) { 848 print "Warning: It is recommended at least Sphinx version $rec_version.\n"; 849 } 850 } 851 852 # At this point, either it needs Sphinx or upgrade is recommended, 853 # both via pip 854 855 if ($rec_sphinx_upgrade) { 856 if (!$virtualenv) { 857 print "Instead of install/upgrade Python Sphinx pkg, you could use pip/pypi with:\n\n"; 858 } else { 859 print "To upgrade Sphinx, use:\n\n"; 860 } 861 } else { 862 print "\nSphinx needs to be installed either:\n1) via pip/pypi with:\n\n"; 863 } 864 865 $python_cmd = find_python_no_venv(); 866 867 printf "\t$virtualenv_cmd $virtenv_dir\n"; 868 869 printf "\t. $virtenv_dir/bin/activate\n"; 870 printf "\tpip install -r $requirement_file\n"; 871 deactivate_help(); 872 873 printf "\n2) As a package with:\n"; 874 875 my $old_need = $need; 876 my $old_optional = $optional; 877 %missing = (); 878 $pdf = 0; 879 $optional = 0; 880 $install = ""; 881 $verbose_warn_install = 0; 882 883 add_package("python-sphinx", 0); 884 885 check_distros(); 886 887 $need = $old_need; 888 $optional = $old_optional; 889 890 printf "\n Please note that Sphinx >= 3.0 will currently produce false-positive\n"; 891 printf " warning when the same name is used for more than one type (functions,\n"; 892 printf " structs, enums,...). This is known Sphinx bug. For more details, see:\n"; 893 printf "\thttps://github.com/sphinx-doc/sphinx/pull/8313\n"; 894} 895 896sub check_needs() 897{ 898 # Check if Sphinx is already accessible from current environment 899 check_sphinx(); 900 901 if ($system_release) { 902 print "Detected OS: $system_release.\n"; 903 } else { 904 print "Unknown OS\n"; 905 } 906 printf "Sphinx version: %s\n\n", $cur_version if ($cur_version); 907 908 # Check python command line, trying first python3 909 $python_cmd = findprog("python3"); 910 $python_cmd = check_program("python", 0) if (!$python_cmd); 911 912 # Check the type of virtual env, depending on Python version 913 if ($python_cmd) { 914 if ($virtualenv) { 915 my $tmp = qx($python_cmd --version 2>&1); 916 if ($tmp =~ m/(\d+\.)(\d+\.)/) { 917 if ($1 < 3) { 918 # Fail if it finds python2 (or worse) 919 die "Python 3 is required to build the kernel docs\n"; 920 } 921 if ($1 == 3 && $2 < 3) { 922 # Need Python 3.3 or upper for venv 923 $need_virtualenv = 1; 924 } 925 } else { 926 die "Warning: couldn't identify $python_cmd version!"; 927 } 928 } else { 929 add_package("python-sphinx", 0); 930 } 931 } 932 933 my $venv_ver = recommend_sphinx_upgrade(); 934 935 my $virtualenv_cmd; 936 937 if ($need_pip) { 938 # Set virtualenv command line, if python < 3.3 939 if ($need_virtualenv) { 940 $virtualenv_cmd = findprog("virtualenv-3"); 941 $virtualenv_cmd = findprog("virtualenv-3.5") if (!$virtualenv_cmd); 942 if (!$virtualenv_cmd) { 943 check_program("virtualenv", 0); 944 $virtualenv_cmd = "virtualenv"; 945 } 946 } else { 947 $virtualenv_cmd = "$python_cmd -m venv"; 948 check_python_module("ensurepip", 0); 949 } 950 } 951 952 # Check for needed programs/tools 953 check_perl_module("Pod::Usage", 0); 954 check_program("make", 0); 955 check_program("gcc", 0); 956 check_program("dot", 1); 957 check_program("convert", 1); 958 959 # Extra PDF files - should use 2 for is_optional 960 check_program("xelatex", 2) if ($pdf); 961 check_program("rsvg-convert", 2) if ($pdf); 962 check_program("latexmk", 2) if ($pdf); 963 964 # Do distro-specific checks and output distro-install commands 965 check_distros(); 966 967 if (!$python_cmd) { 968 if ($need == 1) { 969 die "Can't build as $need mandatory dependency is missing"; 970 } elsif ($need) { 971 die "Can't build as $need mandatory dependencies are missing"; 972 } 973 } 974 975 # Check if sphinx-build is called sphinx-build-3 976 if ($need_symlink) { 977 printf "\tsudo ln -sf %s /usr/bin/sphinx-build\n\n", 978 which("sphinx-build-3"); 979 } 980 981 recommend_sphinx_version($virtualenv_cmd); 982 printf "\n"; 983 984 print "All optional dependencies are met.\n" if (!$optional); 985 986 if ($need == 1) { 987 die "Can't build as $need mandatory dependency is missing"; 988 } elsif ($need) { 989 die "Can't build as $need mandatory dependencies are missing"; 990 } 991 992 print "Needed package dependencies are met.\n"; 993} 994 995# 996# Main 997# 998 999while (@ARGV) { 1000 my $arg = shift(@ARGV); 1001 1002 if ($arg eq "--no-virtualenv") { 1003 $virtualenv = 0; 1004 } elsif ($arg eq "--no-pdf"){ 1005 $pdf = 0; 1006 } elsif ($arg eq "--version-check"){ 1007 $version_check = 1; 1008 } else { 1009 print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf> <--version-check>\n\n"; 1010 print "Where:\n"; 1011 print "\t--no-virtualenv\t- Recommend installing Sphinx instead of using a virtualenv\n"; 1012 print "\t--version-check\t- if version is compatible, don't check for missing dependencies\n"; 1013 print "\t--no-pdf\t- don't check for dependencies required to build PDF docs\n\n"; 1014 exit -1; 1015 } 1016} 1017 1018# 1019# Determine the system type. There's no standard unique way that would 1020# work with all distros with a minimal package install. So, several 1021# methods are used here. 1022# 1023# By default, it will use lsb_release function. If not available, it will 1024# fail back to reading the known different places where the distro name 1025# is stored 1026# 1027 1028$system_release = qx(lsb_release -d) if which("lsb_release"); 1029$system_release =~ s/Description:\s*// if ($system_release); 1030$system_release = catcheck("/etc/system-release") if !$system_release; 1031$system_release = catcheck("/etc/redhat-release") if !$system_release; 1032$system_release = catcheck("/etc/lsb-release") if !$system_release; 1033$system_release = catcheck("/etc/gentoo-release") if !$system_release; 1034 1035# This seems more common than LSB these days 1036if (!$system_release) { 1037 my %os_var; 1038 if (open IN, "cat /etc/os-release|") { 1039 while (<IN>) { 1040 if (m/^([\w\d\_]+)=\"?([^\"]*)\"?\n/) { 1041 $os_var{$1}=$2; 1042 } 1043 } 1044 $system_release = $os_var{"NAME"}; 1045 if (defined($os_var{"VERSION_ID"})) { 1046 $system_release .= " " . $os_var{"VERSION_ID"} if (defined($os_var{"VERSION_ID"})); 1047 } else { 1048 $system_release .= " " . $os_var{"VERSION"}; 1049 } 1050 } 1051} 1052$system_release = catcheck("/etc/issue") if !$system_release; 1053$system_release =~ s/\s+$//; 1054 1055check_needs; 1056