capture in the doc a recent discussion on ML

[simgrid.git] / doc / doxygen / module-smpi.doc

diff --git a/doc/doxygen/module-smpi.doc b/doc/doxygen/module-smpi.doc
index bbeaed2..245f482 100644 (file)
--- a/doc/doxygen/module-smpi.doc
+++ b/doc/doxygen/module-smpi.doc
@@ -4,8 +4,6 @@
 
 @tableofcontents
 
-[TOC]
-
 SMPI enables the study of MPI application by emulating them on top of
 the SimGrid simulator. This is particularly interesting to study
 existing MPI applications within the comfort of the simulator. The
@@ -34,6 +32,7 @@ requires some specific care from you.
  - @ref SMPI_use
    - @ref SMPI_use_compile
    - @ref SMPI_use_exec
+   - @ref SMPI_use_debug
    - @ref SMPI_use_colls
      - @ref SMPI_use_colls_algos
      - @ref SMPI_use_colls_tracing
@@ -89,6 +88,21 @@ by running
 smpirun -help
 @endverbatim
 
+@subsection SMPI_use_debug Debugging your code on top of SMPI
+
+If you want to explore the automatic platform and deployment files
+that are generated by @c smpirun, add @c -keep-temps to the command
+line.
+
+You can also run your simulation within valgrind or gdb using the
+following commands. Once in GDB, each MPI ranks will be represented as
+a regular thread, and you can explore the state of each of them as
+usual.
+@verbatim
+smpirun -wraper valgrind ...other args...
+smpirun -wraper "gdb -args" --cfg=contexts/factory:thread ...other args...
+@endverbatim
+
 @subsection SMPI_use_colls Simulating collective operations
 
 MPI collective operations are crucial to the performance of MPI