[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 02/18] configure: Allow user to specify sphinx-build binary
From: |
Markus Armbruster |
Subject: |
[PULL 02/18] configure: Allow user to specify sphinx-build binary |
Date: |
Sat, 15 Feb 2020 12:41:17 +0100 |
From: Peter Maydell <address@hidden>
Currently we insist on using 'sphinx-build' from the $PATH;
allow the user to specify the binary to use. This will be
more useful as we become pickier about the capabilities
we require (eg needing a Python 3 sphinx-build).
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Reviewed-by: Wainer dos Santos Moschetta <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Markus Armbruster <address@hidden>
---
configure | 10 +++++++++-
Makefile | 2 +-
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/configure b/configure
index 16f94cd96b..14172909f0 100755
--- a/configure
+++ b/configure
@@ -584,6 +584,7 @@ query_pkg_config() {
}
pkg_config=query_pkg_config
sdl2_config="${SDL2_CONFIG-${cross_prefix}sdl2-config}"
+sphinx_build=sphinx-build
# If the user hasn't specified ARFLAGS, default to 'rv', just as make does.
ARFLAGS="${ARFLAGS-rv}"
@@ -975,6 +976,8 @@ for opt do
;;
--python=*) python="$optarg"
;;
+ --sphinx-build=*) sphinx_build="$optarg"
+ ;;
--gcov=*) gcov_tool="$optarg"
;;
--smbd=*) smbd="$optarg"
@@ -1677,6 +1680,7 @@ Advanced options (experts only):
--make=MAKE use specified make [$make]
--install=INSTALL use specified install [$install]
--python=PYTHON use specified python [$python]
+ --sphinx-build=SPHINX use specified sphinx-build [$sphinx_build]
--smbd=SMBD use specified smbd [$smbd]
--with-git=GIT use specified git [$git]
--static enable static build [$static]
@@ -4799,7 +4803,7 @@ has_sphinx_build() {
# sphinx-build doesn't exist at all or if it is too old.
mkdir -p "$TMPDIR1/sphinx"
touch "$TMPDIR1/sphinx/index.rst"
- sphinx-build -c "$source_path/docs" -b html "$TMPDIR1/sphinx"
"$TMPDIR1/sphinx/out" >/dev/null 2>&1
+ $sphinx_build -c "$source_path/docs" -b html "$TMPDIR1/sphinx"
"$TMPDIR1/sphinx/out" >/dev/null 2>&1
}
# Check if tools are available to build documentation.
@@ -6474,6 +6478,9 @@ echo "QEMU_LDFLAGS $QEMU_LDFLAGS"
echo "make $make"
echo "install $install"
echo "python $python ($python_version)"
+if test "$docs" != "no"; then
+ echo "sphinx-build $sphinx_build"
+fi
echo "slirp support $slirp $(echo_version $slirp $slirp_version)"
if test "$slirp" != "no" ; then
echo "smbd $smbd"
@@ -7506,6 +7513,7 @@ echo "INSTALL_DATA=$install -c -m 0644" >>
$config_host_mak
echo "INSTALL_PROG=$install -c -m 0755" >> $config_host_mak
echo "INSTALL_LIB=$install -c -m 0644" >> $config_host_mak
echo "PYTHON=$python" >> $config_host_mak
+echo "SPHINX_BUILD=$sphinx_build" >> $config_host_mak
echo "CC=$cc" >> $config_host_mak
if $iasl -h > /dev/null 2>&1; then
echo "IASL=$iasl" >> $config_host_mak
diff --git a/Makefile b/Makefile
index f0e1a2fc1d..430bbad055 100644
--- a/Makefile
+++ b/Makefile
@@ -1030,7 +1030,7 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
# Note the use of different doctree for each (manual, builder) tuple;
# this works around Sphinx not handling parallel invocation on
# a single doctree: https://github.com/sphinx-doc/sphinx/issues/2946
-build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" sphinx-build
$(if $(V),,-q) -W -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)" -d
.doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1
,"SPHINX","$(MANUAL_BUILDDIR)/$1")
+build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" $(SPHINX_BUILD)
$(if $(V),,-q) -W -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)" -d
.doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1
,"SPHINX","$(MANUAL_BUILDDIR)/$1")
# We assume all RST files in the manual's directory are used in it
manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst) \
$(wildcard $(SRC_PATH)/docs/$1/*.rst.inc) \
--
2.21.1
- [PULL 00/18] QAPI patches for 2020-02-15, Markus Armbruster, 2020/02/15
- [PULL 01/18] qapi: Expand documentation for LostTickPolicy, Markus Armbruster, 2020/02/15
- [PULL 06/18] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment, Markus Armbruster, 2020/02/15
- [PULL 07/18] qga/qapi-schema.json: Fix indent level on doc comments, Markus Armbruster, 2020/02/15
- [PULL 05/18] Makefile: Fix typo in dependency list for interop manpages, Markus Armbruster, 2020/02/15
- [PULL 13/18] qapi/ui.json: Put input-send-event body text in the right place, Markus Armbruster, 2020/02/15
- [PULL 03/18] configure: Pick sphinx-build-3 when available, Markus Armbruster, 2020/02/15
- [PULL 18/18] qapi: Delete all the "foo: dropped in n.n" notes, Markus Armbruster, 2020/02/15
- [PULL 10/18] qapi: Fix incorrect "Not documented" claims in QMP documentation, Markus Armbruster, 2020/02/15
- [PULL 14/18] qapi/ui.json: Avoid `...' Texinfo style quoting, Markus Armbruster, 2020/02/15
- [PULL 02/18] configure: Allow user to specify sphinx-build binary,
Markus Armbruster <=
- [PULL 16/18] qapi: Add blank lines before bulleted lists, Markus Armbruster, 2020/02/15
- [PULL 09/18] qapi/block-core.json: Use literal block for ascii art, Markus Armbruster, 2020/02/15
- [PULL 08/18] qga/qapi-schema.json: minor format fixups for rST, Markus Armbruster, 2020/02/15
- [PULL 15/18] qapi: Use explicit bulleted lists, Markus Armbruster, 2020/02/15
- [PULL 17/18] qapi/migration.json: Replace _this_ with *this*, Markus Armbruster, 2020/02/15
- [PULL 12/18] qapi: Remove hardcoded tabs, Markus Armbruster, 2020/02/15
- [PULL 04/18] configure: Check that sphinx-build is using Python 3, Markus Armbruster, 2020/02/15
- [PULL 11/18] qapi: Fix indent level on doc comments in json files, Markus Armbruster, 2020/02/15
- Re: [PULL 00/18] QAPI patches for 2020-02-15, Peter Maydell, 2020/02/17