2 # SPDX-License-Identifier: GPL-2.0-or-later
5 # Copyright (c) 2017-2019 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_";
25 my $rec_sphinx_upgrade = 0;
31 # Command line arguments
36 my $version_check = 0;
39 # List of required texlive packages on Fedora and OpenSuse
43 'amsfonts.sty' => 'texlive-amsfonts',
44 'amsmath.sty' => 'texlive-amsmath',
45 'amssymb.sty' => 'texlive-amsfonts',
46 'amsthm.sty' => 'texlive-amscls',
47 'anyfontsize.sty' => 'texlive-anyfontsize',
48 'atbegshi.sty' => 'texlive-oberdiek',
49 'bm.sty' => 'texlive-tools',
50 'capt-of.sty' => 'texlive-capt-of',
51 'cmap.sty' => 'texlive-cmap',
52 'ecrm1000.tfm' => 'texlive-ec',
53 'eqparbox.sty' => 'texlive-eqparbox',
54 'eu1enc.def' => 'texlive-euenc',
55 'fancybox.sty' => 'texlive-fancybox',
56 'fancyvrb.sty' => 'texlive-fancyvrb',
57 'float.sty' => 'texlive-float',
58 'fncychap.sty' => 'texlive-fncychap',
59 'footnote.sty' => 'texlive-mdwtools',
60 'framed.sty' => 'texlive-framed',
61 'luatex85.sty' => 'texlive-luatex85',
62 'multirow.sty' => 'texlive-multirow',
63 'needspace.sty' => 'texlive-needspace',
64 'palatino.sty' => 'texlive-psnfss',
65 'parskip.sty' => 'texlive-parskip',
66 'polyglossia.sty' => 'texlive-polyglossia',
67 'tabulary.sty' => 'texlive-tabulary',
68 'threeparttable.sty' => 'texlive-threeparttable',
69 'titlesec.sty' => 'texlive-titlesec',
70 'ucs.sty' => 'texlive-ucs',
71 'upquote.sty' => 'texlive-upquote',
72 'wrapfig.sty' => 'texlive-wrapfig',
76 # Subroutines that checks if a feature exists
83 foreach my $prog (sort keys %missing) {
84 my $is_optional = $missing{$prog};
86 # At least on some LTS distros like CentOS 7, texlive doesn't
87 # provide all packages we need. When such distros are
88 # detected, we have to disable PDF output.
90 # So, we need to ignore the packages that distros would
91 # need for LaTeX to work
92 if ($is_optional == 2 && !$pdf) {
98 print "Warning: better to also install \"$prog\".\n";
100 print "ERROR: please install \"$prog\", otherwise, build won't work.\n";
102 if (defined($map{$prog})) {
103 $install .= " " . $map{$prog};
105 $install .= " " . $prog;
115 my $is_optional = shift;
117 $missing{$package} = $is_optional;
125 sub check_missing_file($$$)
129 my $is_optional = shift;
135 add_package($package, $is_optional);
140 foreach(split(/:/, $ENV{PATH})) {
141 return "$_/$_[0]" if(-x "$_/$_[0]");
145 sub check_program($$)
148 my $is_optional = shift;
150 return if findprog($prog);
152 add_package($prog, $is_optional);
155 sub check_perl_module($$)
158 my $is_optional = shift;
160 my $err = system("perl -M$prog -e 1 2>/dev/null /dev/null");
161 return if ($err == 0);
163 add_package($prog, $is_optional);
166 sub check_python_module($$)
169 my $is_optional = shift;
171 my $err = system("python3 -c 'import $prog' 2>/dev/null /dev/null");
172 return if ($err == 0);
173 my $err = system("python -c 'import $prog' 2>/dev/null /dev/null");
174 return if ($err == 0);
176 add_package($prog, $is_optional);
179 sub check_rpm_missing($$)
182 my $is_optional = $_[1];
184 foreach my $prog(@pkgs) {
185 my $err = system("rpm -q '$prog' 2>/dev/null >/dev/null");
186 add_package($prog, $is_optional) if ($err);
190 sub check_pacman_missing($$)
193 my $is_optional = $_[1];
195 foreach my $prog(@pkgs) {
196 my $err = system("pacman -Q '$prog' 2>/dev/null >/dev/null");
197 add_package($prog, $is_optional) if ($err);
201 sub check_missing_tex($)
203 my $is_optional = shift;
204 my $kpsewhich = findprog("kpsewhich");
206 foreach my $prog(keys %texlive) {
207 my $package = $texlive{$prog};
209 add_package($package, $is_optional);
212 my $file = qx($kpsewhich $prog);
213 add_package($package, $is_optional) if ($file =~ /^\s*$/);
217 sub get_sphinx_fname()
219 my $fname = "sphinx-build";
220 return $fname if findprog($fname);
222 $fname = "sphinx-build-3";
223 if (findprog($fname)) {
229 my $prog = findprog("virtualenv-3");
230 $prog = findprog("virtualenv-3.5") if (!$prog);
232 check_program("virtualenv", 0) if (!$prog);
235 add_package("python-sphinx", 0);
246 open IN, $conf or die "Can't open $conf";
248 if (m/^\s*needs_sphinx\s*=\s*[\'\"]([\d\.]+)[\'\"]/) {
255 die "Can't get needs_sphinx version from $conf" if (!$min_version);
257 open IN, $requirement_file or die "Can't open $requirement_file";
259 if (m/^\s*Sphinx\s*==\s*([\d\.]+)$/) {
266 die "Can't get recommended sphinx version from $requirement_file" if (!$min_version);
268 $virtenv_dir = $virtenv_prefix . $rec_version;
270 my $sphinx = get_sphinx_fname();
271 return if ($sphinx eq "");
273 open IN, "$sphinx --version 2>&1 |" or die "$sphinx returned an error";
275 if (m/^\s*sphinx-build\s+([\d\.]+)$/) {
279 # Sphinx 1.2.x uses a different format
280 if (m/^\s*Sphinx.*\s+([\d\.]+)$/) {
287 die "$sphinx didn't return its version" if (!$cur_version);
289 if ($cur_version lt $min_version) {
290 printf "ERROR: Sphinx version is %s. It should be >= %s (recommended >= %s)\n",
291 $cur_version, $min_version, $rec_version;;
296 if ($cur_version lt $rec_version) {
297 printf "Sphinx version %s\n", $cur_version;
298 print "Warning: It is recommended at least Sphinx version $rec_version.\n";
299 $rec_sphinx_upgrade = 1;
303 # On version check mode, just assume Sphinx has all mandatory deps
304 exit (0) if ($version_check);
308 # Ancillary subroutines
314 $res = qx(cat $_[0]) if (-r $_[0]);
321 my @path = split ":", $ENV{PATH};
323 foreach my $dir(@path) {
324 my $name = $dir.'/'.$file;
325 return $name if (-x $name );
331 # Subroutines that check distro-specific hints
334 sub give_debian_hints()
337 "python-sphinx" => "python3-sphinx",
338 "sphinx_rtd_theme" => "python3-sphinx-rtd-theme",
339 "virtualenv" => "virtualenv",
341 "convert" => "imagemagick",
342 "Pod::Usage" => "perl-modules",
343 "xelatex" => "texlive-xetex",
344 "rsvg-convert" => "librsvg2-bin",
348 check_missing_file(["/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf"],
351 check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc"],
352 "fonts-noto-cjk", 2);
355 check_program("dvipng", 2) if ($pdf);
356 check_missing(\%map);
358 return if (!$need && !$optional);
359 printf("You should run:\n\n\tsudo apt-get install $install\n");
362 sub give_redhat_hints()
365 "python-sphinx" => "python3-sphinx",
366 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme",
367 "virtualenv" => "python3-virtualenv",
369 "convert" => "ImageMagick",
370 "Pod::Usage" => "perl-Pod-Usage",
371 "xelatex" => "texlive-xetex-bin",
372 "rsvg-convert" => "librsvg2-tools",
375 my @fedora26_opt_pkgs = (
376 "graphviz-gd", # Fedora 26: needed for PDF support
379 my @fedora_tex_pkgs = (
380 "texlive-collection-fontsrecommended",
381 "texlive-collection-latex",
384 "dejavu-serif-fonts",
385 "dejavu-sans-mono-fonts",
389 # Checks valid for RHEL/CentOS version 7.x.
393 $rel = $1 if ($system_release =~ /release\s+(\d+)/);
395 if (!($system_release =~ /Fedora/)) {
396 $map{"virtualenv"} = "python-virtualenv";
398 if ($rel && $rel < 8) {
402 printf("Note: texlive packages on RHEL/CENTOS <= 7 are incomplete. Can't support PDF output\n");
403 printf("If you want to build PDF, please read:\n");
404 printf("\thttps://www.systutorials.com/241660/how-to-install-tex-live-on-centos-7-linux/\n");
407 if ($rel && $rel < 26) {
412 printf("Couldn't identify release number\n");
418 check_missing_file(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc"],
419 "google-noto-sans-cjk-ttc-fonts", 2);
422 check_rpm_missing(\@fedora26_opt_pkgs, 2) if ($pdf && !$old);
423 check_rpm_missing(\@fedora_tex_pkgs, 2) if ($pdf);
424 check_missing_tex(2) if ($pdf);
425 check_missing(\%map);
427 return if (!$need && !$optional);
430 # dnf, for Fedora 18+
431 printf("You should run:\n\n\tsudo dnf install -y $install\n");
433 # yum, for RHEL (and clones) or Fedora version < 18
434 printf("You should run:\n\n\tsudo yum install -y $install\n");
438 sub give_opensuse_hints()
441 "python-sphinx" => "python3-sphinx",
442 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme",
443 "virtualenv" => "python3-virtualenv",
445 "convert" => "ImageMagick",
446 "Pod::Usage" => "perl-Pod-Usage",
447 "xelatex" => "texlive-xetex-bin",
448 "rsvg-convert" => "rsvg-view",
451 my @suse_tex_pkgs = (
452 "texlive-babel-english",
468 $map{"latexmk"} = "texlive-latexmk-bin";
470 # FIXME: add support for installing CJK fonts
472 # I tried hard, but was unable to find a way to install
473 # "Noto Sans CJK SC" on openSUSE
475 check_rpm_missing(\@suse_tex_pkgs, 2) if ($pdf);
476 check_missing_tex(2) if ($pdf);
477 check_missing(\%map);
479 return if (!$need && !$optional);
480 printf("You should run:\n\n\tsudo zypper install --no-recommends $install\n");
483 sub give_mageia_hints()
486 "python-sphinx" => "python3-sphinx",
487 "sphinx_rtd_theme" => "python3-sphinx_rtd_theme",
488 "virtualenv" => "python3-virtualenv",
490 "convert" => "ImageMagick",
491 "Pod::Usage" => "perl-Pod-Usage",
492 "xelatex" => "texlive",
493 "rsvg-convert" => "librsvg2-tools",
497 "texlive-fontsextra",
500 $map{"latexmk"} = "texlive-collection-basic";
503 check_missing_file(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc"],
504 "google-noto-sans-cjk-ttc-fonts", 2);
507 check_rpm_missing(\@tex_pkgs, 2) if ($pdf);
508 check_missing(\%map);
510 return if (!$need && !$optional);
511 printf("You should run:\n\n\tsudo urpmi $install\n");
514 sub give_arch_linux_hints()
517 "sphinx_rtd_theme" => "python-sphinx_rtd_theme",
518 "virtualenv" => "python-virtualenv",
520 "convert" => "imagemagick",
521 "xelatex" => "texlive-bin",
522 "rsvg-convert" => "extra/librsvg",
525 my @archlinux_tex_pkgs = (
527 "texlive-latexextra",
530 check_pacman_missing(\@archlinux_tex_pkgs, 2) if ($pdf);
533 check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc"],
534 "noto-fonts-cjk", 2);
537 check_missing(\%map);
539 return if (!$need && !$optional);
540 printf("You should run:\n\n\tsudo pacman -S $install\n");
543 sub give_gentoo_hints()
546 "sphinx_rtd_theme" => "dev-python/sphinx_rtd_theme",
547 "virtualenv" => "dev-python/virtualenv",
548 "dot" => "media-gfx/graphviz",
549 "convert" => "media-gfx/imagemagick",
550 "xelatex" => "dev-texlive/texlive-xetex media-fonts/dejavu",
551 "rsvg-convert" => "gnome-base/librsvg",
554 check_missing_file(["/usr/share/fonts/dejavu/DejaVuSans.ttf"],
555 "media-fonts/dejavu", 2) if ($pdf);
558 check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJKsc-Regular.otf"],
559 "media-fonts/noto-cjk", 2);
562 check_missing(\%map);
564 return if (!$need && !$optional);
566 printf("You should run:\n\n");
568 my $imagemagick = "media-gfx/imagemagick svg png";
569 my $cairo = "media-gfx/graphviz cairo pdf";
570 my $portage_imagemagick = "/etc/portage/package.use/imagemagick";
571 my $portage_cairo = "/etc/portage/package.use/graphviz";
573 if (qx(cat $portage_imagemagick) ne "$imagemagick\n") {
574 printf("\tsudo su -c 'echo \"$imagemagick\" > $portage_imagemagick'\n")
576 if (qx(cat $portage_cairo) ne "$cairo\n") {
577 printf("\tsudo su -c 'echo \"$cairo\" > $portage_cairo'\n");
580 printf("\tsudo emerge --ask $install\n");
586 # Distro-specific hints
587 if ($system_release =~ /Red Hat Enterprise Linux/) {
591 if ($system_release =~ /CentOS/) {
595 if ($system_release =~ /Scientific Linux/) {
599 if ($system_release =~ /Oracle Linux Server/) {
603 if ($system_release =~ /Fedora/) {
607 if ($system_release =~ /Ubuntu/) {
611 if ($system_release =~ /Debian/) {
615 if ($system_release =~ /openSUSE/) {
619 if ($system_release =~ /Mageia/) {
623 if ($system_release =~ /Arch Linux/) {
624 give_arch_linux_hints;
627 if ($system_release =~ /Gentoo/) {
633 # Fall-back to generic hint code for other distros
634 # That's far from ideal, specially for LaTeX dependencies.
637 "sphinx-build" => "sphinx"
639 check_missing_tex(2) if ($pdf);
640 check_missing(\%map);
641 print "I don't know distro $system_release.\n";
642 print "So, I can't provide you a hint with the install procedure.\n";
643 print "There are likely missing dependencies.\n";
647 # Common dependencies
650 sub deactivate_help()
652 printf "\tIf you want to exit the virtualenv, you can use:\n";
653 printf "\tdeactivate\n";
658 # Check for needed programs/tools
661 if ($system_release) {
662 print "Detected OS: $system_release.\n\n";
664 print "Unknown OS\n\n";
667 print "To upgrade Sphinx, use:\n\n" if ($rec_sphinx_upgrade);
669 # Check for needed programs/tools
670 check_perl_module("Pod::Usage", 0);
671 check_program("make", 0);
672 check_program("gcc", 0);
673 check_python_module("sphinx_rtd_theme", 1) if (!$virtualenv);
674 check_program("dot", 1);
675 check_program("convert", 1);
677 # Extra PDF files - should use 2 for is_optional
678 check_program("xelatex", 2) if ($pdf);
679 check_program("rsvg-convert", 2) if ($pdf);
680 check_program("latexmk", 2) if ($pdf);
685 printf "\tsudo ln -sf %s /usr/bin/sphinx-build\n\n",
686 which("sphinx-build-3");
688 if ($need_sphinx || $rec_sphinx_upgrade) {
689 my $min_activate = "$ENV{'PWD'}/${virtenv_prefix}${min_version}/bin/activate";
690 my @activates = glob "$ENV{'PWD'}/${virtenv_prefix}*/bin/activate";
692 @activates = sort {$b cmp $a} @activates;
694 if ($need_sphinx && scalar @activates > 0 && $activates[0] ge $min_activate) {
695 printf "\nNeed to activate a compatible Sphinx version on virtualenv with:\n";
696 printf "\t. $activates[0]\n";
700 my $rec_activate = "$virtenv_dir/bin/activate";
701 my $virtualenv = findprog("virtualenv-3");
702 $virtualenv = findprog("virtualenv-3.5") if (!$virtualenv);
703 $virtualenv = findprog("virtualenv") if (!$virtualenv);
704 $virtualenv = "virtualenv" if (!$virtualenv);
706 printf "\t$virtualenv $virtenv_dir\n";
707 printf "\t. $rec_activate\n";
708 printf "\tpip install -r $requirement_file\n";
711 $need++ if (!$rec_sphinx_upgrade);
716 print "All optional dependencies are met.\n" if (!$optional);
719 die "Can't build as $need mandatory dependency is missing";
721 die "Can't build as $need mandatory dependencies are missing";
724 print "Needed package dependencies are met.\n";
732 my $arg = shift(@ARGV);
734 if ($arg eq "--no-virtualenv") {
736 } elsif ($arg eq "--no-pdf"){
738 } elsif ($arg eq "--version-check"){
741 print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf> <--version-check>\n\n";
743 print "\t--no-virtualenv\t- Recommend installing Sphinx instead of using a virtualenv\n";
744 print "\t--version-check\t- if version is compatible, don't check for missing dependencies\n";
745 print "\t--no-pdf\t- don't check for dependencies required to build PDF docs\n\n";
751 # Determine the system type. There's no standard unique way that would
752 # work with all distros with a minimal package install. So, several
753 # methods are used here.
755 # By default, it will use lsb_release function. If not available, it will
756 # fail back to reading the known different places where the distro name
760 $system_release = qx(lsb_release -d) if which("lsb_release");
761 $system_release =~ s/Description:\s*// if ($system_release);
762 $system_release = catcheck("/etc/system-release") if !$system_release;
763 $system_release = catcheck("/etc/redhat-release") if !$system_release;
764 $system_release = catcheck("/etc/lsb-release") if !$system_release;
765 $system_release = catcheck("/etc/gentoo-release") if !$system_release;
766 $system_release = catcheck("/etc/issue") if !$system_release;
767 $system_release =~ s/\s+$//;