OpenE2K
/
binutils-gdb
12
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update Python frame filter documentation 

This fixes a few frame filter documentation omissions noted in
PR python/17752.

gdb/doc/ChangeLog
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.
This commit is contained in:
Tom Tromey 2018-09-08 10:16:46 -06:00
parent 4a5a194ae8
commit 521b499b96
2 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
gdb/doc/ChangeLog
View File

@ -1,3 +1,11 @@
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:

13
gdb/doc/python.texi
View File

@ -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