From owner-freebsd-doc@FreeBSD.ORG Sat Oct 15 23:22:16 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 282551065673 for ; Sat, 15 Oct 2011 23:22:16 +0000 (UTC) (envelope-from yanegomi@gmail.com) Received: from mail-gx0-f182.google.com (mail-gx0-f182.google.com [209.85.161.182]) by mx1.freebsd.org (Postfix) with ESMTP id D8A568FC08 for ; Sat, 15 Oct 2011 23:22:15 +0000 (UTC) Received: by ggeq3 with SMTP id q3so2710159gge.13 for ; Sat, 15 Oct 2011 16:22:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc:content-type:content-transfer-encoding; bh=8zY5++EOnXf9qPBNmQagpPkTDQS7xau7OBhYGodDxJY=; b=PDC4mVSOxCN54q52VObWGljIEJ0rxxhGPaYNsZ/htyDBjF7DXMk9CNgXLmm3wjbNQi 9pkXojaaTz2Zrbfh+CaRc23wlvPAXoyn8zXAoMu3U3HnIzhmZTmJVPao/3iADpIf16Ld DTiCrP+Cgdi6IKA6smYO+v4SHfni2g51pIG7Q= MIME-Version: 1.0 Received: by 10.182.187.100 with SMTP id fr4mr7818123obc.79.1318720935237; Sat, 15 Oct 2011 16:22:15 -0700 (PDT) Received: by 10.182.182.105 with HTTP; Sat, 15 Oct 2011 16:22:15 -0700 (PDT) In-Reply-To: References: <201110121030.p9CAUDxd032245@freefall.freebsd.org> Date: Sat, 15 Oct 2011 16:22:15 -0700 Message-ID: From: Garrett Cooper To: Benjamin Kaduk Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: quoted-printable Cc: Niclas Zeising , freebsd-doc@freebsd.org 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: Sat, 15 Oct 2011 23:22:16 -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 wrot= e: >>> >>> 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 writt= en >>>>>> in >>>>>> a more informal style than I would expect? =A0A more standard dry, >>>>>> technical >>>>>> writing version might be: >>>>>> %%%%%%%%%% >>>>>> When working in a large codebase such as the &os; source, it i= s >>>>>> important to adhere to a common coding style. =A0This provides >>>>>> uniformity >>>>> >>>>> =A0 =A0 =A0 =A0 =A0 =A0 =A0 ^^^^^^ >>>>> "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 >>> =A0large projects like &os;. =A0Code should follow the &os; coding styl= es >>> =A0described 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