[Bug python/17752] New: frame filter documentation buglets

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=17752

Bug ID: 17752
Summary: frame filter documentation buglets
Product: gdb
Version: HEAD
Status: NEW
Severity: normal
Priority: P2
Component: python
Assignee: unassigned at sourceware dot org
Reporter: tromey at sourceware dot org

The python frame filter docs don't mention what
a good default value for "priority" might be.
The examples say 100, I suggest mentioning this
in the FrameFilter.priority docs.

The FrameDecorator docs don't mention that this class
must be imported from gdb.FrameDecorator.

gdb.FrameIterator doesn't seem to be documented at all.

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=17752

Tom Tromey <tromey at sourceware dot org> changed:

What |Removed |Added
----------------------------------------------------------------------------
Assignee|unassigned at sourceware dot org |tromey at sourceware dot org

--- Comment #1 from Tom Tromey <tromey at sourceware dot org> ---
Maybe FrameIterator is more of an internal thing.
I don't think it's needed when writing a frame filter.
I've fixed the other things though.

[cvs-commit at gcc dot gnu.org]

https://sourceware.org/bugzilla/show_bug.cgi?id=17752

--- Comment #2 from cvs-commit at gcc dot gnu.org <cvs-commit at gcc dot gnu.org> ---
The master branch has been updated by Tom Tromey <***@sourceware.org>:

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=521b499b963562793e5dbbcc1df8357cdf2757a7

commit 521b499b963562793e5dbbcc1df8357cdf2757a7
Author: Tom Tromey <***@tromey.com>
Date: Sat Sep 8 10:16:46 2018 -0600

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

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=17752

Tom Tromey <tromey at sourceware dot org> changed:

What |Removed |Added
----------------------------------------------------------------------------
Status|NEW |RESOLVED
Resolution|--- |FIXED
Target Milestone|--- |8.3

--- Comment #3 from Tom Tromey <tromey at sourceware dot org> ---
Fixed.