Prepare release

1 files changed, 157 insertions, 0 deletions

diff --git a/lib/common_test/doc/src/notes.xml b/lib/common_test/doc/src/notes.xml
index af96ef621f..da0b6b2d65 100644
--- a/lib/common_test/doc/src/notes.xml
+++ b/lib/common_test/doc/src/notes.xml
@@ -32,6 +32,163 @@
     <file>notes.xml</file>
     </header>
 
+<section><title>Common_Test 1.6</title>
+
+    <section><title>Improvements and New Features</title>
+      <list>
+        <item>
+          <p>
+	    A Getting Started chapter has been added to the Common
+	    Test User's Guide.</p>
+          <p>
+	    Own Id: OTP-9156</p>
+        </item>
+        <item>
+          <p>
+	    The test case group info function has been implemented in
+	    Common Test. Before execution of a test case group, a
+	    call is now made to <c>TestSuite:group(GroupName)</c>.
+	    The function returns a list of test properties, e.g. to
+	    specify timetrap values, require configuration data, etc
+	    (analogue to the test suite- and test case info
+	    function). The scope of the properties set by
+	    <c>group(GroupName)</c> is all test cases and sub-groups
+	    of group <c>GroupName</c>.</p>
+          <p>
+	    Own Id: OTP-9235</p>
+        </item>
+        <item>
+          <p>
+	    Common Test hooks are now in a final supported version.
+	    The Common Test hooks allow you to abstract out
+	    initialization behaviour that is common to multiple test
+	    suites into one place and also extend the behaviour of a
+	    suite without changing the suite itself. For more
+	    information see the Common Test user's guide.</p>
+          <p>
+	    Own Id: OTP-9449</p>
+        </item>
+        <item>
+          <p>
+	    A new built-in common test hook has been added which
+	    captures error_logger and SASL event and prints them in
+	    the testcase log. To disable this (and any other built-in
+	    hooks) pass 'enable_builtin_hooks false' to common test.</p>
+          <p>
+	    Own Id: OTP-9543</p>
+        </item>
+        <item>
+          <p>
+	    Common Test now calls info functions also for the
+	    <c>init/end_per_suite/1</c> and
+	    <c>init/end_per_group/2</c> configuration functions.
+	    These can be used e.g. to set timetraps and require
+	    external configuration data relevant only for the
+	    configuration functions in question (without affecting
+	    properties set for groups and test cases in the suite).
+	    The info function for <c>init/end_per_suite(Config)</c>
+	    is <c>init/end_per_suite()</c>, and for
+	    <c>init/end_per_group(GroupName,Config)</c> it's
+	    <c>init/end_per_group(GroupName)</c>. Info functions can
+	    not be used with <c>init/end_per_testcase(TestCase,
+	    Config)</c>, since these configuration functions execute
+	    on the test case process and will use the same properties
+	    as the test case (i.e. properties set by the test case
+	    info function, <c>TestCase()</c>).</p>
+          <p>
+	    Own Id: OTP-9569</p>
+        </item>
+        <item>
+          <p>
+	    It's now possible to read the full name of the test case
+	    log file during execution. One way to do this is to
+	    lookup it up as value of the key <c>tc_logfile</c> in the
+	    test case <c>Config</c> list (which means it can also be
+	    read by a pre- or post Common Test hook function). The
+	    data is also sent with the event
+	    <c>#event{name=tc_logfile,data={{Suite,Func},LogFileName}}</c>,
+	    and can be read by any installed event handler.</p>
+          <p>
+	    Own Id: OTP-9676 Aux Id: seq11941 </p>
+        </item>
+        <item>
+          <p>
+	    The look of the HTML log files generated by Common Test
+	    and Test Server has been improved (and made easier to
+	    customize) by means of a CSS file.</p>
+          <p>
+	    Own Id: OTP-9706</p>
+        </item>
+        <item>
+          <p>
+	    Functions ct:fail(Format, Args) and ct:comment(Format,
+	    Args) have been added in order to make printouts of
+	    formatted error and comment strings easier (no need for
+	    the user to call io_lib:format/2 explicitly).</p>
+          <p>
+	    Own Id: OTP-9709 Aux Id: seq11951 </p>
+        </item>
+        <item>
+          <p>
+	    The order in which ct hooks are executed for cleanup
+	    hooks (i.e. *_end_per_* hooks) has been reversed.</p>
+          <p>
+	    *** POTENTIAL INCOMPATIBILITY ***</p>
+          <p>
+	    Own Id: OTP-9774 Aux Id: seq11913 </p>
+        </item>
+        <item>
+          <p>
+	    Printouts to stdout may be captured during test case
+	    execution. This is useful in order to e.g. read and parse
+	    tty printouts from the SUT during test case execution (if
+	    necessary, say, to determine the outcome of the test).
+	    The capturing session is started with
+	    <c>ct:capture_start/0</c>, and stopped with
+	    <c>ct:capture_stop/0</c>. The list of buffered strings is
+	    read and purged with <c>ct:capture_get/0/1</c>. It's
+	    possible to filter out printouts made with
+	    <c>ct:log/2/3</c> and <c>ct:pal/2/3</c> from the captured
+	    list of strings. This is done by calling
+	    <c>capture_get/1</c> with a list of log categories to
+	    exclude.</p>
+          <p>
+	    Own Id: OTP-9775</p>
+        </item>
+        <item>
+          <p>
+	    The syntax for specifying test case groups in the all/0
+	    list has been extended to include execution properties
+	    for both groups and sub-groups. The properties specified
+	    in all/0 for a group overrides the properties specified
+	    in the group declaration (in groups/0). The main purpose
+	    of this extension is to make it possible to run the same
+	    set of tests, but with different properties, without
+	    having to declare copies of the group in question. Also,
+	    the same syntax may be used in test specifications in
+	    order to change properties of groups at the time of
+	    execution, without having to edit the test suite. Please
+	    see the User's Guide for details and examples.</p>
+          <p>
+	    Own Id: OTP-9809 Aux Id: OTP-9235 </p>
+        </item>
+      </list>
+    </section>
+
+
+    <section><title>Known Bugs and Problems</title>
+      <list>
+        <item>
+          <p>
+	    Fix problems in CT/TS due to line numbers in exceptions.</p>
+          <p>
+	    Own Id: OTP-9203</p>
+        </item>
+      </list>
+    </section>
+
+</section>
+
 <section><title>Common_Test 1.5.5</title>
 
     <section><title>Fixed Bugs and Malfunctions</title>