diff options
| -rw-r--r-- | gdb/doc/ChangeLog | 8 | ||||
| -rw-r--r-- | gdb/doc/python.texi | 13 |
2 files changed, 18 insertions, 3 deletions
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog index a4971ce..f8b958d 100644 --- a/gdb/doc/ChangeLog +++ b/gdb/doc/ChangeLog @@ -1,5 +1,13 @@ 2018-09-10 Tom Tromey <tom@tromey.com> + PR python/17752: + * python.texi (Frame Filter API): Remove period from subsection + title. Mention 100 as good default priority. + (Frame Decorator API): Remove period from subsection title. + Mention FrameDecorator module. + +2018-09-10 Tom Tromey <tom@tromey.com> + PR python/23108: * python.texi (Exception Handling): Rearrange gdb.GdbError text and add a table. diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index 59b6b3b..2b3c8a9 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -1625,7 +1625,7 @@ order to avoid holding information that could become stale as the inferior changed. @node Frame Filter API -@subsubsection Filtering Frames. +@subsubsection Filtering Frames @cindex frame filters api Frame filters are Python objects that manipulate the visibility of a @@ -1777,11 +1777,11 @@ frame filters. Although @code{priority} can be negative, it is recommended practice to assume zero is the lowest priority that a frame filter can be assigned. Frame filters that have the same priority are executed in unsorted order in that priority slot. This -attribute is mandatory. +attribute is mandatory. 100 is a good default priority. @end defvar @node Frame Decorator API -@subsubsection Decorating Frames. +@subsubsection Decorating Frames @cindex frame decorator api Frame decorators are sister objects to frame filters (@pxref{Frame @@ -1805,6 +1805,13 @@ boilerplate code to decorate the content of a @code{gdb.Frame}. It is recommended that other frame decorators inherit and extend this object, and only to override the methods needed. +@tindex gdb.FrameDecorator +@code{FrameDecorator} is defined in the Python module +@code{gdb.FrameDecorator}, so your code can import it like: +@smallexample +from gdb.FrameDecorator import FrameDecorator +@end smallexample + @defun FrameDecorator.elided (self) The @code{elided} method groups frames together in a hierarchical |