From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 8099 invoked by alias); 9 Jun 2004 19:33:43 -0000 Mailing-List: contact gdb-help@sources.redhat.com; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-owner@sources.redhat.com Received: (qmail 8012 invoked from network); 9 Jun 2004 19:33:39 -0000 Received: from unknown (HELO aragorn.inter.net.il) (192.114.186.23) by sourceware.org with SMTP; 9 Jun 2004 19:33:39 -0000 Received: from zaretski ([80.230.152.119]) by aragorn.inter.net.il (MOS 3.4.6-GR) with ESMTP id DBB47431; Wed, 9 Jun 2004 21:06:11 +0300 (IDT) Date: Wed, 09 Jun 2004 19:33:00 -0000 From: "Eli Zaretskii" To: "Benjamin Mann (Jr)" Message-Id: <2719-Wed09Jun2004210324+0300-eliz@gnu.org> CC: gdb@sources.redhat.com In-reply-to: <85896742E37AAA47AA56CB578CB4173B062EFB02@tayexc18.americas.cpqcorp.net> (ben.mann@hp.com) Subject: Re: FW: [Gdb-discuss] Style Conventions for Documentation? Reply-to: Eli Zaretskii References: <85896742E37AAA47AA56CB578CB4173B062EFB02@tayexc18.americas.cpqcorp.net> X-SW-Source: 2004-06/txt/msg00078.txt.bz2 > Date: Wed, 9 Jun 2004 12:27:29 -0400 > From: "Mann, Benjamin (Jr)" > > Can you help me out? I am looking for style convention information used > in the GNU documentation, if such guidelines exist. For general guidelines, see the Texinfo manual and the standards.texi manual (be sure to find the latest version from the GNU FTP site). > Because there have been many contributors to the documentation (from > many companies and with different points of view), many styles are > implemented for similar items. For example, sometimes command > options are in single quotes, sometimes not. Could you please give a concrete example or two? I'm not sure I understand the context. > Or lead-ins to lists or code examples sometimes end with a colon, > sometimes with no punctuation, and sometimes with a period. This depends on the specifics of the text, but again, please provide an example. > As an editor I value consistency (among other things like clear > writing, conciseness, and so forth) Same here.