diff options
| author | Peter Andersson <[email protected]> | 2016-09-15 07:59:53 +0200 |
|---|---|---|
| committer | Peter Andersson <[email protected]> | 2016-09-15 07:59:53 +0200 |
| commit | 075e0a3ab1a0282fc0f9a1a9a8cd7ce96ab9fba3 (patch) | |
| tree | dc55448b366e2ab9c1c3d3f9e008df13e5c3af99 /lib/common_test/doc | |
| parent | 98b870f624753427b606f911fff255ff8864aa2e (diff) | |
| parent | 1c97ceb2c58353095ab87d80e5a5f42f0b87e19c (diff) | |
| download | otp-075e0a3ab1a0282fc0f9a1a9a8cd7ce96ab9fba3.tar.gz otp-075e0a3ab1a0282fc0f9a1a9a8cd7ce96ab9fba3.tar.bz2 otp-075e0a3ab1a0282fc0f9a1a9a8cd7ce96ab9fba3.zip | |
Merge branch 'peppe/common_test/docs-19.1' into maint
* peppe/common_test/docs-19.1:
Document functions for modifying and reading verbosity levels
Diffstat (limited to 'lib/common_test/doc')
| -rw-r--r-- | lib/common_test/doc/src/ct.xml | 30 | ||||
| -rw-r--r-- | lib/common_test/doc/src/write_test_chapter.xml | 4 |
2 files changed, 34 insertions, 0 deletions
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 @@ -620,6 +620,21 @@ </func> <func> + <name>get_verbosity(Category) -> 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) -> ok | {error, Reason}</name> <fsummary>Installs configuration files and event handlers.</fsummary> <type> @@ -1225,6 +1240,21 @@ </func> <func> + <name>set_verbosity(Category, Level) -> 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) -> ok</name> <fsummary>This function, similar to timer:sleep/1, suspends the test case for a specified time.</fsummary> 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> |