From 17b3eb6967b944e8e500190d57c79978c1f9fd57 Mon Sep 17 00:00:00 2001
From: drebs <drebs@leap.se>
Date: Mon, 6 Jun 2016 21:21:04 -0300
Subject: [doc] improve docker script docs

---
 scripts/docker/files/setup-env.sh         | 11 +++++++++++
 scripts/docker/files/start-client-test.sh |  5 ++++-
 scripts/docker/files/start-trial-test.sh  |  6 +++++-
 3 files changed, 20 insertions(+), 2 deletions(-)

diff --git a/scripts/docker/files/setup-env.sh b/scripts/docker/files/setup-env.sh
index 1df1c825..d5aeab7d 100755
--- a/scripts/docker/files/setup-env.sh
+++ b/scripts/docker/files/setup-env.sh
@@ -3,6 +3,17 @@
 # Clone soledad repository and install soledad dependencies needed to run
 # client and server in a test environment.
 #
+# In details, this script does the following:
+#
+#   - clone a series of python package repositories into /var/local/soledad.
+#   - install dependencies for those packages from the requirements files in
+#     each of the repositories, using python wheels when possible.
+#   - install the python packages in development mode
+#
+# The cloned git repositories might have a remote configured and a branch
+# checked out on runtime, before a server, client or test instance is actually
+# run. Check the other scripts in this directory.
+#
 # This script is meant to be copied to the docker container and run after
 # system dependencies have been installed.
 
diff --git a/scripts/docker/files/start-client-test.sh b/scripts/docker/files/start-client-test.sh
index 1275b50d..5997385f 100755
--- a/scripts/docker/files/start-client-test.sh
+++ b/scripts/docker/files/start-client-test.sh
@@ -1,6 +1,9 @@
 #!/bin/bash
 
-# Run Soledad tests.
+# Run a Soledad client connection test.
+#
+# This script is meant to be copied to the docker container and run upon
+# container start.
 
 CMD="/usr/local/soledad/test-env.py"
 REPO="/var/local/soledad"
diff --git a/scripts/docker/files/start-trial-test.sh b/scripts/docker/files/start-trial-test.sh
index 98b09e53..15638b65 100755
--- a/scripts/docker/files/start-trial-test.sh
+++ b/scripts/docker/files/start-trial-test.sh
@@ -1,6 +1,9 @@
 #!/bin/bash
 
-# Run Soledad tests.
+# Run Soledad trial tests.
+#
+# This script is meant to be copied to the docker container and run upon
+# container start.
 
 CMD="/usr/local/soledad/test-env.py"
 REPO="/var/local/soledad"
@@ -14,6 +17,7 @@ if [ ! -z "${SOLEDAD_BRANCH}" ]; then
   git -C ${REPO} checkout ${SOLEDAD_BRANCH}
 fi
 
+# currently soledad trial tests need a running couch on environment
 ${CMD} couch start
 
 trial leap.soledad.common
-- 
cgit v1.2.3