From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 5537 invoked by alias); 16 Nov 2005 05:47:41 -0000 Received: (qmail 5526 invoked by uid 22791); 16 Nov 2005 05:47:39 -0000 Received: from zproxy.gmail.com (HELO zproxy.gmail.com) (64.233.162.197) by sourceware.org (qpsmtpd/0.30-dev) with ESMTP; Wed, 16 Nov 2005 05:47:39 +0000 Received: by zproxy.gmail.com with SMTP id l1so1997777nzf for ; Tue, 15 Nov 2005 21:47:37 -0800 (PST) Received: by 10.36.24.5 with SMTP id 5mr5939364nzx; Tue, 15 Nov 2005 21:47:37 -0800 (PST) Received: by 10.37.2.35 with HTTP; Tue, 15 Nov 2005 21:47:37 -0800 (PST) Message-ID: <8f2776cb0511152147i4c24e43aue46a54332fd4c0f3@mail.gmail.com> Date: Wed, 16 Nov 2005 05:47:00 -0000 From: Jim Blandy To: Eli Zaretskii , gdb@sources.redhat.com Subject: Re: Formatting of packet descriptions in GDB manual In-Reply-To: <20051114134924.GB21373@nevyn.them.org> MIME-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable Content-Disposition: inline References: <8f2776cb0511111624h4d646cd9i1f86824c5edc613f@mail.gmail.com> <8f2776cb0511120047y50b3a273pe17ddd5c53342be1@mail.gmail.com> <20051113171247.GA1945@nevyn.them.org> <20051114022955.GA10567@nevyn.them.org> <20051114134924.GB21373@nevyn.them.org> Mailing-List: contact gdb-help@sourceware.org; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-owner@sourceware.org X-SW-Source: 2005-11/txt/msg00313.txt.bz2 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.