gdb.texinfo patch for -var-list-children

gdb.texinfo patch for -var-list-children

[Chris Genly]

Description

The gdb documentation for the MI command -var-list-children does not
match what Eclipse DSF expects, nor what Cygwin gcc generates.  This
patch corrects the documentation.


Change log

2009-06-17 Chris Genly <chris@genly.us>
        * Fixed syntax error for -var-list-children example.  Added
"child=" for each child.

Patch

Index: gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.600
diff -c -p -r1.600 gdb.texinfo
*** gdb.texinfo	15 Jun 2009 12:11:36 -0000	1.600
--- gdb.texinfo	17 Jun 2009 20:36:35 -0000
*************** and unions.
*** 23256,23266 ****
  @smallexample
  (gdb)
   -var-list-children n
!  ^done,numchild=@var{n},children=[@{name=@var{name},
   numchild=@var{n},type=@var{type}@},@r{(repeats N times)}]
  (gdb)
   -var-list-children --all-values n
!  ^done,numchild=@var{n},children=[@{name=@var{name},
   numchild=@var{n},value=@var{value},type=@var{type}@},@r{(repeats N times)}]
  @end smallexample

--- 23256,23266 ----
  @smallexample
  (gdb)
   -var-list-children n
!  ^done,numchild=@var{n},children=[child=@{name=@var{name},
   numchild=@var{n},type=@var{type}@},@r{(repeats N times)}]
  (gdb)
   -var-list-children --all-values n
!  ^done,numchild=@var{n},children=[child=@{name=@var{name},
   numchild=@var{n},value=@var{value},type=@var{type}@},@r{(repeats N times)}]
  @end smallexample

Re: gdb.texinfo patch for -var-list-children

[Eli Zaretskii]

> Date: Wed, 17 Jun 2009 13:48:21 -0700
> From: Chris Genly <chgenly@gmail.com>
> 
> The gdb documentation for the MI command -var-list-children does not
> match what Eclipse DSF expects, nor what Cygwin gcc generates.  This
> patch corrects the documentation.

Thanks, this patch is approved.  But please format the ChangeLog entry
according to our standards: it should mention the file name and the
node name where you make the changes.  See gdb/doc/ChangeLog for
examples.

Do you have write access to the GDB repository?  If you do, please
commit the changes after you fix the log entry.  If not, I will commit
this when I get back from traveling (if no one else beats me to it).

Thanks again for working on this.

Re: gdb.texinfo patch for -var-list-children

[Chris Genly]

I don't have change access to the gdb sources.  Sorry about the
ChangeLog format.

On Thu, Jun 18, 2009 at 7:42 AM, Eli Zaretskii<eliz@gnu.org> wrote:
> Thanks, this patch is approved.  But please format the ChangeLog entry
> according to our standards: it should mention the file name and the
> node name where you make the changes.  See gdb/doc/ChangeLog for
> examples.
>
> Do you have write access to the GDB repository?  If you do, please
> commit the changes after you fix the log entry.  If not, I will commit
> this when I get back from traveling (if no one else beats me to it).
>
> Thanks again for working on this.