This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
[RFC, doc] Fix -stack-list-arguments parameter description
- From: Vladimir Prus <vladimir at codesourcery dot com>
- To: gdb-patches at sources dot redhat dot com
- Date: Fri, 30 Oct 2009 20:38:28 +0300
- Subject: [RFC, doc] Fix -stack-list-arguments parameter description
Current docs for -stack-list-arguments fails to document the '2'
value of the 'show-values' parameter. This patch fixes that, while
making the naming of parameter consistent with -stack-list-locals
and -stack-list-variables. OK?
Thanks,
Volodya
? gdb/doc/ChangeLog.lines
? gdb/doc/ChangeLog.my
? gdb/doc/all
? gdb/doc/my
? gdb/doc/stack-list-variables-docs.diff
Index: gdb/doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.639
diff -u -p -r1.639 gdb.texinfo
--- gdb/doc/gdb.texinfo 28 Oct 2009 15:01:27 -0000 1.639
+++ gdb/doc/gdb.texinfo 30 Oct 2009 17:36:49 -0000
@@ -23420,7 +23420,7 @@ For a stack with frame levels 0 through
@subsubheading Synopsis
@smallexample
- -stack-list-arguments @var{show-values}
+ -stack-list-arguments @var{print-values}
[ @var{low-frame} @var{high-frame} ]
@end smallexample
@@ -23433,9 +23433,11 @@ larger than the actual number of frames.
@var{high-frame} may be larger than the actual number of frames, in
which case only existing frames will be returned.
-The @var{show-values} argument must have a value of 0 or 1. A value of
-0 means that only the names of the arguments are listed, a value of 1
-means that both names and values of the arguments are printed.
+If @var{print-values} is 0 or @code{--no-values}, print only the names of
+the variables; if it is 1 or @code{--all-values}, print also their
+values; and if it is 2 or @code{--simple-values}, print the name,
+type and value for simple data types and the name and type for arrays,
+structures and unions.
Use of this command to obtain arguments in a single frame is
deprecated in favor of the @samp{-stack-list-variables} command.