This is the mail archive of the
gdb@sourceware.org
mailing list for the GDB project.
Re: Formatting of packet descriptions in GDB manual
> Date: Tue, 15 Nov 2005 21:47:37 -0800
> From: Jim Blandy <jimb@red-bean.com>
>
> Now that we've eliminated the brief summaries from the packets' @item
> lines, I'd like to suggest using @samp for packet contents, instead of
> @code. I think this is more consistent with their general use in
> Texinfo, and it looks okay in print and on-line. But it's arguable;
> what do folks think? Aesthetically, I appreciate having the quotes
> around the packet contents when they're mixed in with the text.
@code and @samp produce identical results in the Info manual. In
print and in PDF, @samp uses the same typeface as @code, but it also
encloses the text in single parens.
> Use the `@samp' command to indicate text that is a literal example or
> `sample' of a sequence of characters in a file, string, pattern, etc.
For this reason, it's probably a good idea to use @samp.