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