MI: -var-list-children doc error

MI: -var-list-children doc error

[Chris Genly]

The documentation for -var-list-children does not match what Cygwin
GDB produces, or Eclipse DSF expects.

The documentation for -var-list-children is here:

   http://sourceware.org/gdb/current/onlinedocs/gdb_26.html#SEC449

Which shows:

  -var-list-children n
  ^done,numchild=n,children=[{name=name,
numchild=n,type=type},(repeats N times)]

Here is example GDB/MI output:

  21-var-list-children var1
  21^done,numchild="1",children=[child={name="var1.public",exp="public",numchild="2"}]

Notice the "child=" is present in actual implementations, but is
missing from the documentation.  Also the Cygwin GDB output shows an
"exp" result in the child definition.  This is not documented either.

Re: MI: -var-list-children doc error

[Eli Zaretskii]

> Date: Wed, 17 Jun 2009 10:07:29 -0700
> From: Chris Genly <chgenly@gmail.com>
> 
> The documentation for -var-list-children does not match what Cygwin
> GDB produces, or Eclipse DSF expects.

Documentation patches are welcome.

Re: MI: -var-list-children doc error

[Chris Genly]

I can do that. Please direct me to the right files and let me know what formats.

On Wed, Jun 17, 2009 at 10:29 AM, Eli Zaretskii<eliz@gnu.org> wrote:
>> Date: Wed, 17 Jun 2009 10:07:29 -0700
>> From: Chris Genly <chgenly@gmail.com>
>>
>> The documentation for -var-list-children does not match what Cygwin
>> GDB produces, or Eclipse DSF expects.
>
> Documentation patches are welcome.
>

Re: MI: -var-list-children doc error

[Eli Zaretskii]

> Date: Wed, 17 Jun 2009 10:32:44 -0700
> From: Chris Genly <chgenly@gmail.com>
> Cc: gdb@sourceware.org
> 
> I can do that. Please direct me to the right files and let me know what formats.

The GDB manual's source is gdb/doc/gdb.texinfo.  It's written in
Texinfo, but is almost pure text, so I think producing a patch will
not be difficult, even if you are not familiar with Texinfo.  (If you
want to learn about Texinfo, typing "info texinfo" at your shell
prompt will most probably show you the Texinfo manual.)

Please post the patches to gdb-patches@sourceware.org.

Thanks.