Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[DOC] Added notes about SMPI_SAMPLE macros
[simgrid.git] / doc / doxygen / options.doc
index 3bc5f7b..c01adfc 100644 (file)
@@ -153,7 +153,8 @@ existing classes (for instance, a class "CpuEnergy" inherits from
 "Cpu" to assess energy consumption).
 
 The plugin connects to the code by registering callbacks using
-``surf_callback_register`` (see file ``src/surf/plugins/energy.cpp`` for details).
+``signal.connect(callback)`` (see file ``src/surf/plugins/energy.cpp`` for
+details).
 
 \verbatim
     --cfg=plugin:Energy
@@ -751,8 +752,15 @@ being replayed/simulated. At the moment, these computation events can
 be simulated using SMPI by calling internal smpi_execute*() functions.
 
 To disable the benchmarking/simulation of computation in the simulated
-application, the variable \b
-smpi/simulate_computation should be set to no
+application, the variable \b smpi/simulate_computation should be set to no.
+Equivalently, setting \b smpi/cpu_threshold to -1 also ignores all
+computation.
+
+\note
+    This option just ignores the timings in your simulation; it still executes
+    the computations itself. If you want to stop SMPI from doing that,
+    you should check the SMPI_SAMPLE macros, documented in the chapter
+    \ref SMPI_adapting_speed.
 
 \subsection options_model_smpi_bw_factor smpi/bw_factor: Bandwidth factors