Mirror of the gdb mailing list
 help / color / mirror / Atom feed
From: Jim Blandy <jimb@red-bean.com>
To: Eli Zaretskii <eliz@gnu.org>, gdb@sources.redhat.com
Subject: Re: Formatting of packet descriptions in GDB manual
Date: Wed, 16 Nov 2005 05:47:00 -0000	[thread overview]
Message-ID: <8f2776cb0511152147i4c24e43aue46a54332fd4c0f3@mail.gmail.com> (raw)
In-Reply-To: <20051114134924.GB21373@nevyn.them.org>

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.

From texinfo.info:

9.1.2 `@code'{SAMPLE-CODE}
--------------------------

Use the `@code' command to indicate text that is a piece of a program
and which consists of entire syntactic tokens.  Enclose the text in
braces.

  Thus, you should use `@code' for an expression in a program, for the
name of a variable or function used in a program, or for a keyword in a
programming language.

  Use `@code' for command names in languages that resemble programming
languages, such as Texinfo.  For example, `@code' and `@samp' are
produced by writing `@code{@@code}' and `@code{@@samp}' in the Texinfo
source, respectively.

...

9.1.5 `@samp'{TEXT}
-------------------

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.
Enclose the text in braces.  The argument appears within single
quotation marks in both the Info file and the printed manual; in
addition, it is printed in a fixed-width font.


  reply	other threads:[~2005-11-16  5:47 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-11-12  0:25 Jim Blandy
2005-11-12  7:07 ` Eli Zaretskii
2005-11-12  8:47   ` Jim Blandy
2005-11-12 22:53     ` Eli Zaretskii
2005-11-12 23:07       ` Jim Blandy
2005-11-13 17:12       ` Daniel Jacobowitz
2005-11-13 22:10         ` Eli Zaretskii
2005-11-14  2:29           ` Daniel Jacobowitz
2005-11-14  4:29             ` Eli Zaretskii
2005-11-14 13:49               ` Daniel Jacobowitz
2005-11-16  5:47                 ` Jim Blandy [this message]
2005-11-16  6:54                   ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=8f2776cb0511152147i4c24e43aue46a54332fd4c0f3@mail.gmail.com \
    --to=jimb@red-bean.com \
    --cc=eliz@gnu.org \
    --cc=gdb@sources.redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox