This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
gdb.texinfo patch for -var-list-children (2)
- From: Chris Genly <chgenly at gmail dot com>
- To: gdb-patches at sourceware dot org
- Date: Fri, 19 Jun 2009 21:11:07 -0700
- Subject: gdb.texinfo patch for -var-list-children (2)
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.
Sorry I didn't document this with the last patch. But my
understanding of MI commands is still increasing.
Change log
2009-06-19 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
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 04:07:54 -0000
*************** Returns the format used to display the v
*** 23224,23229 ****
--- 23224,23231 ----
@smallexample
-var-info-num-children @var{name}
@end smallexample
+ @anchor{-var-info-num-children}
+
Returns the number of children of a variable object @var{name}:
*************** Returns the number of children of a vari
*** 23242,23247 ****
--- 23244,23250 ----
@end smallexample
@anchor{-var-list-children}
+
Return a list of the children of the specified variable object and
create variable objects for them, if they do not already exist. With
a single argument or if @var{print-values} has a value for of 0 or
*************** 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
--- 23254,23290 ----
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++ 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}. No type need be provided.
+
+ @item numchild
+ Number of children this child has.
+ @item type
+ The type of the child.
+ @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