From: Lucas Schnorr <Lucas.Schnorr@imag.fr>
Date: Mon, 26 Dec 2011 11:14:23 +0000 (+0100)
Subject: [doc] explain how to use TRACE_declare_mark and TRACE_mark
X-Git-Tag: exp_20120216~216
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/fe58734d3551e38fc9d5856d97d3e65dc33519de

[doc] explain how to use TRACE_declare_mark and TRACE_mark
---

diff --git a/doc/tracing.doc b/doc/tracing.doc
index 4a7fe288c0..d8b569259a 100644
--- a/doc/tracing.doc
+++ b/doc/tracing.doc
@@ -76,6 +76,20 @@ created with the function \c MSG_task_create. The second parameter
 \c category must contain a category that was previously defined by the function
 \c TRACE_category.
 
+\li <b>\c TRACE_declare_mark(const char *mark_type)</b>: This function
+declares a new Paje event type in the trace file that can be used by
+simulators to declare application-level marks. This function is
+independent of which API is used in SimGrid.
+
+\li <b>\c TRACE_mark(const char *mark_type, const char *mark_value)</b>:
+This function creates a mark in the trace file. The first parameter
+had to be previously declared using \c TRACE_declare_mark, the second
+is the identifier for this mark instance. We recommend that the \c
+mark_value (the second parameter) is a unique value for the whole
+trace file (the whole simulation). Nevertheless, this is not a strong
+requirement: the trace will be valid if there are multiple mark
+identifiers for the same trace.
+
 \li <b>\c TRACE_[host|link]_variable_declare (const char *variable)</b>:
 Declare a user variable that will be associated to host/link. A variable can
 be used to trace user variables such as the number of tasks in a server,