Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid

[simgrid.git] / doc / doxygen / options.doc

diff --git a/doc/doxygen/options.doc b/doc/doxygen/options.doc
index a31c819..5a7d333 100644 (file)
--- a/doc/doxygen/options.doc
+++ b/doc/doxygen/options.doc
@@ -873,6 +873,9 @@ To avoid this, several options are possible :
   To use this runtime automatic switching, the variable \b smpi/privatize-global-variables
   should be set to yes
 
+\warning
+  This configuration option cannot be set in your platform file. You can only
+  pass it as an argument to smpirun.
 
 
 \subsection options_model_smpi_detached Simulating MPI detached send
@@ -881,7 +884,7 @@ This threshold specifies the size in bytes under which the send will return
 immediately. This is different from the threshold detailed in  \ref options_model_network_asyncsend
 because the message is not effectively sent when the send is posted. SMPI still waits for the
 correspondant receive to be posted to perform the communication operation. This threshold can be set
-by changing the \b smpi/send-is-detached item. The default value is 65536.
+by changing the \b smpi/send-is-detached-thresh item. The default value is 65536.
 
 \subsection options_model_smpi_collectives Simulating MPI collective algorithms
 
@@ -898,6 +901,13 @@ uses naive version of collective operations). Each collective operation can be m
 The behavior and motivation for this configuration option is identical with \a smpi/test, see
 Section \ref options_model_smpi_test for details.
 
+\subsection options_model_smpi_init smpi/init: Inject constant times for calls to MPI_Init
+
+\b Default value: 0
+
+The behavior for this configuration option is identical with \a smpi/test, see
+Section \ref options_model_smpi_test for details.
+
 \subsection options_model_smpi_ois smpi/ois: Inject constant times for asynchronous send operations
 
 This configuration option works exactly as \a smpi/os, see Section \ref options_model_smpi_os.
@@ -1044,13 +1054,16 @@ when \b verbose-exit is set to 0 (it is to 1 by default).
 
 \subsection options_exception_cutpath Truncate local path from exception backtrace
 
-<b>This configuration option is an internal option and should normally not be used
-by the user.</b> It is used to remove the path from the backtrace
-shown when an exception is thrown; if we didn't remove this part, the tests
-testing the exception parts of simgrid would fail on most machines, as we are
-currently comparing output. Clearly, the path used on different machines are almost
-guaranteed to be different and hence, the output would
-mismatch, causing the test to fail.
+\verbatim
+--cfg=exceptions/cutpath:1
+\endverbatim
+
+This configuration option is used to remove the path from the
+backtrace shown when an exception is thrown. This is mainly useful for
+the tests: the full file path makes the tests not reproducible, and
+thus failing as we are currently comparing output. Clearly, the path
+used on different machines are almost guaranteed to be different and
+hence, the output would mismatch, causing the test to fail.
 
 \section options_log Logging Configuration
 
@@ -1150,6 +1163,7 @@ silently overflow on other parts of the memory.
 - \c smpi/lat-factor: \ref options_model_smpi_lat_factor
 - \c smpi/IB-penalty-factors: \ref options_model_network_coefs
 - \c smpi/iprobe: \ref options_model_smpi_iprobe
+- \c smpi/init: \ref options_model_smpi_init
 - \c smpi/ois: \ref options_model_smpi_ois
 - \c smpi/or: \ref options_model_smpi_or
 - \c smpi/os: \ref options_model_smpi_os