Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Rename SafetyChecker::is_exploration_stack_state() into checkNonDeterminism()
[simgrid.git] / doc / doxygen / tracing.doc
index 2c4a4d8..d5f2d01 100644 (file)
@@ -12,22 +12,6 @@ and analyze them. This part of the user manual explains how the
 tracing-related features can be enabled and used during the
 development of simulators using the SimGrid library.
 
-\section tracing_tracing_enabling Enabling using CMake
-
-With the sources of SimGrid, it is possible to enable the tracing
-using the parameter <b>-Denable_tracing=ON</b> when the cmake is
-executed.  The sections \ref instr_category_functions, \ref
-instr_mark_functions, and \ref instr_uservariables_functions describe
-all the functions available when this Cmake options is
-activated. These functions will have no effect if SimGrid is
-configured without this option (they are wiped-out by the
-C-preprocessor).
-
-\verbatim
-$ cmake -Denable_tracing=ON .
-$ make
-\endverbatim
-
 \section instr_category_functions Tracing categories functions
 
 The SimGrid library is instrumented so users can trace the platform
@@ -143,17 +127,6 @@ tracing/filename
 \endverbatim
   If you do not provide this parameter, the trace file will be named simgrid.trace.
 
-\li <b>\c
-tracing/onelink_only
-</b>:
-  By default, the tracing system uses all routes in the platform file
-  to re-create a "graph" of the platform and register it in the trace file.
-  This option let the user tell the tracing system to use only the routes
-  that are composed with just one link.
-\verbatim
---cfg=tracing/onelink_only:yes
-\endverbatim
-
 \li <b>\c
 tracing/smpi
 </b>:
@@ -201,6 +174,38 @@ exchanged in the trace, both in the links and on the states. For collective, siz
 --cfg=tracing/smpi/display_sizes:yes
 \endverbatim
 
+\li <b>\c
+tracing/smpi/sleeping
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
+\li <b>\c
+tracing/smpi/format
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
+\li <b>\c
+tracing/smpi/format/ti_one_file
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
+\li <b>\c
+tracing/msg/vm
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
 \li <b>\c
 tracing/msg/process
 </b>:
@@ -237,6 +242,22 @@ traced as usual.
 --cfg=tracing/onelink_only:yes
 \endverbatim
 
+\li <b>\c
+tracing/disable_link
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
+\li <b>\c
+tracing/disable_power
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
 \li <b>\c
 tracing/disable_destroy
 </b>:
@@ -274,6 +295,30 @@ Use this to add the contents of a file to the top of the trace file as comment.
 --cfg=tracing/comment_file:textual_file.txt
 \endverbatim
 
+\li <b>\c
+tracing/precision
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
+\li <b>\c
+tracing/platform
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
+\li <b>\c
+tracing/platform/topology
+</b>:
+TODO
+\verbatim
+TODO
+\endverbatim
+
 \li <b>\c
 viva/categorized
 </b>:
@@ -452,7 +497,7 @@ the beggining and size of the time slice.
 
 \subsubsection tracing_viva_graph Hierarchical Graph View
 
-As stated above (see section \ref tracing_tracing_analyzing), one
+%As stated above (see section \ref tracing_tracing_analyzing), one
 possibility to analyze SimGrid traces is to use Viva's graph view with
 a graph configuration to customize the graph according to the
 traces. A valid graph configuration (we are using the non-XML <a