From d93424cdce82c0a94dc3e19867ae4459f144726d Mon Sep 17 00:00:00 2001
From: schnorr <Lucas.Schnorr@imag.fr>
Date: Fri, 14 Sep 2012 10:26:00 +0200
Subject: [PATCH] [trace] documentation for new tracing options (comment,
 comment_file)

---
 doc/user_guide/doxygen/tracing.doc | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/doc/user_guide/doxygen/tracing.doc b/doc/user_guide/doxygen/tracing.doc
index c11af0cef6..a21a0492e1 100644
--- a/doc/user_guide/doxygen/tracing.doc
+++ b/doc/user_guide/doxygen/tracing.doc
@@ -226,6 +226,22 @@ information that would be registered otherwise.
 --cfg=tracing/basic:1
 \endverbatim
 
+\li <b>\c
+tracing/comment
+</b>:
+Use this to add a comment line to the top of the trace file.
+\verbatim
+--cfg=tracing/comment:my_string
+\endverbatim
+
+\li <b>\c
+tracing/comment_file
+</b>:
+Use this to add the contents of a file to the top of the trace file as comment.
+\verbatim
+--cfg=tracing/comment_file:textual_file.txt
+\endverbatim
+
 \li <b>\c
 triva/categorized
 </b>:
-- 
2.20.1