From af6b07fb6375b1f4cddefcbbcd2ac2cdbe599187 Mon Sep 17 00:00:00 2001
From: Jan Waller <jwa@informatik.uni-kiel.de>
Date: Tue, 29 Jul 2014 15:16:33 +0200
Subject: [PATCH] updated README for CI

---
 continuous-integration/README                 | 23 +++++++++++++++----
 .../executeRemoteMicroBenchmark.sh            |  2 +-
 2 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/continuous-integration/README b/continuous-integration/README
index c8a38b2..b08bbcc 100644
--- a/continuous-integration/README
+++ b/continuous-integration/README
@@ -1,13 +1,26 @@
 MooBench  http://kieker-monitoring.net/MooBench
-
 -----------------------------------------------
 
-This folder contains an example script showing how to include MooBench into continuous integration.
+This folder contains an example script showing how to include 
+MooBench into continuous integration.
+
+The script copies a pre-compiled version of MooBench and the 
+jar file to be benchmarked to a given remote server. It executes 
+MooBench and retrieves the results. These results can be visualized 
+in the web application of the continuous integration server.
 
-The script copies a pre-compiled version of MooBench and the jar file to be benchmarked to a given remote server. It executes MooBench and retrieves the results. These results can, for instance, be visualized in the web application of the continuous integration server.
+We have successfully employed the script on a Jenkins server (v. 1.554)
+with the Plot plugin (v. 1.7). The results are availabe under:
+* http://build.kieker-monitoring.net/job/kieker-nightly-release/plot/
 
 -----------------------------------------------
+The remote server should be provided with Java (>= 1.6) and R (> 3.0).
+We recommend to use SSH keys for the access.
 
-The remote server should be provided with Java (>= 1.6) and R (> 3.0). We recommend to use SSH keys for the access.
+The client server should contain a prepared folder with a pre-compiled 
+version of MooBench, as created by the build script with the appropriate
+build target, e.g., 'build-kieker' for Kieker.
 
-The client server should contain a prepared folder with a pre-compiled version of MooBench, as created by the build script.
\ No newline at end of file
+Refer to the Kieker git (http://git.kieker-monitoring.net/kieker.git)
+in folder '/examples/OverheadEvaluationMicrobenchmark' for a full example 
+of using this script.
diff --git a/continuous-integration/executeRemoteMicroBenchmark.sh b/continuous-integration/executeRemoteMicroBenchmark.sh
index c819b08..5b97466 100644
--- a/continuous-integration/executeRemoteMicroBenchmark.sh
+++ b/continuous-integration/executeRemoteMicroBenchmark.sh
@@ -32,4 +32,4 @@ ssh ${REMOTE_NODE} "cp MooBench/tmp/${RESULTS_FOLDER_NAME}/results.zip old-resul
 ssh ${REMOTE_NODE} "cd old-results; ls -A1t | sed -e '1,100d' | xargs -d '\n' rm; exit"
 ssh ${REMOTE_NODE} 'mv old-results /tmp/; exit'
 ssh ${REMOTE_NODE} 'rm -rf MooBench; exit'
-ssh ${REMOTE_NODE} 'mv /tmp/old-results .; exit'
\ No newline at end of file
+ssh ${REMOTE_NODE} 'mv /tmp/old-results .; exit'
-- 
GitLab