From patchwork Thu Sep 13 02:36:27 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Marchi X-Patchwork-Id: 29356 Received: (qmail 34214 invoked by alias); 13 Sep 2018 02:37:03 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 34036 invoked by uid 89); 13 Sep 2018 02:37:02 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-26.4 required=5.0 tests=AWL, BAYES_00, GIT_PATCH_0, GIT_PATCH_1, GIT_PATCH_2, GIT_PATCH_3, SPF_PASS autolearn=ham version=3.3.2 spammy= X-HELO: sesbmg22.ericsson.net Received: from sesbmg22.ericsson.net (HELO sesbmg22.ericsson.net) (193.180.251.48) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Thu, 13 Sep 2018 02:37:00 +0000 DKIM-Signature: v=1; a=rsa-sha256; d=ericsson.com; s=mailgw201801; c=relaxed/simple; q=dns/txt; i=@ericsson.com; t=1536806218; h=From:Sender:Reply-To:Subject:Date:Message-Id:To:CC:MIME-Version:Content-Type: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=k5fGKLjEdsJXwmmYYQxPtMRdgaVNS/9KMQez+02WZYY=; b=O5cfd9oHqaFZe72v22dpC8eqlVQpcaIyOJW6sBAUjsJRXJ59/m2ZsR5PF7LKkZQB UkbnzB9SeVz+XeL3p8IMDsNNpo76r8G9ylW9l7I5bTbqOr3E5GCPEC2T8biRvoVa p1X7hlKKgll+whCqOPfwN8bdZeM23ycSXbfaYUWcbWI=; Received: from ESESSMB502.ericsson.se (Unknown_Domain [153.88.183.120]) by sesbmg22.ericsson.net (Symantec Mail Security) with SMTP id 0A.34.21978.A4DC99B5; Thu, 13 Sep 2018 04:36:58 +0200 (CEST) Received: from ESESSMB501.ericsson.se (153.88.183.162) by ESESSMB502.ericsson.se (153.88.183.163) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1466.3; Thu, 13 Sep 2018 04:36:58 +0200 Received: from NAM01-BY2-obe.outbound.protection.outlook.com (153.88.183.157) by ESESSMB501.ericsson.se (153.88.183.162) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1466.3 via Frontend Transport; Thu, 13 Sep 2018 04:36:58 +0200 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ericsson.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=uRangXvkdInWNU9EGc8UoGaS9JOWUM/fCcBXUQ6YQ9Y=; b=hlbLJpd7sshmICU6RplpZ+ix/6zKijnsch3AhIboNrADL6lfNVIsTCTKLXkI9QxwLNI3cX4jEuLtH1o/epR3/dsG9CZNXj3FZManAqKD7S2sDI4rjS/1HJ2fGOAkGjkfJy3PDeOA9x2R9mxwcfPR9FmKdvFhNmT+69br0Gg/Qhs= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=simon.marchi@ericsson.com; Received: from elxacz23q12.ericsson.se (192.176.1.81) by BN7PR15MB2385.namprd15.prod.outlook.com (2603:10b6:406:8c::23) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1122.17; Thu, 13 Sep 2018 02:36:55 +0000 From: Simon Marchi To: CC: Simon Marchi Subject: [PATCH v2 3/3] python: Fix erroneous doc about gdb.objfiles() Date: Wed, 12 Sep 2018 22:36:27 -0400 Message-Id: <20180913023627.18855-3-simon.marchi@ericsson.com> In-Reply-To: <20180913023627.18855-1-simon.marchi@ericsson.com> References: <20180913023627.18855-1-simon.marchi@ericsson.com> MIME-Version: 1.0 Return-Path: simon.marchi@ericsson.com Received-SPF: None (protection.outlook.com: ericsson.com does not designate permitted sender hosts) X-IsSubscribed: yes New in v2: updated the text. The code implementing gdb.objfiles() returns a list of objfiles for the current program space (the program space of the selected inferior). The documentation for the gdb.objfiles() Python method, however, states: Return a sequence of all the objfiles current known to GDB. That sounds wrong to me. I tried to phrase to be more precise. gdb/doc/ChangeLog: * python.texi (Objfiles In Python): Update gdb.objfiles() doc. --- gdb/doc/python.texi | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi index 6b3b598039d..9c7d26b133b 100644 --- a/gdb/doc/python.texi +++ b/gdb/doc/python.texi @@ -4112,10 +4112,10 @@ this function returns @code{None}. @findex gdb.objfiles @defun gdb.objfiles () -Return a sequence of all the objfiles current known to @value{GDBN}. -@xref{Objfiles In Python}. This is identical to -@code{gdb.selected_inferior().progspace.objfiles()} (@pxref{Progspaces In -Python}) and is included for historical compatibility. +Return a sequence of objfiles referenced by the current program space. +@xref{Objfiles In Python} and @ref{Progspaces In Python}. This is identical +to @code{gdb.selected_inferior().progspace.objfiles()} and is included for +historical compatibility. @end defun @findex gdb.lookup_objfile