From b7ced331aa797567c4e180eec0b59e59f7227044 Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Mon, 2 May 2016 01:14:10 +0200
Subject: Add flag/option for disabling the character escaping functionality

OTP-13537
---
 lib/common_test/doc/src/write_test_chapter.xml | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

(limited to 'lib/common_test/doc/src/write_test_chapter.xml')

diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml
index e3811ec4cf..a7a652d506 100644
--- a/lib/common_test/doc/src/write_test_chapter.xml
+++ b/lib/common_test/doc/src/write_test_chapter.xml
@@ -1047,9 +1047,15 @@
     
     <p>Common Test will escape special HTML characters (&lt;, &gt; and &amp;) in printouts
     to the log file made with <c>ct:pal/4</c> and <c>io:format/2</c>. In order to print
-    strings with HTML tags to the log, use the <c>ct:log/5</c> function. The character escaping
-    feature is per default disabled for <c>ct:log/5</c>, but can be enabled with the
-    <c>esc_chars</c> option.</p>
+    strings with HTML tags to the log, use the <c>ct:log/3,4,5</c> function. The character
+    escaping feature is per default disabled for <c>ct:log/3,4,5</c> but can be enabled with
+    the <c>esc_chars</c> option in the <c>Opts</c> list, see <seealso marker="ct#log-5">
+    <c>ct:log/3,4,5</c></seealso>.</p>
+
+    <p>If the character escaping feature needs to be disabled (typically for backwards
+    compatibility reasons), use the <c>ct_run</c> start flag <c>-no_esc_chars</c>, or the
+    <c>ct:run_test/1</c> start option <c>{esc_chars,Bool}</c> (this start option is also
+    supported in test specifications).</p>
 
     <p>For more information about log files, see section
     <seealso marker="run_test_chapter#log_files">Log Files</seealso> 
-- 
cgit v1.2.3