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