X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9b08ea751ac40d073f179978b499fd44246fd30e..3aeb6bac372f28bab70d2bdfa1d44e686f093f0d:/doc/doxygen/outcomes_vizu.doc?ds=sidebyside
diff --git a/doc/doxygen/outcomes_vizu.doc b/doc/doxygen/outcomes_vizu.doc
index b45b90f7d0..b4fb66faf4 100644
--- a/doc/doxygen/outcomes_vizu.doc
+++ b/doc/doxygen/outcomes_vizu.doc
@@ -1,8 +1,27 @@
+/**
+@defgroup TRACE_API TRACING
+@brief Gather data about your simulation for later analysis
+
+SimGrid can trace the resource (of hosts and links) utilization using
+any of its programming interfaces (S4U, SimDAG and SMPI). This means
+that the tracing will register how much power is used for each host
+and how much bandwidth is used for each link of the platform.
+
+The idea of the tracing facilities is to give SimGrid users to
+possibility to classify S4U and SimDAG tasks by category, tracing the
+platform utilization (hosts and links) for each of the categories.
+The API enables the declaration of categories and a function to
+associate them to the tasks (S4U and SD). The tasks that are not
+classified according to a category are not traced. If no categories
+are specified, simulations can still be traced using a special
+parameter in the command line (see @ref outcomes_vizu for details).
+*/
+
/*! @page outcomes_vizu Visualization and Statistical Analysis
SimGrid comes with an extensive support to trace and register what
happens during the simulation, so that it can be either visualized or
-statistically analysed after the simulation.
+statistically analysed after the simulation.
This tracing is widely used to observe and understand the behavior of
parallel applications and distributed algorithms. Usually, this is
@@ -209,13 +228,12 @@ TODO
@endverbatim
@li @c
-tracing/msg/process
+tracing/actor
:
- This option only has effect if this simulator is MSG-based. It traces the
- behavior of all categorized MSG processes, grouping them by hosts. This option
- can be used to track process location if this simulator has process migration.
+ This option traces the behavior of all categorized actors, grouping them by hosts. This option
+ can be used to track actor location if this simulator has actor migration.
@verbatim
---cfg=tracing/msg/process:yes
+--cfg=tracing/actor:yes
@endverbatim
@li @c
@@ -336,7 +354,7 @@ you should use to analyze your simulator.
@li I want to trace the resource utilization of all hosts
and links of the platform, and my simulator does not use
the tracing API. For that, you can run a uncategorized trace
-with the following parameters (it will work with any Simgrid
+with the following parameters (it will work with any SimGrid
simulator):
@verbatim
./your_simulator @
@@ -439,7 +457,7 @@ several options to analyze this trace file:
SimGrid User::Visualization 101 tutorial.
- Ask for help on the simgrid-user@lists.gforge.inria.fr
+ href="mailto:simgrid-community@inria.fr">simgrid-community@inria.fr
mailing list, giving us a detailed explanation on what your
simulator does and what kind of information you want to trace. You
can also check the