From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 6533 invoked by alias); 9 Jun 2004 16:27:33 -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 6504 invoked from network); 9 Jun 2004 16:27:30 -0000 Received: from unknown (HELO zmamail05.zma.compaq.com) (161.114.64.105) by sourceware.org with SMTP; 9 Jun 2004 16:27:30 -0000 Received: from tayexg11.americas.cpqcorp.net (tayexg11.americas.cpqcorp.net [16.103.130.96]) by zmamail05.zma.compaq.com (Postfix) with ESMTP id 94529345B for ; Wed, 9 Jun 2004 12:27:30 -0400 (EDT) Received: from tayexc18.americas.cpqcorp.net ([16.103.130.40]) by tayexg11.americas.cpqcorp.net with Microsoft SMTPSVC(6.0.3790.0); Wed, 9 Jun 2004 12:27:30 -0400 Content-class: urn:content-classes:message MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Subject: FW: [Gdb-discuss] Style Conventions for Documentation? Date: Wed, 09 Jun 2004 16:27:00 -0000 Message-ID: <85896742E37AAA47AA56CB578CB4173B062EFB02@tayexc18.americas.cpqcorp.net> X-MS-Has-Attach: X-MS-TNEF-Correlator: From: "Mann, Benjamin (Jr)" To: X-OriginalArrivalTime: 09 Jun 2004 16:27:30.0310 (UTC) FILETIME=[A8F9D260:01C44E3E] X-SW-Source: 2004-06/txt/msg00074.txt.bz2 Hello, Can you help me out? I am looking for style convention information used in the GNU documentation, if such guidelines exist.=20 Jim Blandy recommended I submit the query to you. If there's a better, more appropriate way to find the information I seek, please let me know. See my message (and Jim's reply) below. Thank you. *************************** Ben Mann, Jr. Hewlett-Packard Company 110 Spit Brook Road Nashua, NH 03062 e-mail: Ben.Mann@hp.com telephone: 603-884-3477 -----Original Message----- From: jimb@zenia.home [mailto:jimb@zenia.home] On Behalf Of Jim Blandy Sent: June 09, 2004 12:16 PM To: Mann, Benjamin (Jr) Cc: gdb-discuss@gnu.org Subject: Re: [Gdb-discuss] Style Conventions for Documentation? "Mann, Benjamin (Jr)" writes: > I am a technical editor who has been asked to review the HP WDB=20 > version of Debugging with GDB. Please forgive my ignorance of=20 > information that may be readily available; this is my first exposure=20 > to open source documentation. I have been unable to find any=20 > guidelines or reference information on your Web site about the=20 > preferred writing style and typographic conventions for GNU-related=20 > documentation. >=20 > Do you have, or know where I might find, a listing of typographic style > conventions that are recommended for use in the documentation? Because > there have been many contributors to the documentation (from many=20 > companies and with different points of view), many styles are=20 > implemented for similar items. For example, sometimes command options > are in single quotes, sometimes not. Or lead-ins to lists or code=20 > examples sometimes end with a colon, sometimes with no punctuation,=20 > and sometimes with a period. >=20 > As an editor I value consistency (among other things like clear=20 > writing, conciseness, and so forth), so I am looking for any guidance=20 > about writing style preferences you have or know of, if any. >=20 > Thank you for any direction you can provide. Probably the best place to post this question would be gdb@sources.redhat.com. Eli Zaretskii is our documentation maintainer; he's listed in gdb/MAINTAINERS.