From 5aa950086a5fa036f27e670517a5c743e0610128 Mon Sep 17 00:00:00 2001
From: Erlang/OTP <otp@erlang.org>
Date: Mon, 6 May 2019 17:09:17 +0200
Subject: Prepare release

---
 lib/common_test/doc/src/ct_hooks.xml |  4 +--
 lib/common_test/doc/src/notes.xml    | 60 ++++++++++++++++++++++++++++++++++++
 2 files changed, 62 insertions(+), 2 deletions(-)

(limited to 'lib/common_test/doc')

diff --git a/lib/common_test/doc/src/ct_hooks.xml b/lib/common_test/doc/src/ct_hooks.xml
index b9bc54ff63..7664dcc9d1 100644
--- a/lib/common_test/doc/src/ct_hooks.xml
+++ b/lib/common_test/doc/src/ct_hooks.xml
@@ -109,7 +109,7 @@
     </func>
 
     <func>
-      <name since="OTP @OTP-14746@">Module:post_groups(SuiteName, GroupDefs) -&gt; NewGroupDefs</name>
+      <name since="OTP 21.3.8">Module:post_groups(SuiteName, GroupDefs) -&gt; NewGroupDefs</name>
       <fsummary>Called after groups/0.</fsummary>
       <type>
         <v>SuiteName = atom()</v>
@@ -165,7 +165,7 @@
     </func>
 
     <func>
-      <name since="OTP @OTP-14746@">Module:post_all(SuiteName, Return, GroupDefs) -&gt; NewReturn</name>
+      <name since="OTP 21.3.8">Module:post_all(SuiteName, Return, GroupDefs) -&gt; NewReturn</name>
       <fsummary>Called after all/0.</fsummary>
       <type>
         <v>SuiteName = atom()</v>
diff --git a/lib/common_test/doc/src/notes.xml b/lib/common_test/doc/src/notes.xml
index 018bb910a1..9c74146d73 100644
--- a/lib/common_test/doc/src/notes.xml
+++ b/lib/common_test/doc/src/notes.xml
@@ -33,6 +33,66 @@
     <file>notes.xml</file>
     </header>
 
+<section><title>Common_Test 1.17.2</title>
+
+    <section><title>Fixed Bugs and Malfunctions</title>
+      <list>
+        <item>
+          <p>
+	    The test result when a hook function fails is in general
+	    the same as if the function that the hook is associated
+	    with fails. For example, if <c>post_init_per_testcase</c>
+	    fails the result is that the test case is skipped, as is
+	    the case when <c>init_per_testcase</c> fails.This,
+	    however, was earlier not true for timetrap timeouts or
+	    other error situations where the process running the hook
+	    function was killed. This is now corrected, so the error
+	    handling should be the same no matter how the hook
+	    function fails.</p>
+          <p>
+	    *** POTENTIAL INCOMPATIBILITY ***</p>
+          <p>
+	    Own Id: OTP-15717 Aux Id: ERIERL-334 </p>
+        </item>
+        <item>
+          <p>
+	    In some rare cases, when two common_test nodes used the
+	    same log directory, a timing problem could occur which
+	    caused common_test to crash because it's log cache file
+	    was unexpectedly empty. This is now corrected.</p>
+          <p>
+	    Own Id: OTP-15758 Aux Id: ERIERL-342 </p>
+        </item>
+      </list>
+    </section>
+
+
+    <section><title>Improvements and New Features</title>
+      <list>
+        <item>
+          <p>
+	    Two new common_test hook functions are introduced:</p>
+          <p>
+	    <c>post_groups/2</c>, which is called after
+	    <c>Suite:groups/0</c><br/> <c>post_all/3</c>, which is
+	    called after <c>Suite:all/0</c></p>
+          <p>
+	    These functions allow modifying the return values from
+	    the <c>groups/0</c> and <c>all/0</c> functions,
+	    respectively.</p>
+          <p>
+	    A new term, <c>{testcase,TestCase,RepeatProperties}</c>
+	    is now also allowed in the return from <c>all/0</c>. This
+	    can be used for repeating a single test case a specific
+	    number of times, or until it fails or succeeds once.</p>
+          <p>
+	    Own Id: OTP-14746 Aux Id: ERIERL-143 </p>
+        </item>
+      </list>
+    </section>
+
+</section>
+
 <section><title>Common_Test 1.17.1</title>
 
     <section><title>Improvements and New Features</title>
-- 
cgit v1.2.3