gdb/doc: Update 'frame' command documentation.
authorAndrew Burgess <andrew.burgess@embecosm.com>
Wed, 8 Jul 2015 14:02:32 +0000 (15:02 +0100)
committerAndrew Burgess <andrew.burgess@embecosm.com>
Wed, 8 Jul 2015 16:39:35 +0000 (17:39 +0100)
The documentation for the 'frame' command has gotten a little out of
date, it still mentions architecturally specific details that are no
longer relevant.

This commit removes the old details that no longer apply, and tries to
expand the existing text a little to make the usage clearer for some
cases.

gdb/doc/ChangeLog:

* gdb.texinfo (Selection): Update documentation for 'frame'
command.

gdb/doc/ChangeLog
gdb/doc/gdb.texinfo

index 18d903900f2a90c2b4050d9ba4a50c4ea638dfd2..cf3748936e8951eb49f89f3b212ae04272f621de 100644 (file)
@@ -1,3 +1,8 @@
+2015-07-08  Andrew Burgess  <andrew.burgess@embecosm.com>
+
+       * gdb.texinfo (Selection): Update documentation for 'frame'
+       command.
+
 2015-07-02  Markus Metzger  <markus.t.metzger@intel.com>
 
         * gdb.texinfo (Maintenance Commands): Document "maint btrace"
index eec4dce9a9fc32c1cc43b94ac676130a8979932b..9e2ecd150353bc07feedabe47d25f2b98a92057d 100644 (file)
@@ -7320,22 +7320,14 @@ Select frame number @var{n}.  Recall that frame zero is the innermost
 innermost one, and so on.  The highest-numbered frame is the one for
 @code{main}.
 
-@item frame @var{addr}
-@itemx f @var{addr}
-Select the frame at address @var{addr}.  This is useful mainly if the
+@item frame @var{stack-addr} [ @var{pc-addr} ]
+@itemx f @var{stack-addr} [ @var{pc-addr} ]
+Select the frame at address @var{stack-addr}.  This is useful mainly if the
 chaining of stack frames has been damaged by a bug, making it
 impossible for @value{GDBN} to assign numbers properly to all frames.  In
 addition, this can be useful when your program has multiple stacks and
-switches between them.
-
-On the SPARC architecture, @code{frame} needs two addresses to
-select an arbitrary frame: a frame pointer and a stack pointer.
-
-On the @acronym{MIPS} and Alpha architecture, it needs two addresses: a stack
-pointer and a program counter.
-
-On the 29k architecture, it needs three addresses: a register stack
-pointer, a program counter, and a memory stack pointer.
+switches between them.  The optional @var{pc-addr} can also be given to
+specify the value of PC for the stack frame.
 
 @kindex up
 @item up @var{n}