From owner-svn-src-all@FreeBSD.ORG Thu May 28 05:24:39 2009 Return-Path: Delivered-To: svn-src-all@FreeBSD.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 8DFE8106566B; Thu, 28 May 2009 05:24:39 +0000 (UTC) (envelope-from kaduk@MIT.EDU) Received: from biscayne-one-station.mit.edu (BISCAYNE-ONE-STATION.MIT.EDU [18.7.7.80]) by mx1.freebsd.org (Postfix) with ESMTP id 422338FC13; Thu, 28 May 2009 05:24:38 +0000 (UTC) (envelope-from kaduk@MIT.EDU) Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103]) by biscayne-one-station.mit.edu (8.13.6/8.9.2) with ESMTP id n4S5BIUY007784; Thu, 28 May 2009 01:11:18 -0400 (EDT) Received: from multics.mit.edu (MULTICS.MIT.EDU [18.187.1.73]) (authenticated bits=56) (User authenticated as kaduk@ATHENA.MIT.EDU) by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id n4S5BGam015887 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NOT); Thu, 28 May 2009 01:11:17 -0400 (EDT) Received: (from kaduk@localhost) by multics.mit.edu (8.12.9.20060308) id n4S5BFn5022310; Thu, 28 May 2009 01:11:15 -0400 (EDT) Date: Thu, 28 May 2009 01:11:15 -0400 (EDT) From: Benjamin Kaduk To: Zachary Loafman In-Reply-To: <20090528014726.GG3704@isilon.com> Message-ID: References: <200905271636.n4RGasNe003922@svn.freebsd.org> <47d0403c0905271005t7f57f9b9h3d0721bbb1fbedc2@mail.gmail.com> <20090528014726.GG3704@isilon.com> User-Agent: Alpine 1.10 (GSO 962 2008-03-14) MIME-Version: 1.0 Content-Type: TEXT/PLAIN; format=flowed; charset=US-ASCII X-Scanned-By: MIMEDefang 2.42 X-Spam-Flag: NO X-Spam-Score: 0.00 Cc: svn-src-head@FreeBSD.org, svn-src-all@FreeBSD.org, src-committers@FreeBSD.org, dfr@FreeBSD.org, Ben Kaduk Subject: Re: Review: fail(9) style/grammar (was Re: svn commit: r192908 ...) X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 28 May 2009 05:24:40 -0000 On Wed, 27 May 2009, Zachary Loafman wrote: > On Wed, May 27, 2009 at 10:05:44AM -0700, Ben Kaduk wrote: >> Our man page style says that new sentences should start on new lines. >> (Since the '.' character is used for defining macros, and sometimes >> the processor can get confused.) > > Ben - > > Thanks for the pedantry! I've attached a patch that should address your > issues. (Doug, please review as mentor when you get a chance.) Thanks! > > This is my first man page, so I apologize for the style violations. I > fixed all the new sentence instances I could find, but I left the "e.g." > and "i.e." instances untouched. That seems like it would suffer from the > same issue, but I left them alone for now. > > Is there a style(9) equivalent for man pages? I hunted for a bit, but > "man -k style" returned only style(9) and style.Makefile(9). I think that probably the closest thing would be groff_mdoc(9), but that's not exactly a style guide ... I think most of it ends up just being picked up gradually, so don't feel too bad about missing a few things here and there. Things are a bit hazy in my memory, but I think that the new sentence-->new line may also relate to having two spaces between sentences -- I think that (e.g.) "e.g." should be okay. The patch in your later message looks good. Thanks! -Ben Kaduk