2017-07-17 15:46:36 -06:00
|
|
|
#!/usr/bin/perl
|
2019-05-27 00:55:06 -06:00
|
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
2017-07-17 15:46:36 -06:00
|
|
|
use strict;
|
|
|
|
|
2020-04-14 10:56:13 -06:00
|
|
|
# Copyright (c) 2017-2020 Mauro Carvalho Chehab <mchehab@kernel.org>
|
2017-07-17 15:46:36 -06:00
|
|
|
#
|
|
|
|
|
2019-06-23 23:25:07 -06:00
|
|
|
my $prefix = "./";
|
|
|
|
$prefix = "$ENV{'srctree'}/" if ($ENV{'srctree'});
|
|
|
|
|
|
|
|
my $conf = $prefix . "Documentation/conf.py";
|
|
|
|
my $requirement_file = $prefix . "Documentation/sphinx/requirements.txt";
|
2019-05-29 17:09:24 -06:00
|
|
|
my $virtenv_prefix = "sphinx_";
|
2017-07-17 15:46:37 -06:00
|
|
|
|
2017-07-17 15:46:36 -06:00
|
|
|
#
|
|
|
|
# Static vars
|
|
|
|
#
|
|
|
|
|
|
|
|
my %missing;
|
|
|
|
my $system_release;
|
|
|
|
my $need = 0;
|
|
|
|
my $optional = 0;
|
|
|
|
my $need_symlink = 0;
|
|
|
|
my $need_sphinx = 0;
|
2020-04-14 10:56:13 -06:00
|
|
|
my $need_venv = 0;
|
|
|
|
my $need_virtualenv = 0;
|
2019-05-22 15:43:46 -06:00
|
|
|
my $rec_sphinx_upgrade = 0;
|
2017-07-17 15:46:36 -06:00
|
|
|
my $install = "";
|
2019-05-29 17:09:24 -06:00
|
|
|
my $virtenv_dir = "";
|
2020-04-14 10:56:13 -06:00
|
|
|
my $python_cmd = "";
|
2019-05-29 17:09:24 -06:00
|
|
|
my $min_version;
|
2020-04-21 08:31:07 -06:00
|
|
|
my $cur_version;
|
2020-04-21 08:31:06 -06:00
|
|
|
my $rec_version = "1.7.9"; # PDF won't build here
|
|
|
|
my $min_pdf_version = "2.4.4"; # Min version where pdf builds
|
2017-07-17 15:46:36 -06:00
|
|
|
|
|
|
|
#
|
|
|
|
# Command line arguments
|
|
|
|
#
|
|
|
|
|
|
|
|
my $pdf = 1;
|
|
|
|
my $virtualenv = 1;
|
scripts/sphinx-pre-install: always check if version is compatible with build
Call the script every time a make docs target is selected, on
a simplified check mode.
With this change, the script will set two vars:
$min_version - obtained from `needs_sphinx` var inside
conf.py (currently, '1.3')
$rec_version - obtained from sphinx/requirements.txt.
With those changes, a target like "make htmldocs" will do:
1) If no sphinx-build/sphinx-build3 is found, it will run
the script on normal mode as before, checking for all
system dependencies and providing install hints for the
needed programs and will abort the build;
2) If no sphinx-build/sphinx-build3 is found, but there is
a sphinx_${VER}/bin/activate file, and if
${VER} >= $min_version (string comparation), it will
run in full mode, and will recommend to activate the
virtualenv. If there are multiple virtualenvs, it
will string sort the versions, recommending the
highest version and will abort the build;
3) If Sphinx is detected but has a version lower than
$min_version, it will run in full mode - with will
recommend creating a virtual env using sphinx/requirements.txt,
and will abort the build.
4) If Sphinx is detected and version is lower than
$rec_version, it will run in full mode and will
recommend creating a virtual env using sphinx/requirements.txt.
In this case, it **won't** abort the build.
5) If Sphinx is detected and version is equal or righer than
$rec_version it will return just after detecting the
version ("quick mode"), not checking if are there any
missing dependencies.
Just like before, if one wants to install Sphinx from the
distro, it has to call the script manually and use `--no-virtualenv`
argument to get the hints for his OS:
You should run:
sudo dnf install -y python3-sphinx python3-sphinx_rtd_theme
While here, add a small help for the three optional arguments
for the script.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-05-29 17:09:26 -06:00
|
|
|
my $version_check = 0;
|
2017-07-17 15:46:36 -06:00
|
|
|
|
|
|
|
#
|
|
|
|
# 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};
|
|
|
|
|
2019-07-13 06:37:16 -06:00
|
|
|
# At least on some LTS distros like CentOS 7, texlive doesn't
|
|
|
|
# provide all packages we need. When such distros are
|
|
|
|
# detected, we have to disable PDF output.
|
|
|
|
#
|
|
|
|
# So, we need to ignore the packages that distros would
|
|
|
|
# need for LaTeX to work
|
|
|
|
if ($is_optional == 2 && !$pdf) {
|
|
|
|
$optional--;
|
|
|
|
next;
|
|
|
|
}
|
|
|
|
|
2017-07-17 15:46:36 -06:00
|
|
|
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($$$)
|
|
|
|
{
|
2019-10-02 07:33:39 -06:00
|
|
|
my $files = shift;
|
2017-07-17 15:46:36 -06:00
|
|
|
my $package = shift;
|
|
|
|
my $is_optional = shift;
|
|
|
|
|
2019-10-02 07:33:39 -06:00
|
|
|
for (@$files) {
|
|
|
|
return if(-e $_);
|
|
|
|
}
|
2017-07-17 15:46:36 -06:00
|
|
|
|
|
|
|
add_package($package, $is_optional);
|
|
|
|
}
|
|
|
|
|
|
|
|
sub findprog($)
|
|
|
|
{
|
|
|
|
foreach(split(/:/, $ENV{PATH})) {
|
|
|
|
return "$_/$_[0]" if(-x "$_/$_[0]");
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-04-21 08:31:08 -06:00
|
|
|
sub find_python_no_venv()
|
|
|
|
{
|
|
|
|
my $prog = shift;
|
|
|
|
|
|
|
|
my $cur_dir = qx(pwd);
|
|
|
|
$cur_dir =~ s/\s+$//;
|
|
|
|
|
|
|
|
foreach my $dir (split(/:/, $ENV{PATH})) {
|
|
|
|
next if ($dir =~ m,($cur_dir)/sphinx,);
|
|
|
|
return "$dir/python3" if(-x "$dir/python3");
|
|
|
|
}
|
|
|
|
foreach my $dir (split(/:/, $ENV{PATH})) {
|
|
|
|
next if ($dir =~ m,($cur_dir)/sphinx,);
|
|
|
|
return "$dir/python" if(-x "$dir/python");
|
|
|
|
}
|
|
|
|
return "python";
|
|
|
|
}
|
|
|
|
|
2017-07-17 15:46:36 -06:00
|
|
|
sub check_program($$)
|
|
|
|
{
|
|
|
|
my $prog = shift;
|
|
|
|
my $is_optional = shift;
|
|
|
|
|
2020-04-14 10:56:13 -06:00
|
|
|
return $prog if findprog($prog);
|
2017-07-17 15:46:36 -06:00
|
|
|
|
|
|
|
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;
|
|
|
|
|
2020-04-14 10:56:13 -06:00
|
|
|
return if (!$python_cmd);
|
|
|
|
|
|
|
|
my $err = system("$python_cmd -c 'import $prog' 2>/dev/null /dev/null");
|
2017-07-17 15:46:36 -06:00
|
|
|
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*$/);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-05-22 15:43:46 -06:00
|
|
|
sub get_sphinx_fname()
|
2017-07-17 15:46:36 -06:00
|
|
|
{
|
2019-05-22 15:43:46 -06:00
|
|
|
my $fname = "sphinx-build";
|
|
|
|
return $fname if findprog($fname);
|
2017-07-17 15:46:36 -06:00
|
|
|
|
2019-05-22 15:43:46 -06:00
|
|
|
$fname = "sphinx-build-3";
|
|
|
|
if (findprog($fname)) {
|
2017-07-17 15:46:36 -06:00
|
|
|
$need_symlink = 1;
|
2019-05-22 15:43:46 -06:00
|
|
|
return $fname;
|
2017-07-17 15:46:36 -06:00
|
|
|
}
|
|
|
|
|
2019-05-22 15:43:46 -06:00
|
|
|
return "";
|
|
|
|
}
|
|
|
|
|
2020-04-21 08:31:05 -06:00
|
|
|
sub get_sphinx_version($)
|
|
|
|
{
|
|
|
|
my $cmd = shift;
|
|
|
|
my $ver;
|
|
|
|
|
|
|
|
open IN, "$cmd --version 2>&1 |";
|
|
|
|
while (<IN>) {
|
|
|
|
if (m/^\s*sphinx-build\s+([\d\.]+)(\+\/[\da-f]+)?$/) {
|
|
|
|
$ver=$1;
|
|
|
|
last;
|
|
|
|
}
|
|
|
|
# Sphinx 1.2.x uses a different format
|
|
|
|
if (m/^\s*Sphinx.*\s+([\d\.]+)$/) {
|
|
|
|
$ver=$1;
|
|
|
|
last;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
close IN;
|
|
|
|
return $ver;
|
|
|
|
}
|
|
|
|
|
2019-05-22 15:43:46 -06:00
|
|
|
sub check_sphinx()
|
|
|
|
{
|
2020-04-21 08:31:06 -06:00
|
|
|
my $default_version;
|
2019-05-22 15:43:46 -06:00
|
|
|
|
|
|
|
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\.]+)$/) {
|
2020-04-21 08:31:06 -06:00
|
|
|
$default_version=$1;
|
2019-05-22 15:43:46 -06:00
|
|
|
last;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
close IN;
|
|
|
|
|
2020-04-21 08:31:06 -06:00
|
|
|
die "Can't get default sphinx version from $requirement_file" if (!$default_version);
|
2019-05-22 15:43:46 -06:00
|
|
|
|
2020-04-21 08:31:06 -06:00
|
|
|
$virtenv_dir = $virtenv_prefix . $default_version;
|
2019-05-22 15:43:46 -06:00
|
|
|
|
|
|
|
my $sphinx = get_sphinx_fname();
|
2020-04-14 10:56:13 -06:00
|
|
|
if ($sphinx eq "") {
|
|
|
|
$need_sphinx = 1;
|
|
|
|
return;
|
|
|
|
}
|
2019-05-22 15:43:46 -06:00
|
|
|
|
2020-04-21 08:31:05 -06:00
|
|
|
$cur_version = get_sphinx_version($sphinx);
|
|
|
|
die ("$sphinx returned an error") if (!$cur_version);
|
2019-05-22 15:43:46 -06:00
|
|
|
|
|
|
|
die "$sphinx didn't return its version" if (!$cur_version);
|
|
|
|
|
|
|
|
if ($cur_version lt $min_version) {
|
scripts/sphinx-pre-install: always check if version is compatible with build
Call the script every time a make docs target is selected, on
a simplified check mode.
With this change, the script will set two vars:
$min_version - obtained from `needs_sphinx` var inside
conf.py (currently, '1.3')
$rec_version - obtained from sphinx/requirements.txt.
With those changes, a target like "make htmldocs" will do:
1) If no sphinx-build/sphinx-build3 is found, it will run
the script on normal mode as before, checking for all
system dependencies and providing install hints for the
needed programs and will abort the build;
2) If no sphinx-build/sphinx-build3 is found, but there is
a sphinx_${VER}/bin/activate file, and if
${VER} >= $min_version (string comparation), it will
run in full mode, and will recommend to activate the
virtualenv. If there are multiple virtualenvs, it
will string sort the versions, recommending the
highest version and will abort the build;
3) If Sphinx is detected but has a version lower than
$min_version, it will run in full mode - with will
recommend creating a virtual env using sphinx/requirements.txt,
and will abort the build.
4) If Sphinx is detected and version is lower than
$rec_version, it will run in full mode and will
recommend creating a virtual env using sphinx/requirements.txt.
In this case, it **won't** abort the build.
5) If Sphinx is detected and version is equal or righer than
$rec_version it will return just after detecting the
version ("quick mode"), not checking if are there any
missing dependencies.
Just like before, if one wants to install Sphinx from the
distro, it has to call the script manually and use `--no-virtualenv`
argument to get the hints for his OS:
You should run:
sudo dnf install -y python3-sphinx python3-sphinx_rtd_theme
While here, add a small help for the three optional arguments
for the script.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-05-29 17:09:26 -06:00
|
|
|
printf "ERROR: Sphinx version is %s. It should be >= %s (recommended >= %s)\n",
|
2020-04-21 08:31:06 -06:00
|
|
|
$cur_version, $min_version, $default_version;
|
2019-05-22 15:43:46 -06:00
|
|
|
$need_sphinx = 1;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($cur_version lt $rec_version) {
|
2020-04-21 08:31:06 -06:00
|
|
|
$rec_sphinx_upgrade = 1;
|
|
|
|
return;
|
|
|
|
}
|
scripts/sphinx-pre-install: always check if version is compatible with build
Call the script every time a make docs target is selected, on
a simplified check mode.
With this change, the script will set two vars:
$min_version - obtained from `needs_sphinx` var inside
conf.py (currently, '1.3')
$rec_version - obtained from sphinx/requirements.txt.
With those changes, a target like "make htmldocs" will do:
1) If no sphinx-build/sphinx-build3 is found, it will run
the script on normal mode as before, checking for all
system dependencies and providing install hints for the
needed programs and will abort the build;
2) If no sphinx-build/sphinx-build3 is found, but there is
a sphinx_${VER}/bin/activate file, and if
${VER} >= $min_version (string comparation), it will
run in full mode, and will recommend to activate the
virtualenv. If there are multiple virtualenvs, it
will string sort the versions, recommending the
highest version and will abort the build;
3) If Sphinx is detected but has a version lower than
$min_version, it will run in full mode - with will
recommend creating a virtual env using sphinx/requirements.txt,
and will abort the build.
4) If Sphinx is detected and version is lower than
$rec_version, it will run in full mode and will
recommend creating a virtual env using sphinx/requirements.txt.
In this case, it **won't** abort the build.
5) If Sphinx is detected and version is equal or righer than
$rec_version it will return just after detecting the
version ("quick mode"), not checking if are there any
missing dependencies.
Just like before, if one wants to install Sphinx from the
distro, it has to call the script manually and use `--no-virtualenv`
argument to get the hints for his OS:
You should run:
sudo dnf install -y python3-sphinx python3-sphinx_rtd_theme
While here, add a small help for the three optional arguments
for the script.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-05-29 17:09:26 -06:00
|
|
|
|
|
|
|
# On version check mode, just assume Sphinx has all mandatory deps
|
|
|
|
exit (0) if ($version_check);
|
2017-07-17 15:46:36 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
#
|
|
|
|
# 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",
|
2020-04-14 10:56:13 -06:00
|
|
|
"ensurepip" => "python3-venv",
|
2017-07-17 15:46:36 -06:00
|
|
|
"virtualenv" => "virtualenv",
|
|
|
|
"dot" => "graphviz",
|
|
|
|
"convert" => "imagemagick",
|
|
|
|
"Pod::Usage" => "perl-modules",
|
|
|
|
"xelatex" => "texlive-xetex",
|
2017-07-17 15:46:40 -06:00
|
|
|
"rsvg-convert" => "librsvg2-bin",
|
2017-07-17 15:46:36 -06:00
|
|
|
);
|
|
|
|
|
|
|
|
if ($pdf) {
|
2019-10-02 07:33:39 -06:00
|
|
|
check_missing_file(["/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf"],
|
2019-07-13 06:37:16 -06:00
|
|
|
"fonts-dejavu", 2);
|
2019-07-13 05:19:44 -06:00
|
|
|
|
2019-10-02 07:35:42 -06:00
|
|
|
check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc",
|
2020-04-14 10:56:10 -06:00
|
|
|
"/usr/share/fonts/opentype/noto/NotoSansCJK-Regular.ttc",
|
|
|
|
"/usr/share/fonts/opentype/noto/NotoSerifCJK-Regular.ttc"],
|
2019-07-13 05:19:44 -06:00
|
|
|
"fonts-noto-cjk", 2);
|
2017-07-17 15:46:36 -06:00
|
|
|
}
|
|
|
|
|
2019-07-13 06:37:16 -06:00
|
|
|
check_program("dvipng", 2) if ($pdf);
|
2017-07-17 15:46:36 -06:00
|
|
|
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",
|
2017-07-17 15:46:40 -06:00
|
|
|
"rsvg-convert" => "librsvg2-tools",
|
2017-07-17 15:46:36 -06:00
|
|
|
);
|
|
|
|
|
2017-07-17 15:46:39 -06:00
|
|
|
my @fedora26_opt_pkgs = (
|
|
|
|
"graphviz-gd", # Fedora 26: needed for PDF support
|
|
|
|
);
|
|
|
|
|
2017-07-17 15:46:36 -06:00
|
|
|
my @fedora_tex_pkgs = (
|
|
|
|
"texlive-collection-fontsrecommended",
|
|
|
|
"texlive-collection-latex",
|
2019-07-13 05:19:44 -06:00
|
|
|
"texlive-xecjk",
|
2017-07-17 15:46:36 -06:00
|
|
|
"dejavu-sans-fonts",
|
|
|
|
"dejavu-serif-fonts",
|
|
|
|
"dejavu-sans-mono-fonts",
|
|
|
|
);
|
|
|
|
|
scripts/sphinx-pre-install: add minimum support for RHEL
RHEL 7.x and clone distros are shipped with Sphinx 1.1.x,
with is incompatible with Kernel ReST markups.
So, on those systems, the only alternative is to install
it via a Python virtual environment.
While seeking for "pip" on CentOS 7.3, I noticed that it
is not really needed, as python-virtualenv has its version
packaged there already. So, remove this from the list of
requirements for all distributions.
With regards to PDF, we need at least texlive-tabulary
extension, but that is not shipped there (at least on
CentOS). So, disable PDF packages as a whole.
Please notice, however, that texlive + amsmath is needed for
ReST to properly handle ReST ".. math::" tags. Yet, Sphinx
fall back to display the LaTeX math expressions as-is, if
such extension is not available.
So, let's just disable all texlive packages as a whole.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-07-24 06:09:24 -06:00
|
|
|
#
|
|
|
|
# Checks valid for RHEL/CentOS version 7.x.
|
|
|
|
#
|
2019-07-13 06:37:16 -06:00
|
|
|
my $old = 0;
|
|
|
|
my $rel;
|
|
|
|
$rel = $1 if ($system_release =~ /release\s+(\d+)/);
|
|
|
|
|
2019-07-13 05:50:24 -06:00
|
|
|
if (!($system_release =~ /Fedora/)) {
|
scripts/sphinx-pre-install: add minimum support for RHEL
RHEL 7.x and clone distros are shipped with Sphinx 1.1.x,
with is incompatible with Kernel ReST markups.
So, on those systems, the only alternative is to install
it via a Python virtual environment.
While seeking for "pip" on CentOS 7.3, I noticed that it
is not really needed, as python-virtualenv has its version
packaged there already. So, remove this from the list of
requirements for all distributions.
With regards to PDF, we need at least texlive-tabulary
extension, but that is not shipped there (at least on
CentOS). So, disable PDF packages as a whole.
Please notice, however, that texlive + amsmath is needed for
ReST to properly handle ReST ".. math::" tags. Yet, Sphinx
fall back to display the LaTeX math expressions as-is, if
such extension is not available.
So, let's just disable all texlive packages as a whole.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-07-24 06:09:24 -06:00
|
|
|
$map{"virtualenv"} = "python-virtualenv";
|
|
|
|
|
2019-07-13 06:37:16 -06:00
|
|
|
if ($rel && $rel < 8) {
|
|
|
|
$old = 1;
|
|
|
|
$pdf = 0;
|
2017-07-17 15:46:39 -06:00
|
|
|
|
2019-07-13 06:37:16 -06:00
|
|
|
printf("Note: texlive packages on RHEL/CENTOS <= 7 are incomplete. Can't support PDF output\n");
|
|
|
|
printf("If you want to build PDF, please read:\n");
|
|
|
|
printf("\thttps://www.systutorials.com/241660/how-to-install-tex-live-on-centos-7-linux/\n");
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
if ($rel && $rel < 26) {
|
|
|
|
$old = 1;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (!$rel) {
|
|
|
|
printf("Couldn't identify release number\n");
|
|
|
|
$old = 1;
|
|
|
|
$pdf = 0;
|
|
|
|
}
|
2017-07-17 15:46:39 -06:00
|
|
|
|
2019-07-13 05:19:44 -06:00
|
|
|
if ($pdf) {
|
2019-10-02 07:33:39 -06:00
|
|
|
check_missing_file(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc"],
|
2019-07-13 05:19:44 -06:00
|
|
|
"google-noto-sans-cjk-ttc-fonts", 2);
|
|
|
|
}
|
|
|
|
|
2019-07-13 06:37:16 -06:00
|
|
|
check_rpm_missing(\@fedora26_opt_pkgs, 2) if ($pdf && !$old);
|
|
|
|
check_rpm_missing(\@fedora_tex_pkgs, 2) if ($pdf);
|
|
|
|
check_missing_tex(2) if ($pdf);
|
2017-07-17 15:46:36 -06:00
|
|
|
check_missing(\%map);
|
|
|
|
|
|
|
|
return if (!$need && !$optional);
|
scripts/sphinx-pre-install: add minimum support for RHEL
RHEL 7.x and clone distros are shipped with Sphinx 1.1.x,
with is incompatible with Kernel ReST markups.
So, on those systems, the only alternative is to install
it via a Python virtual environment.
While seeking for "pip" on CentOS 7.3, I noticed that it
is not really needed, as python-virtualenv has its version
packaged there already. So, remove this from the list of
requirements for all distributions.
With regards to PDF, we need at least texlive-tabulary
extension, but that is not shipped there (at least on
CentOS). So, disable PDF packages as a whole.
Please notice, however, that texlive + amsmath is needed for
ReST to properly handle ReST ".. math::" tags. Yet, Sphinx
fall back to display the LaTeX math expressions as-is, if
such extension is not available.
So, let's just disable all texlive packages as a whole.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-07-24 06:09:24 -06:00
|
|
|
|
2019-07-13 06:37:16 -06:00
|
|
|
if (!$old) {
|
scripts/sphinx-pre-install: add minimum support for RHEL
RHEL 7.x and clone distros are shipped with Sphinx 1.1.x,
with is incompatible with Kernel ReST markups.
So, on those systems, the only alternative is to install
it via a Python virtual environment.
While seeking for "pip" on CentOS 7.3, I noticed that it
is not really needed, as python-virtualenv has its version
packaged there already. So, remove this from the list of
requirements for all distributions.
With regards to PDF, we need at least texlive-tabulary
extension, but that is not shipped there (at least on
CentOS). So, disable PDF packages as a whole.
Please notice, however, that texlive + amsmath is needed for
ReST to properly handle ReST ".. math::" tags. Yet, Sphinx
fall back to display the LaTeX math expressions as-is, if
such extension is not available.
So, let's just disable all texlive packages as a whole.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-07-24 06:09:24 -06:00
|
|
|
# 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");
|
|
|
|
}
|
2017-07-17 15:46:36 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
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",
|
|
|
|
);
|
|
|
|
|
2020-04-14 10:56:09 -06:00
|
|
|
# On Tumbleweed, this package is also named rsvg-convert
|
|
|
|
$map{"rsvg-convert"} = "rsvg-view" if (!($system_release =~ /Tumbleweed/));
|
|
|
|
|
2017-07-17 15:46:36 -06:00
|
|
|
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",
|
|
|
|
);
|
|
|
|
|
2019-07-13 05:19:44 -06:00
|
|
|
$map{"latexmk"} = "texlive-latexmk-bin";
|
|
|
|
|
2019-07-13 05:19:44 -06:00
|
|
|
# FIXME: add support for installing CJK fonts
|
|
|
|
#
|
|
|
|
# I tried hard, but was unable to find a way to install
|
|
|
|
# "Noto Sans CJK SC" on openSUSE
|
|
|
|
|
2019-07-13 06:37:16 -06:00
|
|
|
check_rpm_missing(\@suse_tex_pkgs, 2) if ($pdf);
|
|
|
|
check_missing_tex(2) if ($pdf);
|
2017-07-17 15:46:36 -06:00
|
|
|
check_missing(\%map);
|
|
|
|
|
|
|
|
return if (!$need && !$optional);
|
|
|
|
printf("You should run:\n\n\tsudo zypper install --no-recommends $install\n");
|
|
|
|
}
|
|
|
|
|
2017-07-21 10:20:41 -06:00
|
|
|
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",
|
2020-04-14 10:56:12 -06:00
|
|
|
"rsvg-convert" => "librsvg2",
|
2017-07-21 10:20:41 -06:00
|
|
|
);
|
|
|
|
|
|
|
|
my @tex_pkgs = (
|
|
|
|
"texlive-fontsextra",
|
|
|
|
);
|
|
|
|
|
2019-07-13 05:19:44 -06:00
|
|
|
$map{"latexmk"} = "texlive-collection-basic";
|
|
|
|
|
2020-04-14 10:56:12 -06:00
|
|
|
my $packager_cmd;
|
|
|
|
my $noto_sans;
|
|
|
|
if ($system_release =~ /OpenMandriva/) {
|
|
|
|
$packager_cmd = "dnf install";
|
|
|
|
$noto_sans = "noto-sans-cjk-fonts";
|
|
|
|
@tex_pkgs = ( "texlive-collection-fontsextra" );
|
|
|
|
} else {
|
|
|
|
$packager_cmd = "urpmi";
|
|
|
|
$noto_sans = "google-noto-sans-cjk-ttc-fonts";
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2019-07-13 05:19:44 -06:00
|
|
|
if ($pdf) {
|
2020-04-14 10:56:12 -06:00
|
|
|
check_missing_file(["/usr/share/fonts/google-noto-cjk/NotoSansCJK-Regular.ttc",
|
|
|
|
"/usr/share/fonts/TTF/NotoSans-Regular.ttf"],
|
|
|
|
$noto_sans, 2);
|
2019-07-13 05:19:44 -06:00
|
|
|
}
|
|
|
|
|
2019-07-13 06:37:16 -06:00
|
|
|
check_rpm_missing(\@tex_pkgs, 2) if ($pdf);
|
2017-07-21 10:20:41 -06:00
|
|
|
check_missing(\%map);
|
|
|
|
|
|
|
|
return if (!$need && !$optional);
|
2020-04-14 10:56:12 -06:00
|
|
|
printf("You should run:\n\n\tsudo $packager_cmd $install\n");
|
2017-07-21 10:20:41 -06:00
|
|
|
}
|
|
|
|
|
2017-07-17 15:46:36 -06:00
|
|
|
sub give_arch_linux_hints()
|
|
|
|
{
|
|
|
|
my %map = (
|
|
|
|
"sphinx_rtd_theme" => "python-sphinx_rtd_theme",
|
|
|
|
"virtualenv" => "python-virtualenv",
|
|
|
|
"dot" => "graphviz",
|
|
|
|
"convert" => "imagemagick",
|
|
|
|
"xelatex" => "texlive-bin",
|
2019-11-02 12:45:11 -06:00
|
|
|
"latexmk" => "texlive-core",
|
2017-07-17 15:46:40 -06:00
|
|
|
"rsvg-convert" => "extra/librsvg",
|
2017-07-17 15:46:36 -06:00
|
|
|
);
|
|
|
|
|
|
|
|
my @archlinux_tex_pkgs = (
|
|
|
|
"texlive-core",
|
|
|
|
"texlive-latexextra",
|
|
|
|
"ttf-dejavu",
|
|
|
|
);
|
2019-07-13 06:37:16 -06:00
|
|
|
check_pacman_missing(\@archlinux_tex_pkgs, 2) if ($pdf);
|
|
|
|
|
2019-07-13 05:19:44 -06:00
|
|
|
if ($pdf) {
|
2019-10-02 07:33:39 -06:00
|
|
|
check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJK-Regular.ttc"],
|
2019-07-13 05:19:44 -06:00
|
|
|
"noto-fonts-cjk", 2);
|
|
|
|
}
|
|
|
|
|
2017-07-17 15:46:36 -06:00
|
|
|
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",
|
2017-07-17 15:46:40 -06:00
|
|
|
"rsvg-convert" => "gnome-base/librsvg",
|
2017-07-17 15:46:36 -06:00
|
|
|
);
|
|
|
|
|
2019-10-02 07:33:39 -06:00
|
|
|
check_missing_file(["/usr/share/fonts/dejavu/DejaVuSans.ttf"],
|
2019-07-13 06:37:16 -06:00
|
|
|
"media-fonts/dejavu", 2) if ($pdf);
|
2017-07-17 15:46:36 -06:00
|
|
|
|
2019-07-13 05:19:44 -06:00
|
|
|
if ($pdf) {
|
2020-04-14 10:56:11 -06:00
|
|
|
check_missing_file(["/usr/share/fonts/noto-cjk/NotoSansCJKsc-Regular.otf",
|
|
|
|
"/usr/share/fonts/noto-cjk/NotoSerifCJK-Regular.ttc"],
|
2019-07-13 05:19:44 -06:00
|
|
|
"media-fonts/noto-cjk", 2);
|
|
|
|
}
|
|
|
|
|
2017-07-17 15:46:36 -06:00
|
|
|
check_missing(\%map);
|
|
|
|
|
|
|
|
return if (!$need && !$optional);
|
2017-07-17 15:46:41 -06:00
|
|
|
|
|
|
|
printf("You should run:\n\n");
|
2019-07-13 05:19:44 -06:00
|
|
|
|
|
|
|
my $imagemagick = "media-gfx/imagemagick svg png";
|
|
|
|
my $cairo = "media-gfx/graphviz cairo pdf";
|
|
|
|
my $portage_imagemagick = "/etc/portage/package.use/imagemagick";
|
|
|
|
my $portage_cairo = "/etc/portage/package.use/graphviz";
|
|
|
|
|
2020-04-14 10:56:11 -06:00
|
|
|
if (qx(grep imagemagick $portage_imagemagick 2>/dev/null) eq "") {
|
2019-07-13 05:19:44 -06:00
|
|
|
printf("\tsudo su -c 'echo \"$imagemagick\" > $portage_imagemagick'\n")
|
|
|
|
}
|
2020-04-14 10:56:11 -06:00
|
|
|
if (qx(grep graphviz $portage_cairo 2>/dev/null) eq "") {
|
2019-07-13 05:19:44 -06:00
|
|
|
printf("\tsudo su -c 'echo \"$cairo\" > $portage_cairo'\n");
|
|
|
|
}
|
|
|
|
|
2017-07-17 15:46:41 -06:00
|
|
|
printf("\tsudo emerge --ask $install\n");
|
|
|
|
|
2017-07-17 15:46:36 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
sub check_distros()
|
|
|
|
{
|
|
|
|
# Distro-specific hints
|
|
|
|
if ($system_release =~ /Red Hat Enterprise Linux/) {
|
|
|
|
give_redhat_hints;
|
|
|
|
return;
|
|
|
|
}
|
scripts/sphinx-pre-install: add minimum support for RHEL
RHEL 7.x and clone distros are shipped with Sphinx 1.1.x,
with is incompatible with Kernel ReST markups.
So, on those systems, the only alternative is to install
it via a Python virtual environment.
While seeking for "pip" on CentOS 7.3, I noticed that it
is not really needed, as python-virtualenv has its version
packaged there already. So, remove this from the list of
requirements for all distributions.
With regards to PDF, we need at least texlive-tabulary
extension, but that is not shipped there (at least on
CentOS). So, disable PDF packages as a whole.
Please notice, however, that texlive + amsmath is needed for
ReST to properly handle ReST ".. math::" tags. Yet, Sphinx
fall back to display the LaTeX math expressions as-is, if
such extension is not available.
So, let's just disable all texlive packages as a whole.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-07-24 06:09:24 -06:00
|
|
|
if ($system_release =~ /CentOS/) {
|
|
|
|
give_redhat_hints;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if ($system_release =~ /Scientific Linux/) {
|
|
|
|
give_redhat_hints;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if ($system_release =~ /Oracle Linux Server/) {
|
|
|
|
give_redhat_hints;
|
|
|
|
return;
|
|
|
|
}
|
2017-07-17 15:46:36 -06:00
|
|
|
if ($system_release =~ /Fedora/) {
|
|
|
|
give_redhat_hints;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if ($system_release =~ /Ubuntu/) {
|
|
|
|
give_debian_hints;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if ($system_release =~ /Debian/) {
|
|
|
|
give_debian_hints;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if ($system_release =~ /openSUSE/) {
|
|
|
|
give_opensuse_hints;
|
|
|
|
return;
|
|
|
|
}
|
2017-07-21 10:20:41 -06:00
|
|
|
if ($system_release =~ /Mageia/) {
|
|
|
|
give_mageia_hints;
|
|
|
|
return;
|
|
|
|
}
|
2020-04-14 10:56:12 -06:00
|
|
|
if ($system_release =~ /OpenMandriva/) {
|
|
|
|
give_mageia_hints;
|
|
|
|
return;
|
|
|
|
}
|
2017-07-17 15:46:36 -06:00
|
|
|
if ($system_release =~ /Arch Linux/) {
|
|
|
|
give_arch_linux_hints;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
if ($system_release =~ /Gentoo/) {
|
|
|
|
give_gentoo_hints;
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
#
|
|
|
|
# Fall-back to generic hint code for other distros
|
|
|
|
# That's far from ideal, specially for LaTeX dependencies.
|
|
|
|
#
|
|
|
|
my %map = (
|
|
|
|
"sphinx-build" => "sphinx"
|
|
|
|
);
|
2019-07-13 06:37:16 -06:00
|
|
|
check_missing_tex(2) if ($pdf);
|
2017-07-17 15:46:36 -06:00
|
|
|
check_missing(\%map);
|
|
|
|
print "I don't know distro $system_release.\n";
|
|
|
|
print "So, I can't provide you a hint with the install procedure.\n";
|
|
|
|
print "There are likely missing dependencies.\n";
|
|
|
|
}
|
|
|
|
|
|
|
|
#
|
|
|
|
# Common dependencies
|
|
|
|
#
|
|
|
|
|
2019-09-18 18:37:54 -06:00
|
|
|
sub deactivate_help()
|
|
|
|
{
|
2020-04-14 10:56:13 -06:00
|
|
|
printf "\nIf you want to exit the virtualenv, you can use:\n";
|
2019-09-18 18:37:54 -06:00
|
|
|
printf "\tdeactivate\n";
|
|
|
|
}
|
|
|
|
|
2017-07-17 15:46:36 -06:00
|
|
|
sub check_needs()
|
|
|
|
{
|
2020-04-14 10:56:13 -06:00
|
|
|
# Check if Sphinx is already accessible from current environment
|
scripts/sphinx-pre-install: always check if version is compatible with build
Call the script every time a make docs target is selected, on
a simplified check mode.
With this change, the script will set two vars:
$min_version - obtained from `needs_sphinx` var inside
conf.py (currently, '1.3')
$rec_version - obtained from sphinx/requirements.txt.
With those changes, a target like "make htmldocs" will do:
1) If no sphinx-build/sphinx-build3 is found, it will run
the script on normal mode as before, checking for all
system dependencies and providing install hints for the
needed programs and will abort the build;
2) If no sphinx-build/sphinx-build3 is found, but there is
a sphinx_${VER}/bin/activate file, and if
${VER} >= $min_version (string comparation), it will
run in full mode, and will recommend to activate the
virtualenv. If there are multiple virtualenvs, it
will string sort the versions, recommending the
highest version and will abort the build;
3) If Sphinx is detected but has a version lower than
$min_version, it will run in full mode - with will
recommend creating a virtual env using sphinx/requirements.txt,
and will abort the build.
4) If Sphinx is detected and version is lower than
$rec_version, it will run in full mode and will
recommend creating a virtual env using sphinx/requirements.txt.
In this case, it **won't** abort the build.
5) If Sphinx is detected and version is equal or righer than
$rec_version it will return just after detecting the
version ("quick mode"), not checking if are there any
missing dependencies.
Just like before, if one wants to install Sphinx from the
distro, it has to call the script manually and use `--no-virtualenv`
argument to get the hints for his OS:
You should run:
sudo dnf install -y python3-sphinx python3-sphinx_rtd_theme
While here, add a small help for the three optional arguments
for the script.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-05-29 17:09:26 -06:00
|
|
|
check_sphinx();
|
|
|
|
|
2017-07-17 15:46:36 -06:00
|
|
|
if ($system_release) {
|
2020-04-21 10:27:58 -06:00
|
|
|
print "Detected OS: $system_release.\n";
|
2017-07-17 15:46:36 -06:00
|
|
|
} else {
|
2020-04-21 10:27:58 -06:00
|
|
|
print "Unknown OS\n";
|
scripts/sphinx-pre-install: add minimum support for RHEL
RHEL 7.x and clone distros are shipped with Sphinx 1.1.x,
with is incompatible with Kernel ReST markups.
So, on those systems, the only alternative is to install
it via a Python virtual environment.
While seeking for "pip" on CentOS 7.3, I noticed that it
is not really needed, as python-virtualenv has its version
packaged there already. So, remove this from the list of
requirements for all distributions.
With regards to PDF, we need at least texlive-tabulary
extension, but that is not shipped there (at least on
CentOS). So, disable PDF packages as a whole.
Please notice, however, that texlive + amsmath is needed for
ReST to properly handle ReST ".. math::" tags. Yet, Sphinx
fall back to display the LaTeX math expressions as-is, if
such extension is not available.
So, let's just disable all texlive packages as a whole.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-07-24 06:09:24 -06:00
|
|
|
}
|
2020-04-21 10:27:58 -06:00
|
|
|
printf "Sphinx version: %s\n\n", $cur_version if ($cur_version);
|
scripts/sphinx-pre-install: add minimum support for RHEL
RHEL 7.x and clone distros are shipped with Sphinx 1.1.x,
with is incompatible with Kernel ReST markups.
So, on those systems, the only alternative is to install
it via a Python virtual environment.
While seeking for "pip" on CentOS 7.3, I noticed that it
is not really needed, as python-virtualenv has its version
packaged there already. So, remove this from the list of
requirements for all distributions.
With regards to PDF, we need at least texlive-tabulary
extension, but that is not shipped there (at least on
CentOS). So, disable PDF packages as a whole.
Please notice, however, that texlive + amsmath is needed for
ReST to properly handle ReST ".. math::" tags. Yet, Sphinx
fall back to display the LaTeX math expressions as-is, if
such extension is not available.
So, let's just disable all texlive packages as a whole.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-07-24 06:09:24 -06:00
|
|
|
|
2020-04-14 10:56:13 -06:00
|
|
|
# Check python command line, trying first python3
|
|
|
|
$python_cmd = findprog("python3");
|
|
|
|
$python_cmd = check_program("python", 0) if (!$python_cmd);
|
|
|
|
|
|
|
|
# Check the type of virtual env, depending on Python version
|
|
|
|
if ($python_cmd) {
|
|
|
|
if ($virtualenv) {
|
|
|
|
my $tmp = qx($python_cmd --version 2>&1);
|
|
|
|
if ($tmp =~ m/(\d+\.)(\d+\.)/) {
|
|
|
|
if ($1 >= 3 && $2 >= 3) {
|
|
|
|
$need_venv = 1; # python 3.3 or upper
|
|
|
|
} else {
|
|
|
|
$need_virtualenv = 1;
|
|
|
|
}
|
|
|
|
if ($1 < 3) {
|
|
|
|
# Complain if it finds python2 (or worse)
|
|
|
|
printf "Warning: python$1 support is deprecated. Use it with caution!\n";
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
die "Warning: couldn't identify $python_cmd version!";
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
add_package("python-sphinx", 0);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
# Set virtualenv command line, if python < 3.3
|
|
|
|
my $virtualenv_cmd;
|
|
|
|
if ($need_virtualenv) {
|
|
|
|
$virtualenv_cmd = findprog("virtualenv-3");
|
|
|
|
$virtualenv_cmd = findprog("virtualenv-3.5") if (!$virtualenv_cmd);
|
|
|
|
if (!$virtualenv_cmd) {
|
|
|
|
check_program("virtualenv", 0);
|
|
|
|
$virtualenv_cmd = "virtualenv";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-17 15:46:36 -06:00
|
|
|
# Check for needed programs/tools
|
|
|
|
check_perl_module("Pod::Usage", 0);
|
|
|
|
check_program("make", 0);
|
|
|
|
check_program("gcc", 0);
|
|
|
|
check_python_module("sphinx_rtd_theme", 1) if (!$virtualenv);
|
|
|
|
check_program("dot", 1);
|
|
|
|
check_program("convert", 1);
|
2019-07-13 06:37:16 -06:00
|
|
|
|
|
|
|
# Extra PDF files - should use 2 for is_optional
|
|
|
|
check_program("xelatex", 2) if ($pdf);
|
|
|
|
check_program("rsvg-convert", 2) if ($pdf);
|
|
|
|
check_program("latexmk", 2) if ($pdf);
|
2017-07-17 15:46:36 -06:00
|
|
|
|
2020-04-14 10:56:13 -06:00
|
|
|
if ($need_sphinx || $rec_sphinx_upgrade) {
|
|
|
|
check_python_module("ensurepip", 0) if ($need_venv);
|
|
|
|
}
|
|
|
|
|
|
|
|
# Do distro-specific checks and output distro-install commands
|
2017-07-17 15:46:36 -06:00
|
|
|
check_distros();
|
|
|
|
|
2020-04-14 10:56:13 -06:00
|
|
|
if (!$python_cmd) {
|
|
|
|
if ($need == 1) {
|
|
|
|
die "Can't build as $need mandatory dependency is missing";
|
|
|
|
} elsif ($need) {
|
|
|
|
die "Can't build as $need mandatory dependencies are missing";
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
# Check if sphinx-build is called sphinx-build-3
|
2017-07-17 15:46:36 -06:00
|
|
|
if ($need_symlink) {
|
|
|
|
printf "\tsudo ln -sf %s /usr/bin/sphinx-build\n\n",
|
|
|
|
which("sphinx-build-3");
|
|
|
|
}
|
2020-04-14 10:56:13 -06:00
|
|
|
|
|
|
|
# NOTE: if the system has a too old Sphinx version installed,
|
|
|
|
# it will recommend installing a newer version using virtualenv
|
|
|
|
|
2019-05-22 15:43:46 -06:00
|
|
|
if ($need_sphinx || $rec_sphinx_upgrade) {
|
2019-05-29 17:09:24 -06:00
|
|
|
my $min_activate = "$ENV{'PWD'}/${virtenv_prefix}${min_version}/bin/activate";
|
scripts/sphinx-pre-install: always check if version is compatible with build
Call the script every time a make docs target is selected, on
a simplified check mode.
With this change, the script will set two vars:
$min_version - obtained from `needs_sphinx` var inside
conf.py (currently, '1.3')
$rec_version - obtained from sphinx/requirements.txt.
With those changes, a target like "make htmldocs" will do:
1) If no sphinx-build/sphinx-build3 is found, it will run
the script on normal mode as before, checking for all
system dependencies and providing install hints for the
needed programs and will abort the build;
2) If no sphinx-build/sphinx-build3 is found, but there is
a sphinx_${VER}/bin/activate file, and if
${VER} >= $min_version (string comparation), it will
run in full mode, and will recommend to activate the
virtualenv. If there are multiple virtualenvs, it
will string sort the versions, recommending the
highest version and will abort the build;
3) If Sphinx is detected but has a version lower than
$min_version, it will run in full mode - with will
recommend creating a virtual env using sphinx/requirements.txt,
and will abort the build.
4) If Sphinx is detected and version is lower than
$rec_version, it will run in full mode and will
recommend creating a virtual env using sphinx/requirements.txt.
In this case, it **won't** abort the build.
5) If Sphinx is detected and version is equal or righer than
$rec_version it will return just after detecting the
version ("quick mode"), not checking if are there any
missing dependencies.
Just like before, if one wants to install Sphinx from the
distro, it has to call the script manually and use `--no-virtualenv`
argument to get the hints for his OS:
You should run:
sudo dnf install -y python3-sphinx python3-sphinx_rtd_theme
While here, add a small help for the three optional arguments
for the script.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-05-29 17:09:26 -06:00
|
|
|
my @activates = glob "$ENV{'PWD'}/${virtenv_prefix}*/bin/activate";
|
2019-05-29 17:09:24 -06:00
|
|
|
|
2020-04-21 10:27:58 -06:00
|
|
|
if ($cur_version lt $rec_version) {
|
|
|
|
print "Warning: It is recommended at least Sphinx version $rec_version.\n";
|
|
|
|
print " If you want pdf, you need at least $min_pdf_version.\n";
|
|
|
|
}
|
|
|
|
if ($cur_version lt $min_pdf_version) {
|
|
|
|
print "Note: It is recommended at least Sphinx version $min_pdf_version if you need PDF support.\n";
|
|
|
|
}
|
scripts/sphinx-pre-install: always check if version is compatible with build
Call the script every time a make docs target is selected, on
a simplified check mode.
With this change, the script will set two vars:
$min_version - obtained from `needs_sphinx` var inside
conf.py (currently, '1.3')
$rec_version - obtained from sphinx/requirements.txt.
With those changes, a target like "make htmldocs" will do:
1) If no sphinx-build/sphinx-build3 is found, it will run
the script on normal mode as before, checking for all
system dependencies and providing install hints for the
needed programs and will abort the build;
2) If no sphinx-build/sphinx-build3 is found, but there is
a sphinx_${VER}/bin/activate file, and if
${VER} >= $min_version (string comparation), it will
run in full mode, and will recommend to activate the
virtualenv. If there are multiple virtualenvs, it
will string sort the versions, recommending the
highest version and will abort the build;
3) If Sphinx is detected but has a version lower than
$min_version, it will run in full mode - with will
recommend creating a virtual env using sphinx/requirements.txt,
and will abort the build.
4) If Sphinx is detected and version is lower than
$rec_version, it will run in full mode and will
recommend creating a virtual env using sphinx/requirements.txt.
In this case, it **won't** abort the build.
5) If Sphinx is detected and version is equal or righer than
$rec_version it will return just after detecting the
version ("quick mode"), not checking if are there any
missing dependencies.
Just like before, if one wants to install Sphinx from the
distro, it has to call the script manually and use `--no-virtualenv`
argument to get the hints for his OS:
You should run:
sudo dnf install -y python3-sphinx python3-sphinx_rtd_theme
While here, add a small help for the three optional arguments
for the script.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-05-29 17:09:26 -06:00
|
|
|
@activates = sort {$b cmp $a} @activates;
|
2020-04-21 08:31:05 -06:00
|
|
|
my ($activate, $ver);
|
|
|
|
foreach my $f (@activates) {
|
2020-04-21 08:31:07 -06:00
|
|
|
next if ($f lt $min_activate);
|
2020-04-21 08:31:05 -06:00
|
|
|
|
2020-04-21 08:31:07 -06:00
|
|
|
my $sphinx_cmd = $f;
|
2020-04-21 08:31:05 -06:00
|
|
|
$sphinx_cmd =~ s/activate/sphinx-build/;
|
|
|
|
next if (! -f $sphinx_cmd);
|
2019-05-29 17:09:24 -06:00
|
|
|
|
2020-04-21 08:31:05 -06:00
|
|
|
$ver = get_sphinx_version($sphinx_cmd);
|
2020-04-21 08:31:07 -06:00
|
|
|
if ($need_sphinx && ($ver ge $min_version)) {
|
|
|
|
$activate = $f;
|
|
|
|
last;
|
|
|
|
} elsif ($ver gt $cur_version) {
|
|
|
|
$activate = $f;
|
|
|
|
last;
|
|
|
|
}
|
2020-04-21 08:31:05 -06:00
|
|
|
}
|
2020-04-21 08:31:07 -06:00
|
|
|
if ($activate ne "") {
|
|
|
|
if ($need_sphinx) {
|
|
|
|
printf "\nNeed to activate Sphinx (version $ver) on virtualenv with:\n";
|
|
|
|
printf "\t. $activate\n";
|
|
|
|
deactivate_help();
|
|
|
|
exit (1);
|
|
|
|
} else {
|
|
|
|
printf "\nYou may also use a newer Sphinx (version $ver) with:\n";
|
|
|
|
printf "\tdeactivate && . $activate\n";
|
|
|
|
}
|
2017-07-17 15:46:37 -06:00
|
|
|
} else {
|
2019-05-29 17:09:24 -06:00
|
|
|
my $rec_activate = "$virtenv_dir/bin/activate";
|
2020-02-24 18:34:41 -07:00
|
|
|
|
2020-04-21 08:31:07 -06:00
|
|
|
print "To upgrade Sphinx, use:\n\n" if ($rec_sphinx_upgrade);
|
|
|
|
|
2020-04-21 08:31:08 -06:00
|
|
|
$python_cmd = find_python_no_venv();
|
|
|
|
|
2020-04-14 10:56:13 -06:00
|
|
|
if ($need_venv) {
|
|
|
|
printf "\t$python_cmd -m venv $virtenv_dir\n";
|
|
|
|
} else {
|
|
|
|
printf "\t$virtualenv_cmd $virtenv_dir\n";
|
|
|
|
}
|
2019-05-29 17:09:24 -06:00
|
|
|
printf "\t. $rec_activate\n";
|
2017-07-17 15:46:38 -06:00
|
|
|
printf "\tpip install -r $requirement_file\n";
|
2019-09-18 18:37:54 -06:00
|
|
|
deactivate_help();
|
2019-05-22 15:43:46 -06:00
|
|
|
|
|
|
|
$need++ if (!$rec_sphinx_upgrade);
|
2017-07-17 15:46:37 -06:00
|
|
|
}
|
2017-07-17 15:46:36 -06:00
|
|
|
}
|
|
|
|
printf "\n";
|
|
|
|
|
2019-05-30 15:59:14 -06:00
|
|
|
print "All optional dependencies are met.\n" if (!$optional);
|
2017-07-17 15:46:36 -06:00
|
|
|
|
|
|
|
if ($need == 1) {
|
|
|
|
die "Can't build as $need mandatory dependency is missing";
|
|
|
|
} elsif ($need) {
|
|
|
|
die "Can't build as $need mandatory dependencies are missing";
|
|
|
|
}
|
|
|
|
|
|
|
|
print "Needed package dependencies are met.\n";
|
|
|
|
}
|
|
|
|
|
|
|
|
#
|
|
|
|
# Main
|
|
|
|
#
|
|
|
|
|
|
|
|
while (@ARGV) {
|
|
|
|
my $arg = shift(@ARGV);
|
|
|
|
|
|
|
|
if ($arg eq "--no-virtualenv") {
|
|
|
|
$virtualenv = 0;
|
|
|
|
} elsif ($arg eq "--no-pdf"){
|
|
|
|
$pdf = 0;
|
scripts/sphinx-pre-install: always check if version is compatible with build
Call the script every time a make docs target is selected, on
a simplified check mode.
With this change, the script will set two vars:
$min_version - obtained from `needs_sphinx` var inside
conf.py (currently, '1.3')
$rec_version - obtained from sphinx/requirements.txt.
With those changes, a target like "make htmldocs" will do:
1) If no sphinx-build/sphinx-build3 is found, it will run
the script on normal mode as before, checking for all
system dependencies and providing install hints for the
needed programs and will abort the build;
2) If no sphinx-build/sphinx-build3 is found, but there is
a sphinx_${VER}/bin/activate file, and if
${VER} >= $min_version (string comparation), it will
run in full mode, and will recommend to activate the
virtualenv. If there are multiple virtualenvs, it
will string sort the versions, recommending the
highest version and will abort the build;
3) If Sphinx is detected but has a version lower than
$min_version, it will run in full mode - with will
recommend creating a virtual env using sphinx/requirements.txt,
and will abort the build.
4) If Sphinx is detected and version is lower than
$rec_version, it will run in full mode and will
recommend creating a virtual env using sphinx/requirements.txt.
In this case, it **won't** abort the build.
5) If Sphinx is detected and version is equal or righer than
$rec_version it will return just after detecting the
version ("quick mode"), not checking if are there any
missing dependencies.
Just like before, if one wants to install Sphinx from the
distro, it has to call the script manually and use `--no-virtualenv`
argument to get the hints for his OS:
You should run:
sudo dnf install -y python3-sphinx python3-sphinx_rtd_theme
While here, add a small help for the three optional arguments
for the script.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-05-29 17:09:26 -06:00
|
|
|
} elsif ($arg eq "--version-check"){
|
|
|
|
$version_check = 1;
|
2017-07-17 15:46:36 -06:00
|
|
|
} else {
|
scripts/sphinx-pre-install: always check if version is compatible with build
Call the script every time a make docs target is selected, on
a simplified check mode.
With this change, the script will set two vars:
$min_version - obtained from `needs_sphinx` var inside
conf.py (currently, '1.3')
$rec_version - obtained from sphinx/requirements.txt.
With those changes, a target like "make htmldocs" will do:
1) If no sphinx-build/sphinx-build3 is found, it will run
the script on normal mode as before, checking for all
system dependencies and providing install hints for the
needed programs and will abort the build;
2) If no sphinx-build/sphinx-build3 is found, but there is
a sphinx_${VER}/bin/activate file, and if
${VER} >= $min_version (string comparation), it will
run in full mode, and will recommend to activate the
virtualenv. If there are multiple virtualenvs, it
will string sort the versions, recommending the
highest version and will abort the build;
3) If Sphinx is detected but has a version lower than
$min_version, it will run in full mode - with will
recommend creating a virtual env using sphinx/requirements.txt,
and will abort the build.
4) If Sphinx is detected and version is lower than
$rec_version, it will run in full mode and will
recommend creating a virtual env using sphinx/requirements.txt.
In this case, it **won't** abort the build.
5) If Sphinx is detected and version is equal or righer than
$rec_version it will return just after detecting the
version ("quick mode"), not checking if are there any
missing dependencies.
Just like before, if one wants to install Sphinx from the
distro, it has to call the script manually and use `--no-virtualenv`
argument to get the hints for his OS:
You should run:
sudo dnf install -y python3-sphinx python3-sphinx_rtd_theme
While here, add a small help for the three optional arguments
for the script.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-05-29 17:09:26 -06:00
|
|
|
print "Usage:\n\t$0 <--no-virtualenv> <--no-pdf> <--version-check>\n\n";
|
|
|
|
print "Where:\n";
|
|
|
|
print "\t--no-virtualenv\t- Recommend installing Sphinx instead of using a virtualenv\n";
|
|
|
|
print "\t--version-check\t- if version is compatible, don't check for missing dependencies\n";
|
|
|
|
print "\t--no-pdf\t- don't check for dependencies required to build PDF docs\n\n";
|
2017-07-17 15:46:36 -06:00
|
|
|
exit -1;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
#
|
|
|
|
# Determine the system type. There's no standard unique way that would
|
|
|
|
# work with all distros with a minimal package install. So, several
|
|
|
|
# methods are used here.
|
|
|
|
#
|
|
|
|
# By default, it will use lsb_release function. If not available, it will
|
|
|
|
# fail back to reading the known different places where the distro name
|
|
|
|
# is stored
|
|
|
|
#
|
|
|
|
|
|
|
|
$system_release = qx(lsb_release -d) if which("lsb_release");
|
|
|
|
$system_release =~ s/Description:\s*// if ($system_release);
|
|
|
|
$system_release = catcheck("/etc/system-release") if !$system_release;
|
|
|
|
$system_release = catcheck("/etc/redhat-release") if !$system_release;
|
|
|
|
$system_release = catcheck("/etc/lsb-release") if !$system_release;
|
|
|
|
$system_release = catcheck("/etc/gentoo-release") if !$system_release;
|
2020-04-14 10:56:08 -06:00
|
|
|
|
|
|
|
# This seems more common than LSB these days
|
|
|
|
if (!$system_release) {
|
|
|
|
my %os_var;
|
|
|
|
if (open IN, "cat /etc/os-release|") {
|
|
|
|
while (<IN>) {
|
|
|
|
if (m/^([\w\d\_]+)=\"?([^\"]*)\"?\n/) {
|
|
|
|
$os_var{$1}=$2;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
$system_release = $os_var{"NAME"};
|
|
|
|
if (defined($os_var{"VERSION_ID"})) {
|
|
|
|
$system_release .= " " . $os_var{"VERSION_ID"} if (defined($os_var{"VERSION_ID"}));
|
|
|
|
} else {
|
|
|
|
$system_release .= " " . $os_var{"VERSION"};
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2017-07-17 15:46:36 -06:00
|
|
|
$system_release = catcheck("/etc/issue") if !$system_release;
|
|
|
|
$system_release =~ s/\s+$//;
|
|
|
|
|
|
|
|
check_needs;
|