Date: Fri, 14 Oct 2011 00:02:22 -0700 From: Garrett Cooper <yanegomi@gmail.com> To: Warren Block <wblock@wonkity.com> Cc: Niclas Zeising <niclas.zeising@gmail.com>, freebsd-doc@freebsd.org Subject: Re: docs/160696: style(9) should be mentioned in the devs' handbook Message-ID: <CAGH67wT3W0piFjX328ensJiUrvw2tVK5ufMtSF90of97wwhs7w@mail.gmail.com> In-Reply-To: <alpine.BSF.2.00.1110140007150.51585@wonkity.com> References: <201110121030.p9CAUDxd032245@freefall.freebsd.org> <alpine.GSO.1.10.1110132355240.882@multics.mit.edu> <alpine.BSF.2.00.1110132212210.51180@wonkity.com> <CAGH67wQBtWPYKMURtd0mp4HnZC3gn3pg2GHu0wK%2BZjg-DtL5-Q@mail.gmail.com> <alpine.BSF.2.00.1110140007150.51585@wonkity.com>
next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, Oct 13, 2011 at 11:37 PM, Warren Block <wblock@wonkity.com> wrote: > On Thu, 13 Oct 2011, Garrett Cooper wrote: > >> On Thu, Oct 13, 2011 at 9:13 PM, Warren Block <wblock@wonkity.com> 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? =A0A more standard dry, >>>> technical >>>> writing version might be: >>>> %%%%%%%%%% >>>> <para>When working in a large codebase such as the &os; source, it is >>>> important to adhere to a common coding style. =A0This provides uniform= ity >>> >>> =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: > > <para>Consistent coding style is extremely important, particularly with > =A0large projects like &os;. =A0Code should follow the &os; coding styles > =A0described in &man.style.9;, and &man.style.Makefile.5;.</para> Sounds ok. > As an alternate: > > <para>We know you've developed some fancy coding style of your own. =A0So > =A0has everybody else. =A0Hundreds of people, maybe even thousands, have > =A0contributed to &os;, and mixing all those different styles results in > =A0a mess. =A0So we're sorry, but do it as shown in &man.style.9; =A0and > =A0&man.style.Makefile.5; if you want your code to be accepted.</para> :].
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAGH67wT3W0piFjX328ensJiUrvw2tVK5ufMtSF90of97wwhs7w>