[doc] Documentation about GDB+SMPI

diff --git a/doc/doxygen/FAQ.doc b/doc/doxygen/FAQ.doc
index c5afe60..f70f833 100644 (file)
--- a/doc/doxygen/FAQ.doc
+++ b/doc/doxygen/FAQ.doc
@@ -608,6 +608,19 @@ of the root tag. Currently, it should read:
 If your files are too old, you can use the simgrid_update_xml.pl
 script which can be found in the tools directory of the archive.
 
 If your files are too old, you can use the simgrid_update_xml.pl
 script which can be found in the tools directory of the archive.
 

+\subsection faq_trouble_debug Debugging SMPI applications
+
+In order to debug SMPI programs, you can use the following options:
+
+- <b>-wrapper 'gdb --args'</b>: this option is used to use a wrapper
+  in order to call the SMPI process. Good candidates for this options
+  are "gdb --args", "valgrind", "rr record", "strace", etc;
+
+- <b>-foreground</b>: this options gives the debugger access to the terminal
+  which is needed in order to use an interactive debugger.
+
+Both options are needed in order to run the SMPI process under GDB.
+

 \subsection faq_trouble_valgrind Valgrind-related and other debugger issues
 
 If you don't, you really should use valgrind to debug your code, it's
 \subsection faq_trouble_valgrind Valgrind-related and other debugger issues
 
 If you don't, you really should use valgrind to debug your code, it's

diff --git a/doc/manpage/smpirun.1 b/doc/manpage/smpirun.1
index a9e3336..763664d 100644 (file)
--- a/doc/manpage/smpirun.1
+++ b/doc/manpage/smpirun.1
@@ -23,7 +23,12 @@ Print the usage and a résumé of the available options
 Do not remove the generated files after execution.
 .TP
 \fB\-wrapper\fR <command>
 Do not remove the generated files after execution.
 .TP
 \fB\-wrapper\fR <command>

-Use command to run the program (e.g. "valgrind").
+Use command to run the program (e.g. "valgrind", "gdb --args", "rr record").
+You usually want to use the "-foreground" option as well in order to have a TTY.
+.TP
+\fB\-foreground\fR
+Run the child process in the foreground.
+This gives the child process access to the TTY.

 .TP
 \fB\-map\fR
 Display the machine on which each process rank is mapped.
 .TP
 \fB\-map\fR
 Display the machine on which each process rank is mapped.