From owner-freebsd-doc@FreeBSD.ORG Sun Oct 16 11:13:02 2011 Return-Path: Delivered-To: freebsd-doc@FreeBSD.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 32929106564A for ; Sun, 16 Oct 2011 11:13:02 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxout1.bln1.prohost.de (mxout1.bln1.prohost.de [213.160.84.47]) by mx1.freebsd.org (Postfix) with ESMTP id 9BC0F8FC08 for ; Sun, 16 Oct 2011 11:13:01 +0000 (UTC) Received: from mx1bln1.prossl.de (localhost.localdomain [127.0.0.1]) by localhost.localdomain (8.14.1/8.14.1) with ESMTP id p9GB29RI001678; Sun, 16 Oct 2011 13:02:09 +0200 Received: from 79.199.42.180 (SquirrelMail authenticated user benedict) by mx1bln1.prossl.de with HTTP; Sun, 16 Oct 2011 13:02:09 +0200 (CEST) Message-ID: <61046.79.199.42.180.1318762929.squirrel@mx1bln1.prossl.de> In-Reply-To: References: <201110121030.p9CAUDxd032245@freefall.freebsd.org> Date: Sun, 16 Oct 2011 13:02:09 +0200 (CEST) From: "Benedict Reuschling" To: "Garrett Cooper" User-Agent: SquirrelMail/1.4.13 MIME-Version: 1.0 Content-Type: text/plain;charset=iso-8859-1 Content-Transfer-Encoding: 8bit X-Priority: 3 (Normal) Importance: Normal X-Null-Tag: 2240acf00c09c67e6daf6b565241aed4 Cc: freebsd-doc@FreeBSD.org, Niclas Zeising Subject: Re: docs/160696: style(9) should be mentioned in the devs' handbook X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 16 Oct 2011 11:13:02 -0000 > On Sat, Oct 15, 2011 at 3:53 PM, Benjamin Kaduk wrote: >> On Fri, 14 Oct 2011, Garrett Cooper wrote: >> >>> On Thu, Oct 13, 2011 at 11:37 PM, Warren Block >>> wrote: >>>> >>>> On Thu, 13 Oct 2011, Garrett Cooper wrote: >>>> >>>>> On Thu, Oct 13, 2011 at 9:13 PM, Warren Block >>>>> wrote: >>>>>> >>>>>> On Fri, 14 Oct 2011, Benjamin Kaduk wrote: >>>>>> >>>>>>> The overall paragraph feels a bit odd, though; maybe like it's >>>>>>> written >>>>>>> in >>>>>>> a more informal style than I would expect?  A more standard dry, >>>>>>> technical >>>>>>> writing version might be: >>>>>>> %%%%%%%%%% >>>>>>> When working in a large codebase such as the &os; source, it >>>>>>> is >>>>>>> important to adhere to a common coding style.  This provides >>>>>>> uniformity >>>>>> >>>>>>               ^^^^^^ >>>>>> "conform" might be better here. >>>>> >>>>> I'm usually not touchy feely about wording like this, but unless the >>>>> rest of the document is worded in such a standoffish / cold manner, I >>>>> would just keep things polite and neutral. "Conform" sounds really >>>>> pushy and "When working in a..." sounds condescending in my opinion. >>>> >>>> Here's a rewrite: >>>> >>>> Consistent coding style is extremely important, particularly >>>> with >>>>  large projects like &os;.  Code should follow the &os; coding styles >>>>  described in &man.style.9;, and &man.style.Makefile.5;. >>> >>> Sounds ok. >> >> No arguments, here. >> (Well, except for Garrett's mailer's mangling of the whitespace ...) > > I think we can all agree that Gmail is pretty braindead when used from > the web interface.. > -Garrett ;-) It is. Can one of you post the latest patch with the corrections (whitespace, wording, etc.) you discussed to the GNATS audit trail of this PR, so I can commit it? Thanks! Regards Benedict