From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 31404 invoked by alias); 11 Aug 2011 18:01:09 -0000 Received: (qmail 31395 invoked by uid 22791); 11 Aug 2011 18:01:08 -0000 X-SWARE-Spam-Status: No, hits=-6.8 required=5.0 tests=AWL,BAYES_00,RCVD_IN_DNSWL_HI,RP_MATCHES_RCVD,SPF_HELO_PASS X-Spam-Check-By: sourceware.org Received: from mx1.redhat.com (HELO mx1.redhat.com) (209.132.183.28) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Thu, 11 Aug 2011 18:00:50 +0000 Received: from int-mx09.intmail.prod.int.phx2.redhat.com (int-mx09.intmail.prod.int.phx2.redhat.com [10.5.11.22]) by mx1.redhat.com (8.14.4/8.14.4) with ESMTP id p7BI0coR003840 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Thu, 11 Aug 2011 14:00:48 -0400 Received: from localhost.localdomain (ovpn01.gateway.prod.ext.phx2.redhat.com [10.5.9.1]) by int-mx09.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id p7BGxtnx027198; Thu, 11 Aug 2011 12:59:56 -0400 From: Phil Muldoon To: Eli Zaretskii Cc: gdb-patches@sourceware.org Subject: Re: [python] [patch] set/show extended-prompt References: <83d3gbyl5j.fsf@gnu.org> Reply-to: pmuldoon@redhat.com X-URL: http://www.redhat.com Date: Thu, 11 Aug 2011 18:01:00 -0000 In-Reply-To: <83d3gbyl5j.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 11 Aug 2011 19:20:56 +0300") Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/23.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-IsSubscribed: yes 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: 2011-08/txt/msg00239.txt.bz2 Eli Zaretskii writes: >> From: Phil Muldoon >> Date: Thu, 11 Aug 2011 16:06:45 +0100 >> >> >> This patch adds extended-prompt capabilities to GDB. In addition it >> adds a prompt substitution library. I made the extended-prompt lazily >> control the prompt_hook on setting, over controlling it unconditionally. The >> rest of the function remains the same other than in-Python documentation >> as was found in Archer. > > Thanks, I have a few comments about the documentation part: > >> +@xref{gdb.prompt} for a list of the flags that can be used for ^ > If you run "make info", it will complain here, because you need to add > a comma after the right brace. I normally run 'make info', but my preferred method of proof-reading is to generate a PDF with 'make pdf'. This time it looks like I forgot to sanity check with 'make info', apologies for that. BTW, it does not error with 'make pdf', but good point, will adjust. >> + The prompt is updated with the value of the >> +flags each time it is displayed. > > Is "flags" a good term? I think "escape sequence" is better, e.g.: > > Any escape sequences specified as part of the prompt string are > replaced with the corresponding strings each time the prompt is > displayed. One of the flags is a specific escape (/e), so I worried about collision with that term. That is why ended up using flags. I'm have no strong opinions on terminology here, so I will go with what your suggest. >> +@smallexample >> +substitute_prompt (``frame: \f, print arguments: \p@{print frame-arguments@}'') >> +@end smallexample > > The line inside @example should be broken into two, as it is too long. I'm never sure how to break up function examples like these for the documentation (other than making a smaller example). Any suggestions on where to include the break? >> +@smallexample >> +``frame: main, print arguments: scalars'' >> +@end smallexample > > Aren't these ``..'' quotes left verbatim in the printed version of the > manual? I think you need literal ".." quotes here, since they are not > converted inside @smallexample. Yes, you are right. I relied on the emacs Texinfo major mode to do the right thing here, but I guess it does not in the context of @smallexample. When you mean literal quotes, do you mean just pasting in '"'? Cheers, Phil