From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 996 invoked by alias); 5 Jan 2009 21:01:10 -0000 Received: (qmail 908 invoked by uid 22791); 5 Jan 2009 21:01:10 -0000 X-SWARE-Spam-Status: No, hits=-1.8 required=5.0 tests=AWL,BAYES_00,J_CHICKENPOX_37,KAM_MX,SPF_HELO_PASS,SPF_PASS X-Spam-Check-By: sourceware.org Received: from mx2.redhat.com (HELO mx2.redhat.com) (66.187.237.31) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Mon, 05 Jan 2009 21:01:04 +0000 Received: from int-mx2.corp.redhat.com (int-mx2.corp.redhat.com [172.16.27.26]) by mx2.redhat.com (8.13.8/8.13.8) with ESMTP id n05L0u2Z013702; Mon, 5 Jan 2009 16:00:56 -0500 Received: from ns3.rdu.redhat.com (ns3.rdu.redhat.com [10.11.255.199]) by int-mx2.corp.redhat.com (8.13.1/8.13.1) with ESMTP id n05L0u6A007332; Mon, 5 Jan 2009 16:00:56 -0500 Received: from opsy.redhat.com (vpn-12-83.rdu.redhat.com [10.11.12.83]) by ns3.rdu.redhat.com (8.13.8/8.13.8) with ESMTP id n05L0tWE019802; Mon, 5 Jan 2009 16:00:55 -0500 Received: by opsy.redhat.com (Postfix, from userid 500) id 5EC1F50801F; Mon, 5 Jan 2009 14:00:53 -0700 (MST) To: Thiago Jung Bauermann Cc: Eli Zaretskii , gdb-patches@sourceware.org Subject: Re: [RFC][python] Fixes and improvements to gdb.Value. References: <1230949500.8380.140.camel@localhost.localdomain> <1231024147.8380.166.camel@localhost.localdomain> From: Tom Tromey Reply-To: tromey@redhat.com Date: Mon, 05 Jan 2009 21:01:00 -0000 In-Reply-To: <1231024147.8380.166.camel@localhost.localdomain> (Thiago Jung Bauermann's message of "Sat\, 03 Jan 2009 21\:09\:07 -0200") Message-ID: User-Agent: Gnus/5.11 (Gnus v5.11) Emacs/22.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii 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 X-SW-Source: 2009-01/txt/msg00032.txt.bz2 >>>>> "Thiago" == Thiago Jung Bauermann writes: >> > +@findex gdb.history >> >> The text below this does not mention "gdb.history" at all. Should it? >> I could imagine a reader who gets here by following the "gdb.history" >> index entry, and is then puzzled by not finding that text anywhere. Thiago> Well, the text is in the section which describes functions in the gdb Thiago> module, so the reader should be aware that the function is inside it. Thiago> Also, in Python "gdb.history" wouldn't be the only possible way of Thiago> referencing the function. If the user imports the gdb module with Thiago> "from gdb import *", then he would just need to type "history" to use Thiago> it. "gdb.history" is only special in that from the CLI, the gdb module Thiago> is automatically imported and would be accessible to the user spelled Thiago> like that. But (s)he could type "python from gdb import *" and then use Thiago> the other way to access it. Thiago> In a nutshell, my answer is "no, I don't think it should". :-) I agree. Note that the existing Python docs in the manual already use this approach. This patch merely continues it. My reason for adding these index entries is that a Python programmer might reasonably expect to find the fully-qualified function name in the manual's index. However, it is strange to constantly see the fully-qualified name in the documentation text. So, I used the short form in the text and added index entries. Thiago -- I know it is kind of a pain, but would you mind putting any changes you make back onto the Python branch? Or if you can't do it, let me know and I will try to. I'd like to keep the branch "canonical" so that we can diff against mainline to see what Python bits ought to be merged. Tom