Re: gdb.texinfo patch for -var-list-children (2)

[Chris Genly <chgenly@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 368 bytes --]

Description

The gdb documentation for the MI command -var-list-children does not
define the exp result for a child.  Exp and other child results documented.

Change log

2009-06-20  Chris Genly  <chris@genly.us>
       * doc/gdb.texinfo (GDB/MI Variable Objects): Document child
       definition in -var-list-children.  Added exp result for child.

Patch

Attached.

[-- Attachment #2: gdb.texinfo.patch --]
[-- Type: application/octet-stream, Size: 2604 bytes --]

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	20 Jun 2009 21:25:52 -0000
*************** Returns the format used to display the v
*** 23225,23230 ****
--- 23225,23231 ----
   -var-info-num-children @var{name}
  @end smallexample
  
+ 
  Returns the number of children of a variable object @var{name}:
  
  @smallexample
*************** values; and if it is 2 or @code{--simple
*** 23251,23266 ****
  value for simple data types and just the name for arrays, structures
  and unions.
  
  @subsubheading Example
  
  @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
  
--- 23252,23300 ----
  value for simple data types and just the name for arrays, structures
  and unions.
  
+ For each child the following results are returned:
+ 
+ @table @var
+ 
+ @item name
+ Name of the variable object created for this child.
+ 
+ @item exp
+ The expression to be shown to the user by the front end to designate this child.
+ For example this may be the name of a structure member.  
+ 
+ For C/C@t{++} structures there are several psuedo children returned to
+ designate access qualifiers.  For these pseudo children @var{exp} is
+ @samp{public}, @samp{private}, or @samp{protected}.  In this case the
+ type and value are not present.
+ 
+ @item numchild
+ Number of children this child has.
+ 
+ @item type
+ The type of the child.
+ 
+ @item value
+ If values were requested, this is the value.
+ 
+ @item thread-id
+ If this variable object is associated with a thread, this is the thread id.  
+ Otherwise this result is not present.
+ 
+ @item frozen
+ If the variable object is frozen, this variable will be present with a value of 1.
+ @end table
+ 
  @subsubheading Example
  
  @smallexample
  (gdb)
   -var-list-children n
!  ^done,numchild=@var{n},children=[child=@{name=@var{name},exp=@var{exp},
   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},exp=@var{exp},
   numchild=@var{n},value=@var{value},type=@var{type}@},@r{(repeats N times)}]
  @end smallexample