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/doc')

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


From 3c05d3389f8b45e5b9f13a874de53ec521981a41 Mon Sep 17 00:00:00 2001
From: Erlang/OTP <otp@erlang.org>
Date: Wed, 12 Dec 2012 17:24:24 +0100
Subject: Prepare release

---
 lib/common_test/doc/src/notes.xml | 50 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

(limited to 'lib/common_test/doc')

diff --git a/lib/common_test/doc/src/notes.xml b/lib/common_test/doc/src/notes.xml
index 7e33b71de1..8c3b13951d 100644
--- a/lib/common_test/doc/src/notes.xml
+++ b/lib/common_test/doc/src/notes.xml
@@ -32,6 +32,56 @@
     <file>notes.xml</file>
     </header>
 
+<section><title>Common_Test 1.6.3.1</title>
+
+    <section><title>Known Bugs and Problems</title>
+      <list>
+        <item>
+          <p>
+	    The following corrections/changes are done in the
+	    cth_surefire hook:</p>
+          <p>
+	    <list> <item> Earlier there would always be a
+	    'properties' element under the 'testsuites' element. This
+	    would exist even if there were no 'property' element
+	    inside it. This has been changed so if there are no
+	    'property' elements to display, then there will not be a
+	    'properties' element either. </item> <item> The XML file
+	    will now (unless other is specified) be stored in the top
+	    log directory. Earlier, the default directory would be
+	    the current working directory for the erlang node, which
+	    would mostly, but not always, be the top log directory.
+	    </item> <item> The 'hostname' attribute in the
+	    'testsuite' element would earlier never have the correct
+	    value. This has been corrected. </item> <item> The
+	    'errors' attribute in the 'testsuite' element would
+	    earlier display the number of failed testcases. This has
+	    been changed and will now always have the value 0, while
+	    the 'failures' attribute will show the number of failed
+	    testcases. </item> <item> A new attribute 'skipped' is
+	    added to the 'testsuite' element. This will display the
+	    number of skipped testcases. These would earlier be
+	    included in the number of failed test cases. </item>
+	    <item> The total number of tests displayed by the 'tests'
+	    attribute in the 'testsuite' element would earlier
+	    include init/end_per_suite and init/end_per_group. This
+	    is no longer the case. The 'tests' attribute will now
+	    only count "real" test cases. </item> <item> Earlier,
+	    auto skipped test cases would have no value in the 'log'
+	    attribute. This is now corrected. </item> <item> A new
+	    attributes 'log' is added to the 'testsuite' element.
+	    </item> <item> A new option named 'url_base' is added for
+	    this hook. If this option is used, a new attribute named
+	    'url' will be added to the 'testcase' and 'testsuite'
+	    elements. </item> </list></p>
+          <p>
+	    Own Id: OTP-10589</p>
+        </item>
+      </list>
+    </section>
+
+</section>
+
 <section><title>Common_Test 1.6.3</title>
 
     <section><title>Fixed Bugs and Malfunctions</title>
-- 
cgit v1.2.3