aboutsummaryrefslogtreecommitdiffstats
path: root/lib/common_test/doc/src/write_test_chapter.xml
diff options
context:
space:
mode:
authorHenrik Nord <[email protected]>2016-05-04 12:54:05 +0200
committerHenrik Nord <[email protected]>2016-05-04 12:54:05 +0200
commit91d372e23e1d19bb0c5200ba1682f9e4bc57ed76 (patch)
tree79eedbd59410d013190e63373b1e7c25d6a7862c /lib/common_test/doc/src/write_test_chapter.xml
parent4c8fdca47c9e727dfcc1ab2049ffea35cef76b39 (diff)
parent1ab69efa960703b86a13ea6ba96f4fd56f1565f9 (diff)
downloadotp-91d372e23e1d19bb0c5200ba1682f9e4bc57ed76.tar.gz
otp-91d372e23e1d19bb0c5200ba1682f9e4bc57ed76.tar.bz2
otp-91d372e23e1d19bb0c5200ba1682f9e4bc57ed76.zip
Merge branch 'maint-18'
Conflicts: OTP_VERSION lib/common_test/test/ct_hooks_SUITE_data/cth/tests/ct_update_config_SUITE.erl lib/common_test/vsn.mk
Diffstat (limited to 'lib/common_test/doc/src/write_test_chapter.xml')
-rw-r--r--lib/common_test/doc/src/write_test_chapter.xml12
1 files changed, 9 insertions, 3 deletions
diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml
index 40e02347f2..83daf771a6 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>