travis-ci: document parameter variables

Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>

Closes: #600
Approved by: cgwalters

2 files changed, 39 insertions, 0 deletions

diff --git a/tests/ci-build.sh b/tests/ci-build.sh
index e4ec703b..4b736a3c 100755
--- a/tests/ci-build.sh
+++ b/tests/ci-build.sh
@@ -26,10 +26,30 @@ set -euo pipefail
 set -x
 
 NULL=
+
+# ci_docker:
+# If non-empty, this is the name of a Docker image. ci-install.sh will
+# fetch it with "docker pull" and use it as a base for a new Docker image
+# named "ci-image" in which we will do our testing.
+#
+# If empty, we test on "bare metal".
+# Typical values: ubuntu:xenial, debian:jessie-slim
 : "${ci_docker:=}"
+
+# ci_parallel:
+# A number of parallel jobs, passed to make -j
 : "${ci_parallel:=1}"
+
+# ci_sudo:
+# If yes, assume we can get root using sudo; if no, only use current user
 : "${ci_sudo:=no}"
+
+# ci_test:
+# If yes, run tests; if no, just build
 : "${ci_test:=yes}"
+
+# ci_test_fatal:
+# If yes, test failures break the build; if no, they are reported but ignored
 : "${ci_test_fatal:=yes}"
 
 if [ -n "$ci_docker" ]; then
diff --git a/tests/ci-install.sh b/tests/ci-install.sh
index 1b52704c..dbc86c69 100755
--- a/tests/ci-install.sh
+++ b/tests/ci-install.sh
@@ -26,9 +26,28 @@ set -euo pipefail
 set -x
 
 NULL=
+
+# ci_distro:
+# OS distribution in which we are testing
+# Typical values: ubuntu, debian; maybe fedora in future
 : "${ci_distro:=debian}"
+
+# ci_docker:
+# If non-empty, this is the name of a Docker image. ci-install.sh will
+# fetch it with "docker pull" and use it as a base for a new Docker image
+# named "ci-image" in which we will do our testing.
 : "${ci_docker:=}"
+
+# ci_in_docker:
+# Used internally by ci-install.sh. If yes, we are inside the Docker image
+# (ci_docker is empty in this case).
 : "${ci_in_docker:=no}"
+
+# ci_suite:
+# OS suite (release, branch) in which we are testing.
+# Typical values for ci_distro=ubuntu: xenial, trusty
+# Typical values for ci_distro=debian: sid, jessie
+# Typical values for ci_distro=fedora might be 25, rawhide
 : "${ci_suite:=jessie}"
 
 if [ $(id -u) = 0 ]; then