* gdb.texinfo (Starting): Document new start command.
authorJoel Brobecker <brobecker@gnat.com>
Mon, 24 May 2004 23:53:58 +0000 (23:53 +0000)
committerJoel Brobecker <brobecker@gnat.com>
Mon, 24 May 2004 23:53:58 +0000 (23:53 +0000)
gdb/doc/ChangeLog
gdb/doc/gdb.texinfo

index 27501ae70fcd64bf5df280c33c8733fcaee28bef..bdf5e8074f4b9517d158b9ff980225ab73fdb84b 100644 (file)
@@ -1,3 +1,7 @@
+2004-05-24  Joel Brobecker  <brobecker@gnat.com>
+
+       * gdb.texinfo (Starting): Document new start command.
+
 2004-05-21  Andrew Cagney  <cagney@redhat.com>
 
        * observer.texi (GDB Observers): Document "inferior_created".
index aa82d06b5525fc080e9a47325b075d772c5404fd..25a968947160a1100b58e1dbe7f4d1c8255da3a2 100644 (file)
@@ -1768,6 +1768,42 @@ time @value{GDBN} read its symbols, @value{GDBN} discards its symbol
 table, and reads it again.  When it does this, @value{GDBN} tries to retain
 your current breakpoints.
 
+@table @code
+@kindex start
+@item start
+@cindex run to main procedure
+The name of the main procedure can vary from language to language.
+With C or C@t{++}, the main procedure name is always @code{main}, but
+other languages such as Ada do not require a specific name for their
+main procedure.  The debugger provides a convenient way to start the
+execution of the program and to stop at the beginning of the main
+procedure, depending on the language used.
+
+The @samp{start} command does the equivalent of setting a temporary
+breakpoint at the beginning of the main procedure and then invoking
+the @samp{run} command.
+
+Some programs contain an elaboration phase where some startup code is
+executed before the main program is called.  This depends on the
+languages used to write your program. In C@t{++} for instance,
+constructors for static and global objects are executed before
+@code{main} is called.  It is therefore possible that the debugger stops
+before reaching the main procedure.  However, the temporary breakpoint
+will remain to halt execution.
+
+Specify the arguments to give to your program as arguments to the
+@samp{start} command.  These arguments will be given verbatim to the
+underlying @samp{run} command.  Note that the same arguments will be
+reused if no argument is provided during subsequent calls to
+@samp{start} or @samp{run}.
+
+It is sometimes necessary to debug the program during elaboration.  In
+these cases, using the @code{start} command would stop the execution of
+your program too late, as the program would have already completed the
+elaboration phase.  Under these circumstances, insert breakpoints in your
+elaboration code before running your program.
+@end table
+
 @node Arguments
 @section Your program's arguments