[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 54ebb90..f0318bb 100644 (file)
--- a/doc/doxygen/options.doc
+++ b/doc/doxygen/options.doc
@@ -65,6 +65,7 @@ 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, CPU and storage models built in, and you
@@ -77,6 +78,7 @@ should provide information about all models for all existing resources.
    - \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
@@ -680,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.
@@ -1113,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.
 
 */