diff mbox

gdb/doc: Update 'frame' command documentation.

Message ID 1436373901-2025-1-git-send-email-andrew.burgess@embecosm.com
State New
Headers show

Commit Message

Andrew Burgess July 8, 2015, 4:45 p.m. UTC
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   |  5 +++++
 gdb/doc/gdb.texinfo | 18 +++++-------------
 2 files changed, 10 insertions(+), 13 deletions(-)

Comments

Eli Zaretskii July 8, 2015, 4:58 p.m. UTC | #1
> From: Andrew Burgess <andrew.burgess@embecosm.com>
> Cc: Andrew Burgess <andrew.burgess@embecosm.com>
> Date: Wed,  8 Jul 2015 17:45:01 +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.

OK, thanks.
Joel Brobecker July 8, 2015, 5:51 p.m. UTC | #2
On Wed, Jul 08, 2015 at 07:58:14PM +0300, Eli Zaretskii wrote:
> > From: Andrew Burgess <andrew.burgess@embecosm.com>
> > Cc: Andrew Burgess <andrew.burgess@embecosm.com>
> > Date: Wed,  8 Jul 2015 17:45:01 +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.
> 
> OK, thanks.

Should this patch also be pushed to the gdb-7.10-branch?
Andrew Burgess July 8, 2015, 7:44 p.m. UTC | #3
* Joel Brobecker <brobecker@adacore.com> [2015-07-08 10:51:03 -0700]:

> On Wed, Jul 08, 2015 at 07:58:14PM +0300, Eli Zaretskii wrote:
> > > From: Andrew Burgess <andrew.burgess@embecosm.com>
> > > Cc: Andrew Burgess <andrew.burgess@embecosm.com>
> > > Date: Wed,  8 Jul 2015 17:45:01 +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.
> > 
> > OK, thanks.
> 
> Should this patch also be pushed to the gdb-7.10-branch?
> 
> -- 
> Joel
> 
> PS: not sure if it was an ommission, but I didn't see confirmation
>     from Andrew that he pushed the patch to master.

I have pushed to master, and also (now) to the 7.10 branch.

Thanks,
Andrew
Eli Zaretskii July 8, 2015, 7:48 p.m. UTC | #4
> Date: Wed, 8 Jul 2015 10:51:03 -0700
> From: Joel Brobecker <brobecker@adacore.com>
> Cc: Andrew Burgess <andrew.burgess@embecosm.com>,
> 	gdb-patches@sourceware.org
> 
> > > gdb/doc/ChangeLog:
> > > 
> > > 	* gdb.texinfo (Selection): Update documentation for 'frame'
> > > 	command.
> > 
> > OK, thanks.
> 
> Should this patch also be pushed to the gdb-7.10-branch?

Yes, I think so.
diff mbox

Patch

diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 18d9039..cf37489 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -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"
diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index eec4dce..9e2ecd1 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -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}