From 1c97ceb2c58353095ab87d80e5a5f42f0b87e19c Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Wed, 14 Sep 2016 23:29:27 +0200
Subject: Document functions for modifying and reading verbosity levels

---
 lib/common_test/doc/src/ct.xml                 | 30 ++++++++++++++++++++++++++
 lib/common_test/doc/src/write_test_chapter.xml |  4 ++++
 2 files changed, 34 insertions(+)

(limited to 'lib/common_test')

diff --git a/lib/common_test/doc/src/ct.xml b/lib/common_test/doc/src/ct.xml
index ffc64cba67..53ef41dd5b 100644
--- a/lib/common_test/doc/src/ct.xml
+++ b/lib/common_test/doc/src/ct.xml
@@ -619,6 +619,21 @@
       </desc>
     </func>
 
+    <func>
+      <name>get_verbosity(Category) -&gt; Level | undefined</name>
+      <fsummary>Read the verbosity level for a logging category.</fsummary>
+      <type>
+        <v>Category = default | atom()</v>
+        <v>Level = integer()</v>
+      </type>
+      <desc><marker id="get_verbosity-1"/>
+        <p>This function returns the verbosity level for the specified logging
+	category. See the <seealso marker="write_test_chapter#logging">
+	User's Guide</seealso> for details. Use the value <c>default</c> to read
+	the general verbosity level.</p>
+      </desc>
+    </func>
+
     <func>
       <name>install(Opts) -&gt; ok | {error, Reason}</name>
       <fsummary>Installs configuration files and event handlers.</fsummary>
@@ -1224,6 +1239,21 @@
       </desc>
     </func>
 
+    <func>
+      <name>set_verbosity(Category, Level) -&gt; ok</name>
+      <fsummary>Set the verbosity level for a logging category.</fsummary>
+      <type>
+        <v>Category = default | atom()</v>
+        <v>Level = integer()</v>
+      </type>
+      <desc><marker id="set_verbosity-2"/>
+        <p>Use this function to set, or modify, the verbosity level for a logging
+	category. See the <seealso marker="write_test_chapter#logging">
+	User's Guide</seealso> for details. Use the value <c>default</c> to set the
+	general verbosity level.</p>
+      </desc>
+    </func>
+
     <func>
       <name>sleep(Time) -&gt; ok</name>
       <fsummary>This function, similar to timer:sleep/1, suspends the
diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml
index 7bd2ccf588..1d3fbb6f76 100644
--- a/lib/common_test/doc/src/write_test_chapter.xml
+++ b/lib/common_test/doc/src/write_test_chapter.xml
@@ -1031,6 +1031,10 @@
  4. Categorized info, importance = 25
  6. Categorized error, importance = 99</pre>
 
+    <p>The functions <seealso marker="ct#set_verbosity-2"><c>ct:set_verbosity/2</c></seealso>
+    and <seealso marker="ct#get_verbosity-1"><c>ct:get_verbosity/1</c></seealso> may be used
+    to modify and read verbosity levels during test execution.</p>
+
     <p>The arguments <c>Format</c> and <c>FormatArgs</c> in <c>ct:log/print/pal</c> are
     always passed on to the STDLIB function <c>io:format/3</c> (For details,
     see the <seealso marker="stdlib:io"><c>io</c></seealso> manual page).</p>
-- 
cgit v1.2.3