This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [python] [patch] set/show extended-prompt
> 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.