#!/usr/bin/perl# SPDX-License-Identifier: GPL-2.0-or-lateruse strict; # Copyright (c) 2017 Mauro Carvalho Chehab <mchehab@kernel.org># my $conf = "Documentation/conf.py";my $requirement_file = "Documentation/sphinx/requirements.txt"; ## Static vars# my %missing;my $system_release;my $need = 0;my $optional = 0;my $need_symlink = 0;my $need_sphinx = 0;my $rec_sphinx_upgrade = 0;my $install = "";my $virtenv_dir = "sphinx_"; ## Command line arguments# my $pdf = 1;my $virtualenv = 1; ## List of required texlive packages on Fedora and OpenSuse# my %texlive = (	'amsfonts.sty'       => 'texlive-amsfonts',	'amsmath.sty'        => 'texlive-amsmath',	'amssymb.sty'        => 'texlive-amsfonts',	'amsthm.sty'         => 'texlive-amscls',	'anyfontsize.sty'    => 'texlive-anyfontsize',	'atbegshi.sty'       => 'texlive-oberdiek',	'bm.sty'             => 'texlive-tools',	'capt-of.sty'        => 'texlive-capt-of',	'cmap.sty'           => 'texlive-cmap',	'ecrm1000.tfm'       => 'texlive-ec',	'eqparbox.sty'       => 'texlive-eqparbox',	'eu1enc.def'         => 'texlive-euenc',	'fancybox.sty'       => 'texlive-fancybox',	'fancyvrb.sty'       => 'texlive-fancyvrb',	'float.sty'          => 'texlive-float',	'fncychap.sty'       => 'texlive-fncychap',	'footnote.sty'       => 'texlive-mdwtools',	'framed.sty'         => 'texlive-framed',	'luatex85.sty'       => 'texlive-luatex85',	'multirow.sty'       => 'texlive-multirow',	'needspace.sty'      => 'texlive-needspace',	'palatino.sty'       => 'texlive-psnfss',	'parskip.sty'        => 'texlive-parskip',	'polyglossia.sty'    => 'texlive-polyglossia',	'tabulary.sty'       => 'texlive-tabulary',	'threeparttable.sty' => 'texlive-threeparttable',	'titlesec.sty'       => 'texlive-titlesec',	'ucs.sty'            => 'texlive-ucs',	'upquote.sty'        => 'texlive-upquote',	'wrapfig.sty'        => 'texlive-wrapfig',); ## Subroutines that checks if a feature exists# sub check_missing(%){	my %map = %{$_[0]}; 	foreach my $prog (sort keys %missing) {		my $is_optional = $missing{$prog}; 		if ($is_optional) {			print "Warning: better to also install \"$prog\".\n";		} else {			print "ERROR: please install \"$prog\", otherwise, build won't work.\n";		}		if (defined($map{$prog})) {			$install .= " " . $map{$prog};		} else {			$install .= " " . $prog;		}	} 	$install =~ s/^\s//;} sub add_package($$){	my $package = shift;	my $is_optional = shift; 	$missing{$package} = $is_optional;	if ($is_optional) {		$optional++;	} else {		$need++;	}} sub check_missing_file($$$){	my $file = shift;	my $package = shift;	my $is_optional = shift; 	return if(-e $file); 	add_package($package, $is_optional);} sub findprog($){	foreach(split(/:/, $ENV{PATH})) {		return "$_/$_[0]" if(-x "$_/$_[0]");	}} sub check_program($$){	my $prog = shift;	my $is_optional = shift; 	return if findprog($prog); 	add_package($prog, $is_optional);} sub check_perl_module($$){	my $prog = shift;	my $is_optional = shift; 	my $err = system("perl -M$prog -e 1 2>/dev/null /dev/null");	return if ($err == 0); 	add_package($prog, $is_optional);} sub check_python_module($$){	my $prog = shift;	my $is_optional = shift; 	my $err = system("python3 -c 'import $prog' 2>/dev/null /dev/null");	return if ($err == 0);	my $err = system("python -c 'import $prog' 2>/dev/null /dev/null");	return if ($err == 0); 	add_package($prog, $is_optional);} sub check_rpm_missing($$){	my @pkgs = @{$_[0]};	my $is_optional = $_[1]; 	foreach my $prog(@pkgs) {		my $err = system("rpm -q '$prog' 2>/dev/null >/dev/null");		add_package($prog, $is_optional) if ($err);	}} sub check_pacman_missing($$){	my @pkgs = @{$_[0]};	my $is_optional = $_[1]; 	foreach my $prog(@pkgs) {		my $err = system("pacman -Q '$prog' 2>/dev/null >/dev/null");		add_package($prog, $is_optional) if ($err);	}} sub check_missing_tex($){	my $is_optional = shift;	my $kpsewhich = findprog("kpsewhich"); 	foreach my $prog(keys %texlive) {		my $package = $texlive{$prog};		if (!$kpsewhich) {			add_package($package, $is_optional);			next;		}		my $file = qx($kpsewhich $prog);		add_package($package, $is_optional) if ($file =~ /^\s*$/);	}} sub get_sphinx_fname(){	my $fname = "sphinx-build";	return $fname if findprog($fname); 	$fname = "sphinx-build-3";	if (findprog($fname)) {		$need_symlink = 1;		return $fname;	} 	if ($virtualenv) {		my $prog = findprog("virtualenv-3");		$prog = findprog("virtualenv-3.5") if (!$prog); 		check_program("virtualenv", 0) if (!$prog);		$need_sphinx = 1;	} else {		add_package("python-sphinx", 0);	} 	return "";} sub check_sphinx(){	my $min_version;	my $rec_version;	my $cur_version; 	open IN, $conf or die "Can't open $conf";	while (<IN>) {		if (m/^\s*needs_sphinx\s*=\s*[\'\"]([\d\.]+)[\'\"]/) {			$min_version=$1;			last;		}	}	close IN; 	die "Can't get needs_sphinx version from $conf" if (!$min_version); 	open IN, $requirement_file or die "Can't open $requirement_file";	while (<IN>) {		if (m/^\s*Sphinx\s*==\s*([\d\.]+)$/) {			$rec_version=$1;			last;		}	}	close IN; 	die "Can't get recommended sphinx version from $requirement_file" if (!$min_version); 	$virtenv_dir .= $rec_version; 	my $sphinx = get_sphinx_fname();	return if ($sphinx eq ""); 	open IN, "$sphinx --version 2>&1 |" or die "$sphinx returned an error";	while (<IN>) {		if (m/^\s*sphinx-build\s+([\d\.]+)$/) {			$cur_version=$1;			last;		}		# Sphinx 1.2.x uses a different format		if (m/^\s*Sphinx.*\s+([\d\.]+)$/) {			$cur_version=$1;			last;		}	}	close IN; 	die "$sphinx didn't return its version" if (!$cur_version); 	printf "Sphinx version %s (minimal: %s, recommended >= %s)\n",		$cur_version, $min_version, $rec_version; 	if ($cur_version lt $min_version) {		print "Warning: Sphinx version should be >= $min_version\n\n";		$need_sphinx = 1;		return;	} 	if ($cur_version lt $rec_version) {		print "Warning: It is recommended at least Sphinx version $rec_version.\n";		print "         To upgrade, use:\n\n";		$rec_sphinx_upgrade = 1;	}} ## Ancillary subroutines# sub catcheck($){  my $res = "";  $res = qx(cat $_[0]) if (-r $_[0]);  return $res;} sub which($){	my $file = shift;	my @path = split ":", $ENV{PATH}; 	foreach my $dir(@path) {		my $name = $dir.'/'.$file;		return $name if (-x $name );	}	return undef;} ## Subroutines that check distro-specific hints# sub give_debian_hints(){	my %map = (		"python-sphinx"		=> "python3-sphinx",		"sphinx_rtd_theme"	=> "python3-sphinx-rtd-theme",		"virtualenv"		=> "virtualenv",		"dot"			=> "graphviz",		"convert"		=> "imagemagick",		"Pod::Usage"		=> "perl-modules",		"xelatex"		=> "texlive-xetex",		"rsvg-convert"		=> "librsvg2-bin",	); 	if ($pdf) {		check_missing_file("/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf",				   "fonts-dejavu", 1);	} 	check_program("dvipng", 1) if ($pdf);	check_missing(\%map); 	return if (!$need && !$optional);	printf("You should run:\n\n\tsudo apt-get install $install\n");} sub give_redhat_hints(){	my %map = (		"python-sphinx"		=> "python3-sphinx",		"sphinx_rtd_theme"	=> "python3-sphinx_rtd_theme",		"virtualenv"		=> "python3-virtualenv",		"dot"			=> "graphviz",		"convert"		=> "ImageMagick",		"Pod::Usage"		=> "perl-Pod-Usage",		"xelatex"		=> "texlive-xetex-bin",		"rsvg-convert"		=> "librsvg2-tools",	); 	my @fedora26_opt_pkgs = (		"graphviz-gd",		# Fedora 26: needed for PDF support	); 	my @fedora_tex_pkgs = (		"texlive-collection-fontsrecommended",		"texlive-collection-latex",		"dejavu-sans-fonts",		"dejavu-serif-fonts",		"dejavu-sans-mono-fonts",	); 	#	# Checks valid for RHEL/CentOS version 7.x.	#	if (! $system_release =~ /Fedora/) {		$map{"virtualenv"} = "python-virtualenv";	} 	my $release; 	$release = $1 if ($system_release =~ /Fedora\s+release\s+(\d+)/); 	check_rpm_missing(\@fedora26_opt_pkgs, 1) if ($pdf && $release >= 26);	check_rpm_missing(\@fedora_tex_pkgs, 1) if ($pdf);	check_missing_tex(1) if ($pdf);	check_missing(\%map); 	return if (!$need && !$optional); 	if ($release >= 18) {		# dnf, for Fedora 18+		printf("You should run:\n\n\tsudo dnf install -y $install\n");	} else {		# yum, for RHEL (and clones) or Fedora version < 18		printf("You should run:\n\n\tsudo yum install -y $install\n");	}} sub give_opensuse_hints(){	my %map = (		"python-sphinx"		=> "python3-sphinx",		"sphinx_rtd_theme"	=> "python3-sphinx_rtd_theme",		"virtualenv"		=> "python3-virtualenv",		"dot"			=> "graphviz",		"convert"		=> "ImageMagick",		"Pod::Usage"		=> "perl-Pod-Usage",		"xelatex"		=> "texlive-xetex-bin",		"rsvg-convert"		=> "rsvg-view",	); 	my @suse_tex_pkgs = (		"texlive-babel-english",		"texlive-caption",		"texlive-colortbl",		"texlive-courier",		"texlive-dvips",		"texlive-helvetic",		"texlive-makeindex",		"texlive-metafont",		"texlive-metapost",		"texlive-palatino",		"texlive-preview",		"texlive-times",		"texlive-zapfchan",		"texlive-zapfding",	); 	check_rpm_missing(\@suse_tex_pkgs, 1) if ($pdf);	check_missing_tex(1) if ($pdf);	check_missing(\%map); 	return if (!$need && !$optional);	printf("You should run:\n\n\tsudo zypper install --no-recommends $install\n");} sub give_mageia_hints(){	my %map = (		"python-sphinx"		=> "python3-sphinx",		"sphinx_rtd_theme"	=> "python3-sphinx_rtd_theme",		"virtualenv"		=> "python3-virtualenv",		"dot"			=> "graphviz",		"convert"		=> "ImageMagick",		"Pod::Usage"		=> "perl-Pod-Usage",		"xelatex"		=> "texlive",		"rsvg-convert"		=> "librsvg2-tools",	); 	my @tex_pkgs = (		"texlive-fontsextra",	); 	check_rpm_missing(\@tex_pkgs, 1) if ($pdf);	check_missing(\%map); 	return if (!$need && !$optional);	printf("You should run:\n\n\tsudo urpmi $install\n");} sub give_arch_linux_hints(){	my %map = (		"sphinx_rtd_theme"	=> "python-sphinx_rtd_theme",		"virtualenv"		=> "python-virtualenv",		"dot"			=> "graphviz",		"convert"		=> "imagemagick",		"xelatex"		=> "texlive-bin",		"rsvg-convert"		=> "extra/librsvg",	); 	my @archlinux_tex_pkgs = (		"texlive-core",		"texlive-latexextra",		"ttf-dejavu",	);	check_pacman_missing(\@archlinux_tex_pkgs, 1) if ($pdf);	check_missing(\%map); 	return if (!$need && !$optional);	printf("You should run:\n\n\tsudo pacman -S $install\n");} sub give_gentoo_hints(){	my %map = (		"sphinx_rtd_theme"	=> "dev-python/sphinx_rtd_theme",		"virtualenv"		=> "dev-python/virtualenv",		"dot"			=> "media-gfx/graphviz",		"convert"		=> "media-gfx/imagemagick",		"xelatex"		=> "dev-texlive/texlive-xetex media-fonts/dejavu",		"rsvg-convert"		=> "gnome-base/librsvg",	); 	check_missing_file("/usr/share/fonts/dejavu/DejaVuSans.ttf",			   "media-fonts/dejavu", 1) if ($pdf); 	check_missing(\%map); 	return if (!$need && !$optional); 	printf("You should run:\n\n");	printf("\tsudo su -c 'echo \"media-gfx/imagemagick svg png\" > /etc/portage/package.use/imagemagick'\n");	printf("\tsudo su -c 'echo \"media-gfx/graphviz cairo pdf\" > /etc/portage/package.use/graphviz'\n");	printf("\tsudo emerge --ask $install\n"); } 

Lines 1–500 of 673. Load more