Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] documentation for new tracing options (comment, comment_file)
authorschnorr <Lucas.Schnorr@imag.fr>
Fri, 14 Sep 2012 08:26:00 +0000 (10:26 +0200)
committerschnorr <Lucas.Schnorr@imag.fr>
Fri, 14 Sep 2012 08:26:00 +0000 (10:26 +0200)
doc/user_guide/doxygen/tracing.doc

index c11af0c..a21a049 100644 (file)
@@ -226,6 +226,22 @@ information that would be registered otherwise.
 --cfg=tracing/basic:1
 \endverbatim
 
 --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>:
 \li <b>\c
 triva/categorized
 </b>: