Improve documentation for run-unit-test-docker.sh
Add a bit more detail to what this script does and which
parameters are required
Change-Id: Iebfb5408ff6da9c826cb5c57735b099ec9d55678
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
diff --git a/run-unit-test-docker.sh b/run-unit-test-docker.sh
index 1c056f3..d2a86f1 100755
--- a/run-unit-test-docker.sh
+++ b/run-unit-test-docker.sh
@@ -2,17 +2,28 @@
# This build script is for running the Jenkins unit test builds using docker.
#
-# UNIT_TEST_PKG = Required, repository which has been extracted and is to
-# be tested.
-# WORKSPACE = Required, location of unit test scripts and repository code to
-# test.
-# DISTRO = Docker base image. Ubuntu and Fedora are supported.
-# dbus_sys_config_file = <path of the dbus config file>
-# BRANCH = <optional, branch to build from each of the openbmc/respositories>
-# default is master, which will be used if input branch not
-# provided or not found
-# DOCKER_IMG_NAME = Default is openbmc/ubuntu-unit-test-master with a
-# -$BRANCH replacing -master if $BRANCH provided
+# This script will build a docker container which will then be used to build
+# and test the input UNIT_TEST_PKG. The docker container will be pre-populated
+# with the most used OpenBMC repositories (phosphor-dbus-interfaces, sdbusplus,
+# phosphor-logging, ...). This allows the use of docker caching
+# capabilities so the dependent repositories are only built once per update
+# to their corresponding repository. If a BRANCH parameter is input then the
+# docker container will be pre-populated with the latest code from that input
+# branch. If the branch does not exist in the repository, then master will be
+# used.
+#
+# UNIT_TEST_PKG: Required, repository which has been extracted and is to
+# be tested
+# WORKSPACE: Required, location of unit test scripts and repository
+# code to test
+# DISTRO: Optional, docker base image (ubuntu or fedora)
+# BRANCH: Optional, branch to build from each of the
+# openbmc repositories. default is master, which will be
+# used if input branch not provided or not found
+# DOCKER_IMG_NAME: Optional, default is openbmc/ubuntu-unit-test-master with a
+# -$BRANCH replacing -master if $BRANCH provided
+# dbus_sys_config_file: Optional, with the default being
+# `/usr/share/dbus-1/system.conf`
# Trace bash processing. Set -e so when a step fails, we fail the build
set -uo pipefail