Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[simix] Use Task instead of std::package_task for timer callbacks
[simgrid.git] / doc / doxygen / options.doc
index b17f065..5a7d333 100644 (file)
@@ -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
@@ -1051,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