From 987b281e597f615f07d7ac70f2a57cc42e36454f Mon Sep 17 00:00:00 2001
From: Siri Hansen <siri@erlang.org>
Date: Wed, 12 Dec 2012 12:31:12 +0100
Subject: [common_test] Add documentation of new url_base option to
 cth_surefire

---
 lib/common_test/doc/src/ct_hooks_chapter.xml | 24 +++++++++++++++++++-----
 1 file changed, 19 insertions(+), 5 deletions(-)

(limited to 'lib/common_test')

diff --git a/lib/common_test/doc/src/ct_hooks_chapter.xml b/lib/common_test/doc/src/ct_hooks_chapter.xml
index 86237f5fc1..27d56fd47d 100644
--- a/lib/common_test/doc/src/ct_hooks_chapter.xml
+++ b/lib/common_test/doc/src/ct_hooks_chapter.xml
@@ -457,12 +457,26 @@ terminate(State) ->
       <row>
 	<cell>cth_surefire</cell>
 	<cell>no</cell>
-	<cell>Captures all test results and outputs them as surefire XML into
-	a file. The file which is created is by default called junit_report.xml.
-	The name can be by setting the path option for this hook. e.g.
+	<cell><p>Captures all test results and outputs them as surefire
+	XML into a file. The file which is created is by default
+	called junit_report.xml. The file name can be changed by
+	setting the <c>path</c> option for this hook, e.g.</p>
+
 	<code>-ct_hooks cth_surefire [{path,"/tmp/report.xml"}]</code>
-	Surefire XML can forinstance be used by Jenkins to display test
-	results.</cell>
+
+	<p>If the <c>url_base</c> option is set, an additional
+	attribute named <c>url</c> will be added to each
+	<c>testsuite</c> and <c>testcase</c> XML element. The value will
+	be a constructed from the <c>url_base</c> and a relative path
+	to the test suite or test case log respectively, e.g.</p>
+
+	<code>-ct_hooks cth_surefire [{url_base,"http://myserver.com/"}]</code>
+	<p>will give a url attribute value similar to</p>
+
+	<code>"http://myserver.com/ct_run.ct@myhost.2012-12-12_11.19.39/x86_64-unknown-linux-gnu.my_test.logs/run.2012-12-12_11.19.39/suite.log.html"</code>
+
+	<p>Surefire XML can for instance be used by Jenkins to display test
+	results.</p></cell>
       </row>
     </table>
 
-- 
cgit v1.2.3