BUILD: Add build flags to download the manual from RTD

This commit is contained in:
mataniko 2021-04-01 19:36:19 -04:00 committed by Eugene Sandulenko
parent 3e9f802a93
commit f21fdee404
3 changed files with 65 additions and 21 deletions

1
.gitignore vendored
View File

@ -58,6 +58,7 @@ lib*.a
/doc/de/NEUES
/doc/de/NEUES.html
/doc/docportal/_build
/ScummVM Manual*.pdf
/build*
/staging

View File

@ -116,6 +116,7 @@ QUIET_PLUGIN = @echo ' ' PLUGIN ' ' $@;
QUIET_LINK = @echo ' ' LINK ' ' $@;
QUIET_DWP = @echo ' ' DWP ' ' $@;
QUIET_WINDRES = @echo ' ' WINDRES '' $@;
QUIET_CURL = @echo ' ' CURL ' ' $@;
QUIET = @
endif
endif
@ -130,8 +131,15 @@ $(EXECUTABLE).dwp: $(EXECUTABLE)
$(QUIET_DWP)$(DWP) -e $(EXECUTABLE)
endif
# Grab the ScummVM Manual from Read the Docs
manual:
ifdef USE_CURL
$(QUIET_CURL)$(CURL) -s https://docs.scummvm.org/_/downloads/en/$(MANUALVERSION)/pdf/ --output "ScummVM Manual ($(MANUALVERSION)).pdf"
DIST_FILES_MANUAL := "ScummVM Manual ($(MANUALVERSION)).pdf"
endif
distclean: clean clean-devtools
$(RM) config.h config.mk config.log configure.stamp engines/engines.mk engines/detection_table.h engines/plugins_table.h
$(RM) config.h config.mk config.log configure.stamp engines/engines.mk engines/detection_table.h engines/plugins_table.h "ScummVM Manual"*.pdf
clean: clean-toplevel
clean-toplevel:
@ -293,6 +301,10 @@ DISTVERSION = git$(VER_REV)
endif
else
DISTVERSION = $(VERSION)
# Set the manual version to the release tag, unless a manual value was provided
ifeq ($(MANUALVERSION),latest)
MANUALVERSION = v$(VERSION)
endif
endif
DISTNAME := scummvm-$(DISTVERSION)
@ -343,6 +355,9 @@ DIST_FILES_DOCS:=$(addprefix $(srcdir)/,AUTHORS COPYING COPYING.BSD COPYING.LGPL
ifdef USE_PANDOC
DIST_FILES_DOCS+=README$(PANDOCEXT) NEWS$(PANDOCEXT) CONTRIBUTING$(PANDOCEXT)
endif
ifdef DIST_FILES_MANUAL
DIST_FILES_DOCS+=$(DIST_FILES_MANUAL)
endif
DIST_FILES_DOCS_languages=cz da de es fr it no-nb se
DIST_FILES_DOCS_cz:=$(addprefix $(srcdir)/doc/cz/,PrectiMe)
@ -480,4 +495,4 @@ DIST_FILES_SHADERS+=$(wildcard $(srcdir)/engines/wintermute/base/gfx/opengl/shad
endif
endif
.PHONY: all clean distclean plugins dist-src clean-toplevel
.PHONY: all clean distclean plugins dist-src clean-toplevel manual

66
configure vendored
View File

@ -199,6 +199,7 @@ _no_pragma_pack=no
_bink=yes
_cloud=auto
_pandoc=no
_curl=yes
_lld=no
_gold=yes
# Default vkeybd/eventrec options
@ -249,10 +250,9 @@ _nasmpath="$PATH"
NASMFLAGS=""
NASM=""
_tainted_build=no
PANDOC=""
_pandocpath="$PATH"
_pandocformat="default"
_pandocext="default"
_manualversion="latest"
# Detection features to be linked into executable or not
_detection_features_static=yes
_detection_features_full=yes
@ -912,6 +912,10 @@ Optional Features:
--enable-windows-unicode use Windows Unicode APIs (default)
--disable-windows-unicode use Windows ANSI APIs
Optional Documentation Options:
--with-manual-version=VERSION version to use when generating the manuak (optional)
--with-pandoc-format=FORMAT pandoc format to use during the conversion (optional)
Optional Libraries:
--with-alsa-prefix=DIR prefix where alsa is installed (optional)
--disable-alsa disable ALSA midi sound support [autodetect]
@ -998,8 +1002,6 @@ Optional Libraries:
--with-nasm-prefix=DIR prefix where nasm executable is installed (optional)
--disable-nasm disable assembly language optimizations [autodetect]
--with-pandoc-format=FORMAT pandoc format to use during the conversion (optional)
--with-readline-prefix=DIR prefix where readline is installed (optional)
--disable-readline disable readline support in text console [autodetect]
@ -1414,6 +1416,10 @@ for ac_option in $@; do
_pandocformat="$arg"
_pandoc=yes
;;
--with-manual-version=*)
arg=`echo $ac_option | cut -d '=' -f 2`
_manualversion="$arg"
;;
--with-staticlib-prefix=*)
_staticlibpath=`echo $ac_option | cut -d '=' -f 2`
;;
@ -1988,6 +1994,26 @@ EOF
fi
}
# Check for an executable in PATH. Takes the name of the EXE and sets
# two variables with whether the exe exists and the path.
# For example "test_exe_in_path curl" will set _curlpath and _curl
test_exe_in_path() {
IFS="${IFS= }"; ac_save_ifs="$IFS"; IFS=$SEPARATOR
for path_dir in $PATH; do
if test -x "$path_dir/$1$NATIVEEXEEXT" ; then
eval "_${1}path"="$path_dir/$1$NATIVEEXEEXT"
break
fi
done
IFS="$ac_save_ifs"
if ! test "_${1}path" ; then
eval "_${1}=no"
else
eval "_${1}=yes"
fi
}
# Prepare a list of candidates for the C++ compiler
if test -n "$CXX" && test_compiler "$CXX"; then
# Use the compiler specified in CXX
@ -5660,26 +5686,26 @@ define_in_config_if_yes $_nasm 'USE_NASM'
if test "$_pandoc" = yes ; then
echocheck "pandoc"
IFS="${IFS= }"; ac_save_ifs="$IFS"; IFS=$SEPARATOR
for path_dir in $_pandocpath; do
if test -x "$path_dir/pandoc$NATIVEEXEEXT" ; then
PANDOC="$path_dir/pandoc$NATIVEEXEEXT"
break
fi
done
IFS="$ac_save_ifs"
if ! test "$PANDOC" ; then
_pandoc=no
fi
test_exe_in_path pandoc
echo $_pandoc
fi
define_in_config_if_yes $_pandoc 'USE_PANDOC'
#
# Check for curl
#
if test "$_curl" = yes ; then
echocheck "curl"
test_exe_in_path curl
echo $_curl
fi
define_in_config_if_yes $_curl 'USE_CURL'
#
# Check for FriBidi
#
@ -6247,9 +6273,11 @@ EXEPRE := $HOSTEXEPRE
EXEEXT := $HOSTEXEEXT
NASM := $NASM
NASMFLAGS := $NASMFLAGS
PANDOC := $PANDOC
PANDOC := $_pandocpath
CURL := $_curlpath
PANDOCFORMAT := $_pandocformat
PANDOCEXT := $_pandocext
MANUALVERSION := $_manualversion
ZLIB_LIBS := $ZLIB_LIBS
ZLIB_CFLAGS := $ZLIB_CFLAGS