[RFC, doc] Fix -stack-list-arguments parameter description

[RFC, doc] Fix -stack-list-arguments parameter description

[Vladimir Prus]

[-- Attachment #1: Type: Text/Plain, Size: 247 bytes --]


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

[-- Attachment #2: list-arguments.diff --]
[-- Type: text/x-patch, Size: 1509 bytes --]

? 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.

Re: [RFC, doc] Fix -stack-list-arguments parameter description

[Eli Zaretskii]

> From: Vladimir Prus <vladimir@codesourcery.com>
> Date: Fri, 30 Oct 2009 20:38:28 +0300
> 
> 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?

Yes, thanks.  One small request, though:

> +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.              ^

Please add a comma where shown.

Re: [RFC, doc] Fix -stack-list-arguments parameter description

[Vladimir Prus]

[-- Attachment #1: Type: Text/Plain, Size: 1010 bytes --]

On Friday 30 October 2009 Eli Zaretskii wrote:

> > From: Vladimir Prus <vladimir@codesourcery.com>
> > Date: Fri, 30 Oct 2009 20:38:28 +0300
> > 
> > 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?
> 
> Yes, thanks.  One small request, though:
> 
> > +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.              ^
> 
> Please add a comma where shown.

Thanks. I've checked in the below. Because this text is the same for 
-stack-list-arguments, -stack-list-locals and -stack-list-variables,
I have added comas there as well.

- Volodya



> 

[-- Attachment #2: final.diff --]
[-- Type: text/x-patch, Size: 3090 bytes --]

Index: gdb/doc/ChangeLog
===================================================================
RCS file: /cvs/src/src/gdb/doc/ChangeLog,v
retrieving revision 1.968
diff -u -p -r1.968 ChangeLog
--- gdb/doc/ChangeLog	27 Oct 2009 20:51:22 -0000	1.968
+++ gdb/doc/ChangeLog	1 Nov 2009 19:52:52 -0000
@@ -1,3 +1,9 @@
+2009-11-01  Vladimir Prus  <vladimir@codesourcery.com>
+
+	* gdb.texinfo (GDB/MI Stack Manipulation): Make
+	-stack-list-arguments have the same documentation for parameter
+	as -stack-list-locals. Add comas.
+
 2009-10-27  Tom Tromey <tromey@redhat.com>
 	    Eli Zaretskii <eliz@gnu.org>
 
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	1 Nov 2009 19:52:53 -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.
@@ -23618,7 +23620,7 @@ Display the local variable names for the
 @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,
+type and value for simple data types, and the name and type for arrays,
 structures and unions.  In this last case, a frontend can immediately
 display the value of simple data types and create variable objects for
 other data types when the user wishes to explore their values in
@@ -23660,7 +23662,7 @@ Display the names of local variables and
 @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,
+type and value for simple data types, and the name and type for arrays,
 structures and unions.  
 
 @subsubheading Example

Re: [RFC, doc] Fix -stack-list-arguments parameter description

[Eli Zaretskii]

> From: Vladimir Prus <vladimir@codesourcery.com>
> Date: Sun, 1 Nov 2009 22:55:40 +0300
> Cc: gdb-patches@sources.redhat.com
> 
> Thanks. I've checked in the below. Because this text is the same for 
> -stack-list-arguments, -stack-list-locals and -stack-list-variables,
> I have added comas there as well.

Thank you.