[Doc] Added tentative note on collective algorithms to doc

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

diff --git a/doc/doxygen/options.doc b/doc/doxygen/options.doc
index 32035d8..f0318bb 100644 (file)
--- a/doc/doxygen/options.doc
+++ b/doc/doxygen/options.doc
@@ -64,9 +64,11 @@ int main(int argc, char *argv[]) {
 
 \section options_model Configuring the platform models
 
+\anchor options_storage_model
+\anchor options_vm_workstation_model
 \subsection options_model_select Selecting the platform models
 
-SimGrid comes with several network and CPU models built in, and you
+SimGrid comes with several network, CPU and storage models built in, and you
 can change the used model at runtime by changing the passed
 configuration. The three main configuration items are given below.
 For each of these items, passing the special \c help value gives
@@ -75,6 +77,8 @@ should provide information about all models for all existing resources.
    - \b network/model: specify the used network model
    - \b cpu/model: specify the used CPU model
    - \b workstation/model: specify the used workstation model
+   - \b storage/model: specify the used storage model (there is currently only one such model - this option is hence only useful for future releases)
+   - \b vm_workstation/model: specify the workstation model for virtual machines (there is currently only one such model - this option is hence only useful for future releases)
 
 %As of writing, the following network models are accepted. Over
 the time new models can be added, and some experimental models can be
@@ -384,7 +388,7 @@ be removed from the memory and some cycles might be missed.
 
 By default, no state is snapshotted and cycles cannot be detected.
 
-\subsection options_modelchecking_termination, model-check/termination, Non termination detection
+\subsection options_modelchecking_termination model-check/termination, Non termination detection
 
 The \b model-check/termination configuration item can be used to report if a
 non-termination execution path has been found. This is a path with a cycle
@@ -678,6 +682,21 @@ Please, use these two parameters (for comments) to make reproducible
 simulations. For additional details about this and all tracing
 options, check See the \ref tracing_tracing_options.
 
+\section options_msg Configuring MSG
+
+\subsection options_msg_debug_multiple_use Debugging MSG
+
+Sometimes your application may try to send a task that is still being
+executed somewhere else, making it impossible to send this task. However,
+for debugging purposes, one may want to know what the other host is/was
+doing. This option shows a backtrace of the other process.
+
+Enable this option by adding
+
+\verbatim
+--cfg=msg/debug_multiple_use:on
+\endverbatim
+
 \section options_smpi Configuring SMPI
 
 The SMPI interface provides several specific configuration items.
@@ -744,6 +763,12 @@ So, messages with size 65472 and more will get a total of MAX_BANDWIDTH*0.940694
 messages of size 15424 to 65471 will get MAX_BANDWIDTH*0.697866 and so on.
 Here, MAX_BANDWIDTH denotes the bandwidth of the link.
 
+\note
+    The SimGrid-Team has developed a script to help you determine these
+    values. You can find more information and the download here:
+    1. http://simgrid.gforge.inria.fr/contrib/smpi-calibration-doc.html
+    2. http://simgrid.gforge.inria.fr/contrib/smpi-saturation-doc.html
+
 \subsection options_smpi_timing smpi/display_timing: Reporting simulation time
 
 \b Default: 0 (false)
@@ -772,6 +797,12 @@ This is the default value:
 65472:11.6436;15424:3.48845;9376:2.59299;5776:2.18796;3484:1.88101;1426:1.61075;732:1.9503;257:1.95341;0:2.01467
 \endverbatim
 
+\note
+    The SimGrid-Team has developed a script to help you determine these
+    values. You can find more information and the download here:
+    1. http://simgrid.gforge.inria.fr/contrib/smpi-calibration-doc.html
+    2. http://simgrid.gforge.inria.fr/contrib/smpi-saturation-doc.html
+
 \subsection options_smpi_global smpi/privatize_global_variables: Automatic privatization of global variables
 
 MPI executables are meant to be executed in separated processes, but SMPI is
@@ -909,7 +940,7 @@ Here is an example:
     to sleep increases linearly with the number of previously failed testk.
 
 
-\subsection options_model_smpi_shared_malloc smpi/use_shared_malloc: Use shared memory
+\subsection options_model_smpi_use_shared_malloc smpi/use_shared_malloc: Use shared memory
 
 \b Default: 1
 
@@ -1099,16 +1130,7 @@ silently overflow on other parts of the memory.
 - \c workstation/model: \ref options_model_select
 
 \subsection options_index_smpi_coll Index of SMPI collective algorithms options
-- \c smpi/allgather: \ref options_model_smpi_coll_allgather
-- \c smpi/allgatherv: \ref options_model_smpi_coll_allgatherv
-- \c smpi/allreduce: \ref options_model_smpi_coll_allreduce
-- \c smpi/alltoall: \ref options_model_smpi_coll_alltoall
-- \c smpi/alltoallv: \ref options_model_smpi_coll_alltoallv
-- \c smpi/barrier: \ref options_model_smpi_coll_barrier
-- \c smpi/bcast: \ref options_model_smpi_coll_bcast
-- \c smpi/gather: \ref options_model_smpi_coll_gather
-- \c smpi/reduce: \ref options_model_smpi_coll_reduce
-- \c smpi/reduce_scatter: \ref options_model_smpi_coll_reduce_scatter
-- \c smpi/scatter: \ref options_model_smpi_coll_scatter
+
+TODO: All available collective algorithms will be made available via the ``smpirun --help-coll`` command.
 
 */