]>
git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blob - scripts/sphinx-pre-install
b5f9fd5b28808868bccca9818460674ee6549785
2 # SPDX-License-Identifier: GPL-2.0-or-later
5 # Copyright (c) 2017-2020 Mauro Carvalho Chehab <mchehab@kernel.org>
9 $prefix = "$ENV{'srctree'}/" if ($ENV{'srctree'});
11 my $conf = $prefix . "Documentation/conf.py";
12 my $requirement_file = $prefix . "Documentation/sphinx/requirements.txt";
13 my $virtenv_prefix = "sphinx_";
26 my $need_virtualenv = 0;
27 my $rec_sphinx_upgrade = 0;
33 my $rec_version = "1.7.9"; # PDF won't build here
34 my $min_pdf_version = "2.4.4"; # Min version where pdf builds
37 # Command line arguments
42 my $version_check = 0;
45 # List of required texlive packages on Fedora and OpenSuse
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',
82 # Subroutines that checks if a feature exists
89 foreach my $prog (sort keys %missing) {
90 my $is_optional = $missing{$prog};
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.
96 # So, we need to ignore the packages that distros would
97 # need for LaTeX to work
98 if ($is_optional == 2 && !$pdf) {
104 print "Warning: better to also install \"$prog\".\n";
106 print "ERROR
: please install
\"$prog\", otherwise, build won't work.\n";
108 if (defined($map{$prog})) {
109 $install .= " " . $map{$prog};
111 $install .= " " . $prog;
121 my $is_optional = shift;
123 $missing{$package} = $is_optional;
131 sub check_missing_file
($$$)
135 my $is_optional = shift;
141 add_package
($package, $is_optional);
146 foreach(split(/:/, $ENV{PATH
})) {
147 return "$_/$_[0]" if(-x
"$_/$_[0]");
151 sub find_python_no_venv
()
155 my $cur_dir = qx(pwd);
156 $cur_dir =~ s/\s+$//;
158 foreach my $dir (split(/:/, $ENV{PATH
})) {
159 next if ($dir =~ m
,($cur_dir)/sphinx
,);
160 return "$dir/python3" if(-x
"$dir/python3");
162 foreach my $dir (split(/:/, $ENV{PATH
})) {
163 next if ($dir =~ m
,($cur_dir)/sphinx
,);
164 return "$dir/python" if(-x
"$dir/python");
169 sub check_program
($$)
172 my $is_optional = shift;
174 return $prog if findprog
($prog);
176 add_package
($prog, $is_optional);
179 sub check_perl_module
($$)
182 my $is_optional = shift;
184 my $err = system("perl -M$prog -e 1 2>/dev/null /dev/null");
185 return if ($err == 0);
187 add_package
($prog, $is_optional);
190 sub check_python_module
($$)
193 my $is_optional = shift;
195 return if (!$python_cmd);
197 my $err = system("$python_cmd -c 'import $prog' 2>/dev/null /dev/null");
198 return if ($err == 0);
200 add_package
($prog, $is_optional);
203 sub check_rpm_missing
($$)
206 my $is_optional = $_[1];
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);
214 sub check_pacman_missing
($$)
217 my $is_optional = $_[1];
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);
225 sub check_missing_tex
($)
227 my $is_optional = shift;
228 my $kpsewhich = findprog
("kpsewhich");
230 foreach my $prog(keys %texlive) {
231 my $package = $texlive{$prog};
233 add_package
($package, $is_optional);
236 my $file = qx($kpsewhich $prog);
237 add_package
($package, $is_optional) if ($file =~ /^\s*$/);
241 sub get_sphinx_fname
()
243 my $fname = "sphinx-build";
244 return $fname if findprog
($fname);
246 $fname = "sphinx-build-3";
247 if (findprog
($fname)) {
255 sub get_sphinx_version
($)
260 open IN
, "$cmd --version 2>&1 |";
262 if (m/^\s*sphinx-build\s+([\d\.]+)(\+\/[\da-f
]+)?
$/) {
266 # Sphinx 1.2.x uses a different format
267 if (m/^\s*Sphinx.*\s+([\d\.]+)$/) {
280 open IN
, $conf or die "Can't open $conf";
282 if (m/^\s*needs_sphinx\s*=\s*[\'\"]([\d\.]+)[\'\"]/) {
289 die "Can't get needs_sphinx version from $conf" if (!$min_version);
291 open IN
, $requirement_file or die "Can't open $requirement_file";
293 if (m/^\s*Sphinx\s*==\s*([\d\.]+)$/) {
300 die "Can't get default sphinx version from $requirement_file" if (!$default_version);
302 $virtenv_dir = $virtenv_prefix . $default_version;
304 my $sphinx = get_sphinx_fname
();
310 $cur_version = get_sphinx_version
($sphinx);
311 die ("$sphinx returned an error") if (!$cur_version);
313 die "$sphinx didn't return its version" if (!$cur_version);
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;
322 if ($cur_version lt $rec_version) {
323 $rec_sphinx_upgrade = 1;
327 # On version check mode, just assume Sphinx has all mandatory deps
328 exit (0) if ($version_check);
332 # Ancillary subroutines
338 $res = qx(cat $_[0]) if (-r
$_[0]);
345 my @path = split ":", $ENV{PATH
};
347 foreach my $dir(@path) {
348 my $name = $dir.'/'.$file;
349 return $name if (-x
$name );
355 # Subroutines that check distro-specific hints
358 sub give_debian_hints
()
361 "python-sphinx" => "python3-sphinx",
362 "sphinx_rtd_theme" => "python3-sphinx-rtd-theme",
363 "ensurepip" => "python3-venv",
364 "virtualenv" => "virtualenv",
366 "convert" => "imagemagick",
367 "Pod::Usage" => "perl-modules",
368 "xelatex" => "texlive-xetex",
369 "rsvg-convert" => "librsvg2-bin",
373 check_missing_file
(["/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf"],
376 check_missing_file
(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc",
377 "/usr/share/fonts/opentype/noto/NotoSansCJK-Regular.ttc",
378 "/usr/share/fonts/opentype/noto/NotoSerifCJK-Regular.ttc"],
379 "fonts-noto-cjk", 2);
382 check_program
("dvipng", 2) if ($pdf);
383 check_missing
(\
%map);
385 return if (!$need && !$optional);
386 printf("You should run:\n\n\tsudo apt-get install $install\n");
389 sub give_redhat_hints
()
392 "python-sphinx" => "python3-sphinx",
393 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme",
394 "virtualenv" => "python3-virtualenv",
396 "convert" => "ImageMagick",
397 "Pod::Usage" => "perl-Pod-Usage",
398 "xelatex" => "texlive-xetex-bin",
399 "rsvg-convert" => "librsvg2-tools",
402 my @fedora26_opt_pkgs = (
403 "graphviz-gd", # Fedora 26: needed for PDF support
406 my @fedora_tex_pkgs = (
407 "texlive-collection-fontsrecommended",
408 "texlive-collection-latex",
411 "dejavu-serif-fonts",
412 "dejavu-sans-mono-fonts",
416 # Checks valid for RHEL/CentOS version 7.x.
420 $rel = $1 if ($system_release =~ /release\s+(\d+)/);
422 if (!($system_release =~ /Fedora/)) {
423 $map{"virtualenv"} = "python-virtualenv";
425 if ($rel && $rel < 8) {
429 printf("Note: texlive packages on RHEL/CENTOS <= 7 are incomplete. Can't support PDF output\n");
430 printf("If you want to build PDF, please read:\n");
431 printf("\thttps://www.systutorials.com/241660/how-to-install-tex-live-on-centos-7-linux/\n");
434 if ($rel && $rel < 26) {
439 printf("Couldn't identify release number\n");
445 check_missing_file
(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc"],
446 "google-noto-sans-cjk-ttc-fonts", 2);
449 check_rpm_missing
(\
@fedora26_opt_pkgs, 2) if ($pdf && !$old);
450 check_rpm_missing
(\
@fedora_tex_pkgs, 2) if ($pdf);
451 check_missing_tex
(2) if ($pdf);
452 check_missing
(\
%map);
454 return if (!$need && !$optional);
457 # dnf, for Fedora 18+
458 printf("You should run:\n\n\tsudo dnf install -y $install\n");
460 # yum, for RHEL (and clones) or Fedora version < 18
461 printf("You should run:\n\n\tsudo yum install -y $install\n");
465 sub give_opensuse_hints
()
468 "python-sphinx" => "python3-sphinx",
469 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme",
470 "virtualenv" => "python3-virtualenv",
472 "convert" => "ImageMagick",
473 "Pod::Usage" => "perl-Pod-Usage",
474 "xelatex" => "texlive-xetex-bin",
477 # On Tumbleweed, this package is also named rsvg-convert
478 $map{"rsvg-convert"} = "rsvg-view" if (!($system_release =~ /Tumbleweed/));
480 my @suse_tex_pkgs = (
481 "texlive-babel-english",
497 $map{"latexmk"} = "texlive-latexmk-bin";
499 # FIXME: add support for installing CJK fonts
501 # I tried hard, but was unable to find a way to install
502 # "Noto Sans CJK SC" on openSUSE
504 check_rpm_missing
(\
@suse_tex_pkgs, 2) if ($pdf);
505 check_missing_tex
(2) if ($pdf);
506 check_missing
(\
%map);
508 return if (!$need && !$optional);
509 printf("You should run:\n\n\tsudo zypper install --no-recommends $install\n");
512 sub give_mageia_hints
()
515 "python-sphinx" => "python3-sphinx",
516 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme",
517 "virtualenv" => "python3-virtualenv",
519 "convert" => "ImageMagick",
520 "Pod::Usage" => "perl-Pod-Usage",
521 "xelatex" => "texlive",
522 "rsvg-convert" => "librsvg2",
526 "texlive-fontsextra",
529 $map{"latexmk"} = "texlive-collection-basic";
533 if ($system_release =~ /OpenMandriva/) {
534 $packager_cmd = "dnf install";
535 $noto_sans = "noto-sans-cjk-fonts";
536 @tex_pkgs = ( "texlive-collection-fontsextra" );
538 $packager_cmd = "urpmi";
539 $noto_sans = "google-noto-sans-cjk-ttc-fonts";
544 check_missing_file
(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc",
545 "/usr/share/fonts/TTF/NotoSans-Regular.ttf"],
549 check_rpm_missing
(\
@tex_pkgs, 2) if ($pdf);
550 check_missing
(\
%map);
552 return if (!$need && !$optional);
553 printf("You should run:\n\n\tsudo $packager_cmd $install\n");
556 sub give_arch_linux_hints
()
559 "sphinx_rtd_theme" => "python-sphinx_rtd_theme",
560 "virtualenv" => "python-virtualenv",
562 "convert" => "imagemagick",
563 "xelatex" => "texlive-bin",
564 "latexmk" => "texlive-core",
565 "rsvg-convert" => "extra/librsvg",
568 my @archlinux_tex_pkgs = (
570 "texlive-latexextra",
573 check_pacman_missing
(\
@archlinux_tex_pkgs, 2) if ($pdf);
576 check_missing_file
(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc"],
577 "noto-fonts-cjk", 2);
580 check_missing
(\
%map);
582 return if (!$need && !$optional);
583 printf("You should run:\n\n\tsudo pacman -S $install\n");
586 sub give_gentoo_hints
()
589 "sphinx_rtd_theme" => "dev-python/sphinx_rtd_theme",
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",
597 check_missing_file
(["/usr/share/fonts/dejavu/DejaVuSans.ttf"],
598 "media-fonts/dejavu", 2) 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);
606 check_missing
(\
%map);
608 return if (!$need && !$optional);
610 printf("You should run:\n\n");
612 my $imagemagick = "media-gfx/imagemagick svg png";
613 my $cairo = "media-gfx/graphviz cairo pdf";
614 my $portage_imagemagick = "/etc/portage/package.use/imagemagick";
615 my $portage_cairo = "/etc/portage/package.use/graphviz";
617 if (qx(grep imagemagick $portage_imagemagick 2>/dev/null) eq "") {
618 printf("\tsudo su -c 'echo \"$imagemagick\" > $portage_imagemagick'\n")
620 if (qx(grep graphviz $portage_cairo 2>/dev/null) eq "") {
621 printf("\tsudo su -c 'echo \"$cairo\" > $portage_cairo'\n");
624 printf("\tsudo emerge --ask $install\n");
630 # Distro-specific hints
631 if ($system_release =~ /Red Hat Enterprise Linux/) {
635 if ($system_release =~ /CentOS/) {
639 if ($system_release =~ /Scientific Linux/) {
643 if ($system_release =~ /Oracle Linux Server/) {
647 if ($system_release =~ /Fedora/) {
651 if ($system_release =~ /Ubuntu/) {
655 if ($system_release =~ /Debian/) {
659 if ($system_release =~ /openSUSE/) {
663 if ($system_release =~ /Mageia/) {
667 if ($system_release =~ /OpenMandriva/) {
671 if ($system_release =~ /Arch Linux/) {
672 give_arch_linux_hints;
675 if ($system_release =~ /Gentoo/) {
681 # Fall-back to generic hint code for other distros
682 # That's far from ideal
, specially
for LaTeX dependencies
.
685 "sphinx-build" => "sphinx"
687 check_missing_tex
(2) if ($pdf);
688 check_missing
(\
%map);
689 print "I don't know distro $system_release.\n";
690 print "So, I can't provide you a hint with the install procedure.\n";
691 print "There are likely missing dependencies.\n";
695 # Common dependencies
698 sub deactivate_help
()
700 printf "\nIf you want to exit the virtualenv, you can use:\n";
701 printf "\tdeactivate\n";
706 # Check if Sphinx is already accessible from current environment
709 if ($system_release) {
710 print "Detected OS: $system_release.\n";
712 print "Unknown OS\n";
714 printf "Sphinx version: %s\n\n", $cur_version if ($cur_version);
716 # Check python command line, trying first python3
717 $python_cmd = findprog
("python3");
718 $python_cmd = check_program
("python", 0) if (!$python_cmd);
720 # Check the type of virtual env, depending on Python version
723 my $tmp = qx($python_cmd --version 2>&1);
724 if ($tmp =~ m/(\d+\.)(\d+\.)/) {
725 if ($1 >= 3 && $2 >= 3) {
726 $need_venv = 1; # python 3.3 or upper
728 $need_virtualenv = 1;
731 # Fail if it finds python2 (or worse)
732 die "Python 3 is required to build the kernel docs\n";
735 die "Warning: couldn't identify $python_cmd version!";
738 add_package
("python-sphinx", 0);
742 # Set virtualenv command line, if python < 3.3
744 if ($need_virtualenv) {
745 $virtualenv_cmd = findprog
("virtualenv-3");
746 $virtualenv_cmd = findprog
("virtualenv-3.5") if (!$virtualenv_cmd);
747 if (!$virtualenv_cmd) {
748 check_program
("virtualenv", 0);
749 $virtualenv_cmd = "virtualenv";
753 # Check for needed programs/tools
754 check_perl_module
("Pod::Usage", 0);
755 check_program
("make", 0);
756 check_program
("gcc", 0);
757 check_python_module
("sphinx_rtd_theme", 1) if (!$virtualenv);
758 check_program
("dot", 1);
759 check_program
("convert", 1);
761 # Extra PDF files - should use 2 for is_optional
762 check_program
("xelatex", 2) if ($pdf);
763 check_program
("rsvg-convert", 2) if ($pdf);
764 check_program
("latexmk", 2) if ($pdf);
766 if ($need_sphinx || $rec_sphinx_upgrade) {
767 check_python_module
("ensurepip", 0) if ($need_venv);
770 # Do distro-specific checks and output distro-install commands
775 die "Can't build as $need mandatory dependency is missing";
777 die "Can't build as $need mandatory dependencies are missing";
781 # Check if sphinx-build is called sphinx-build-3
783 printf "\tsudo ln -sf %s /usr/bin/sphinx-build\n\n",
784 which
("sphinx-build-3");
787 # NOTE: if the system has a too old Sphinx version installed,
788 # it will recommend installing a newer version using virtualenv
790 if ($need_sphinx || $rec_sphinx_upgrade) {
791 my $min_activate = "$ENV{'PWD'}/${virtenv_prefix}${min_version}/bin/activate";
792 my @activates = glob "$ENV{'PWD'}/${virtenv_prefix}*/bin/activate";
794 if ($cur_version lt $rec_version) {
795 print "Warning: It is recommended at least Sphinx version $rec_version.\n";
796 print " If you want pdf, you need at least $min_pdf_version.\n";
798 if ($cur_version lt $min_pdf_version) {
799 print "Note: It is recommended at least Sphinx version $min_pdf_version if you need PDF support.\n";
801 @activates = sort {$b cmp $a} @activates;
802 my ($activate, $ver);
803 foreach my $f (@activates) {
804 next if ($f lt $min_activate);
807 $sphinx_cmd =~ s/activate/sphinx-build/;
808 next if (! -f
$sphinx_cmd);
810 $ver = get_sphinx_version
($sphinx_cmd);
811 if ($need_sphinx && ($ver ge $min_version)) {
814 } elsif ($ver gt $cur_version) {
819 if ($activate ne "") {
821 printf "\nNeed to activate Sphinx (version $ver) on virtualenv with:\n";
822 printf "\t. $activate\n";
826 printf "\nYou may also use a newer Sphinx (version $ver) with:\n";
827 printf "\tdeactivate && . $activate\n";
830 my $rec_activate = "$virtenv_dir/bin/activate";
832 print "To upgrade Sphinx, use:\n\n" if ($rec_sphinx_upgrade);
834 $python_cmd = find_python_no_venv
();
837 printf "\t$python_cmd -m venv $virtenv_dir\n";
839 printf "\t$virtualenv_cmd $virtenv_dir\n";
841 printf "\t. $rec_activate\n";
842 printf "\tpip install -r $requirement_file\n";
845 $need++ if (!$rec_sphinx_upgrade);
850 print "All optional dependencies are met.\n" if (!$optional);
853 die "Can't build as $need mandatory dependency is missing";
855 die "Can't build as $need mandatory dependencies are missing";
858 print "Needed package dependencies are met.\n";
866 my $arg = shift(@ARGV);
868 if ($arg eq "--no-virtualenv") {
870 } elsif ($arg eq "--no-pdf"){
872 } elsif ($arg eq "--version-check"){
875 print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf> <--version-check>\n\n";
877 print "\t--no-virtualenv\t- Recommend installing Sphinx instead of using a virtualenv\n";
878 print "\t--version-check\t- if version is compatible, don't check for missing dependencies\n";
879 print "\t--no-pdf\t- don't check for dependencies required to build PDF docs\n\n";
885 # Determine the system type. There's no standard unique way that would
886 # work with all distros with a minimal package install. So, several
887 # methods are used here.
889 # By default, it will use lsb_release function. If not available, it will
890 # fail back to reading the known different places where the distro name
894 $system_release = qx(lsb_release -d) if which
("lsb_release");
895 $system_release =~ s/Description:\s*// if ($system_release);
896 $system_release = catcheck
("/etc/system-release") if !$system_release;
897 $system_release = catcheck
("/etc/redhat-release") if !$system_release;
898 $system_release = catcheck
("/etc/lsb-release") if !$system_release;
899 $system_release = catcheck
("/etc/gentoo-release") if !$system_release;
901 # This seems more common than LSB these days
902 if (!$system_release) {
904 if (open IN
, "cat /etc/os-release|") {
906 if (m/^([\w\d\_]+)=\"?([^\"]*)\"?\n/) {
910 $system_release = $os_var{"NAME"};
911 if (defined($os_var{"VERSION_ID"})) {
912 $system_release .= " " . $os_var{"VERSION_ID"} if (defined($os_var{"VERSION_ID"}));
914 $system_release .= " " . $os_var{"VERSION"};
918 $system_release = catcheck
("/etc/issue") if !$system_release;
919 $system_release =~ s/\s+$//;