From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 48894 invoked by alias); 8 Sep 2018 20:14:54 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 48777 invoked by uid 89); 8 Sep 2018 20:14:52 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-25.4 required=5.0 tests=AWL,BAYES_00,GIT_PATCH_0,GIT_PATCH_1,GIT_PATCH_2,GIT_PATCH_3,RCVD_IN_DNSWL_NONE,SPF_HELO_PASS autolearn=ham version=3.3.2 spammy=omissions, filters X-HELO: gateway33.websitewelcome.com Received: from gateway33.websitewelcome.com (HELO gateway33.websitewelcome.com) (192.185.145.87) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Sat, 08 Sep 2018 20:14:48 +0000 Received: from cm15.websitewelcome.com (cm15.websitewelcome.com [100.42.49.9]) by gateway33.websitewelcome.com (Postfix) with ESMTP id 78AFA228352 for ; Sat, 8 Sep 2018 15:14:47 -0500 (CDT) Received: from box5379.bluehost.com ([162.241.216.53]) by cmsmtp with SMTP id yjcef2f0pbXuJyjctfMGsf; Sat, 08 Sep 2018 15:14:46 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=tromey.com; s=default; h=References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From: Sender:Reply-To:MIME-Version:Content-Type:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=VXsdj8fb85DfDfbr3Mnp/JvOQqvHN01HAKGeQdFSfMM=; b=GXPBkQkkfAEYxiot1Xjkc+ncA2 fCTZkG+9NB7ozVcB5FmQ98sCHZmgs/2JYpp49wBha4or9NqxwxuRrI3zzMajTseDSUjidwSyzOGQL W7IVs4WgMGkkRE8iq19TdzM3p; Received: from 75-166-85-72.hlrn.qwest.net ([75.166.85.72]:47090 helo=bapiya.Home) by box5379.bluehost.com with esmtpsa (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.91) (envelope-from ) id 1fyjce-002ImX-Ia; Sat, 08 Sep 2018 15:14:24 -0500 From: Tom Tromey To: gdb-patches@sourceware.org Cc: Tom Tromey Subject: [PATCH 07/14] Update Python frame filter documentation Date: Sat, 08 Sep 2018 20:14:00 -0000 Message-Id: <20180908201417.13444-8-tom@tromey.com> In-Reply-To: <20180908201417.13444-1-tom@tromey.com> References: <20180908201417.13444-1-tom@tromey.com> X-SW-Source: 2018-09/txt/msg00169.txt.bz2 This fixes a few frame filter documentation omissions noted in PR python/17752. gdb/doc/ChangeLog 2018-09-08 Tom Tromey 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