From: Gabriel Corona <gabriel.corona@loria.fr>
Date: Mon, 7 Dec 2015 12:46:13 +0000 (+0100)
Subject: [doc] Documentation about GDB+SMPI
X-Git-Tag: v3_13~1480^2~7
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/614890d870519622efbffad18e0bad9643c95019?hp=5bcc428156b0316a6e12b6a6b32d88f2e5e0944b

[doc] Documentation about GDB+SMPI
---

diff --git a/doc/doxygen/FAQ.doc b/doc/doxygen/FAQ.doc
index c5afe608e9..f70f833be5 100644
--- 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.
 
+\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
diff --git a/doc/manpage/smpirun.1 b/doc/manpage/smpirun.1
index a9e333684c..763664de43 100644
--- 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>
-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.