Skip to contentSkip to conversation

travis-ci: Test installing Sphinx documentation

PATCH In review Philippe Mathieu-Daudé 2 participants 5 messages Mar 8, 2019

lore
Share & tools
lore
#0 lore raw

cover travis-ci: Test installing Sphinx documentation

Hi,

This series improve the Travis CI to test installing the Sphinx generated documentation in in-tree and out-of-tree builds.

It is based on Peter's "Fix various issues with Sphinx build machinery" series:
https://lists.gnu.org/archive/html/qemu-devel/2019-03/msg02625.html

Regards,

Phil.

Based-on: <[email protected]>

Philippe Mathieu-Daudé (3):
.travis.yml: Reduce the out-of-tree target list .travis.yml: Test the documentation installation process .travis.yml: Test installing Sphinx documentation in out-of-tree build

 .travis.yml | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)
Signature · 1 line
2.20.1
#1 lore raw

PATCH 1/3 .travis.yml: Reduce the out-of-tree target list

---
 .travis.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
.travis.yml +1 -1
index e942175dd3..681ed1c216 100644
@@ -127,7 +127,7 @@ matrix:
 
     # Test out-of-tree builds
     - env:
-        - CONFIG="--enable-debug --enable-debug-tcg"
+        - CONFIG="--enable-debug --enable-debug-tcg --target-list=microblaze-softmmu,xtensa-softmmu,cris-linux-user,hppa-linux-user"
         - BUILD_DIR="out-of-tree/build/dir" SRC_DIR="../../.."
 
 
Signature · 1 line
2.20.1
#2 lore raw

PATCH 2/3 .travis.yml: Test the documentation installation process

In reply to Philippe Mathieu-Daudé

We invert the BASE_CONFIG arguments order to match the BASE_CONFIG at top of this file, this way it is easier to find this job in Travis Job View.

---
 .travis.yml | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
.travis.yml +4 -3
index 681ed1c216..df6700d93a 100644
@@ -114,10 +114,11 @@ matrix:
         - TEST_CMD="make check-unit -j3 V=1"
 
 
-    # Check we can build docs and tools
+    # Check we can build docs and tools (in-tree) and install them
     - env:
-        - BASE_CONFIG="--enable-tools --enable-docs"
-        - CONFIG="--target-list=x86_64-softmmu,aarch64-linux-user"
+        - BASE_CONFIG="--enable-docs --enable-tools"
+        - CONFIG="--prefix=$PWD/prefix --target-list=x86_64-softmmu,aarch64-linux-user"
+        - TEST_CMD="make check install -j3"
       addons:
         apt:
           packages:
Signature · 1 line
2.20.1
#3 lore raw

PATCH 3/3 .travis.yml: Test installing Sphinx documentation in out-of-tree build

In reply to Philippe Mathieu-Daudé
---
 .travis.yml | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
.travis.yml +11 -2
index df6700d93a..2c6b6c05b0 100644
@@ -126,10 +126,19 @@ matrix:
             - texinfo
             - perl
 
-    # Test out-of-tree builds
+
+    # Test out-of-tree builds (and install)
     - env:
-        - CONFIG="--enable-debug --enable-debug-tcg --target-list=microblaze-softmmu,xtensa-softmmu,cris-linux-user,hppa-linux-user"
+        - BASE_CONFIG="--enable-docs --disable-tools"
+        - CONFIG="--prefix=$PWD/prefix --enable-debug --enable-debug-tcg --target-list=microblaze-softmmu,xtensa-softmmu,cris-linux-user,hppa-linux-user"
         - BUILD_DIR="out-of-tree/build/dir" SRC_DIR="../../.."
+        - TEST_CMD="make check install -j3"
+      addons:
+        apt:
+          packages:
+            - python-sphinx
+            - texinfo
+            - perl
 
 
     # Test with Clang for compile portability (Travis uses clang-5.0)
Signature · 1 line
2.20.1
#4 lore raw
In reply to Philippe Mathieu-Daudé
Quoted 8 lines · Philippe Mathieu-Daudé

Hi,

This series improve the Travis CI to test installing the Sphinx generated documentation in in-tree and out-of-tree builds.

It is based on Peter's "Fix various issues with Sphinx build machinery" series:
https://lists.gnu.org/archive/html/qemu-devel/2019-03/msg02625.html

Hmm I'd just combined the docs and out of tree build:

https://github.com/stsquad/qemu/commit/c4d5ae98005bc8a3cd0224321d3d5938650c3ef6

Quoted 7 lines

Regards,

Phil.

Based-on: <[email protected]>

Quoted 7 lines

Philippe Mathieu-Daudé (3):
.travis.yml: Reduce the out-of-tree target list .travis.yml: Test the documentation installation process .travis.yml: Test installing Sphinx documentation in out-of-tree build

 .travis.yml | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

--
Alex Bennée