From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-82980-listarch-gdb-patches=sources.redhat.com@sourceware.org>
Received: (qmail 8484 invoked by alias); 11 Aug 2011 18:22:38 -0000
Received: (qmail 8469 invoked by uid 22791); 11 Aug 2011 18:22:35 -0000
X-SWARE-Spam-Status: No, hits=-1.3 required=5.0	tests=AWL,BAYES_00,RCVD_IN_DNSWL_NONE,SPF_SOFTFAIL
X-Spam-Check-By: sourceware.org
Received: from mtaout21.012.net.il (HELO mtaout21.012.net.il) (80.179.55.169)    by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Thu, 11 Aug 2011 18:22:16 +0000
Received: from conversion-daemon.a-mtaout21.012.net.il by a-mtaout21.012.net.il (HyperSendmail v2007.08) id <0LPS0040001ADH00@a-mtaout21.012.net.il> for gdb-patches@sourceware.org; Thu, 11 Aug 2011 21:22:14 +0300 (IDT)
Received: from HOME-C4E4A596F7 ([84.228.94.185]) by a-mtaout21.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0LPS004TQ0D1B440@a-mtaout21.012.net.il>; Thu, 11 Aug 2011 21:22:14 +0300 (IDT)
Date: Thu, 11 Aug 2011 18:22:00 -0000
From: Eli Zaretskii <eliz@gnu.org>
Subject: Re: [python] [patch] set/show extended-prompt
In-reply-to: <m31uwrnat0.fsf@redhat.com>
To: pmuldoon@redhat.com
Cc: gdb-patches@sourceware.org
Reply-to: Eli Zaretskii <eliz@gnu.org>
Message-id: <83aabfyfjb.fsf@gnu.org>
References: <m3liv0yol6.fsf@redhat.com> <83d3gbyl5j.fsf@gnu.org> <m31uwrnat0.fsf@redhat.com>
X-IsSubscribed: yes
Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm
Precedence: bulk
List-Id: <gdb-patches.sourceware.org>
List-Subscribe: <mailto:gdb-patches-subscribe@sourceware.org>
List-Archive: <http://sourceware.org/ml/gdb-patches/>
List-Post: <mailto:gdb-patches@sourceware.org>
List-Help: <mailto:gdb-patches-help@sourceware.org>, <http://sourceware.org/ml/#faqs>
Sender: gdb-patches-owner@sourceware.org
X-SW-Source: 2011-08/txt/msg00240.txt.bz2

> From: Phil Muldoon <pmuldoon@redhat.com>
> Cc: gdb-patches@sourceware.org
> Date: Thu, 11 Aug 2011 17:59:55 +0100
> 
> >> +@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).

Just divide it into 2 lines, and if you want to make sure the reader
doesn't perceive the line break as significant, say something like
"this is one long line" in parentheses.

> Any suggestions on where to include the break?

It is not important, other than keeping each line shorter than 64
characters.

> >> +``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.

Texinfo mode only does the opposite: inserts ``..'' when you type
"..".

> When you mean literal quotes, do you mean just pasting in '"'?

Yes.