diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog index d05b5a381a..fe7f33ba7b 100644 --- a/gdb/doc/ChangeLog +++ b/gdb/doc/ChangeLog @@ -1,3 +1,8 @@ +2019-05-10 Tom Tromey + + * python.texi (Pretty Printing API): Mention lazy computation for + "children". + 2019-05-10 Tom Tromey * gdb.texinfo (Set Catchpoints): Add text for parameter to "catch diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index b47c38deef..98e52bb770 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -1371,6 +1371,12 @@ object which is convertible to a @value{GDBN} value. This method is optional. If it does not exist, @value{GDBN} will act as though the value has no children. +For efficiency, the @code{children} method should lazily compute its +results. This will let @value{GDBN} read as few elements as +necessary, for example when various print settings (@pxref{Print +Settings}) or @code{-var-list-children} (@pxref{GDB/MI Variable +Objects}) limit the number of elements to be displayed. + Children may be hidden from display based on the value of @samp{set print max-depth} (@pxref{Print Settings}). @end defun