Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Tom Tromey <tom@tromey.com>
To: gdb-patches@sourceware.org
Cc: Tom Tromey <tom@tromey.com>
Subject: [PATCH 07/14] Update Python frame filter documentation
Date: Sat, 08 Sep 2018 20:14:00 -0000	[thread overview]
Message-ID: <20180908201417.13444-8-tom@tromey.com> (raw)
In-Reply-To: <20180908201417.13444-1-tom@tromey.com>

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

gdb/doc/ChangeLog
2018-09-08  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.
---
 gdb/doc/ChangeLog   |  8 ++++++++
 gdb/doc/python.texi | 13 ++++++++++---
 2 files changed, 18 insertions(+), 3 deletions(-)

diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 59b6b3b72db..2b3c8a91fd6 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
-- 
2.13.6


  parent reply	other threads:[~2018-09-08 20:14 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-08 20:14 [PATCH 00/14] Many small Python documentation fixes Tom Tromey
2018-09-08 20:14 ` [PATCH 02/14] Fix typo in pretty-printer example Tom Tromey
2018-09-08 21:12   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 14/14] Remove periods from Python section titles Tom Tromey
2018-09-08 21:14   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 13/14] Swap two sentences in the Pretty Printing API node Tom Tromey
2018-09-08 21:11   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 10/14] Mention Python versions in the documentation Tom Tromey
2018-09-08 21:16   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 08/14] Fix gdb.events.inferior_call documentation Tom Tromey
2018-09-08 21:10   ` Eli Zaretskii
2018-09-08 20:14 ` Tom Tromey [this message]
2018-09-08 21:09   ` [PATCH 07/14] Update Python frame filter documentation Eli Zaretskii
2018-09-08 20:14 ` [PATCH 03/14] Document that Frame.block can throw Tom Tromey
2018-09-08 21:07   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 11/14] Small typo fix in Basic Python node Tom Tromey
2018-09-08 21:08   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 12/14] Mention virtual tables in Python dynamic_type documentation Tom Tromey
2018-09-08 21:13   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 06/14] Reword gdb.GdbError text Tom Tromey
2018-09-08 21:16   ` Eli Zaretskii
2018-09-08 20:14 ` [PATCH 04/14] Fix help text for "python" command Tom Tromey
2018-09-08 20:14 ` [PATCH 01/14] Update Python Block.end documentation Tom Tromey
2018-09-08 20:14 ` [PATCH 05/14] Avoid warnings from makeinfo Tom Tromey
2018-09-08 21:09   ` Eli Zaretskii
2018-09-08 20:22 ` [PATCH 09/14] Update Python unwinder documentation Tom Tromey
2018-09-08 21:18   ` Eli Zaretskii
2018-09-10 13:44 ` [PATCH 00/14] Many small Python documentation fixes Tom Tromey

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180908201417.13444-8-tom@tromey.com \
    --to=tom@tromey.com \
    --cc=gdb-patches@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox