diff options
author | Jakub Hrozek <jakub.hrozek@posteo.se> | 2015-02-07 10:41:46 +0100 |
---|---|---|
committer | Andreas Schneider <asn@cryptomilk.org> | 2015-02-08 10:29:16 +0100 |
commit | 3e8d86a7adedd0645e4edb2954f045cb93fa82cc (patch) | |
tree | fa4e2ddb376d371ed6c34e7256ac3810482e3c3c /doc | |
parent | 41e0fc525878d680d257b62fef5af406ee1fab4b (diff) | |
download | cmocka-3e8d86a7adedd0645e4edb2954f045cb93fa82cc.tar.gz cmocka-3e8d86a7adedd0645e4edb2954f045cb93fa82cc.tar.bz2 cmocka-3e8d86a7adedd0645e4edb2954f045cb93fa82cc.zip |
doc: Update cmocka documentation for new environment variables
Adds documentation for the new XML and subunit output.
Signed-off-by: Jakub Hrozek <jakub.hrozek@posteo.se>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/mainpage.dox | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/mainpage.dox b/doc/mainpage.dox index 46dc4e4..e747777 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -33,6 +33,7 @@ The CMocka library provides: - Very well tested - Testing of memory leaks, buffer overflows and underflows. - A set of assert macros. + - Several supported output formats (stdout, jUnit XML, Subunit) - License: Apache License 2.0 @section main-test A cmocka test @@ -97,4 +98,20 @@ following envionment variable: With this environment variable set to '1', cmocka will call <tt>abort()</tt> if a test fails. +@section main-output Output formats + +By default, cmocka prints human-readable test output to stderr. It is +possible to configure several other output formats. The configuration is +done using the <tt>CMOCKA_MESSAGE_OUTPUT</tt> environment variable. The +supported values are: + - <tt>STDOUT</tt> for the default standard output printer + - <tt>XML</tt> for jUnit XML format + - <tt>SUBUNIT</tt> for subunit output +The case doesn't matter. + +The XML output goes to stderr by default. If the environment variable +<tt>CMOCKA_XML_FILE</tt> exists and the file specified by this variable +doesn't exist yet, then cmocka will put the output to this file. + + */ |