summaryrefslogtreecommitdiff
path: root/doc/mainpage.dox
diff options
context:
space:
mode:
Diffstat (limited to 'doc/mainpage.dox')
-rw-r--r--doc/mainpage.dox7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/mainpage.dox b/doc/mainpage.dox
index 925bfd2..329b840 100644
--- a/doc/mainpage.dox
+++ b/doc/mainpage.dox
@@ -124,7 +124,10 @@ 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.
-
+doesn't exist yet, then cmocka will put the output to this file. Note
+that if you are have several groups you should set <tt>CMOCKA_XML_FILE</tt>
+to <tt>CMOCKA_XML_FILE=cm_%g.xml</tt>. In this %g will be replaced by
+the group_name of the test and a file will be created for each group,
+othwerwise all groups will be printed into the same file.
*/