docs/160696: style(9) should be mentioned in the devs' handbook

Garrett Cooper yanegomi at
Fri Oct 14 05:58:39 UTC 2011

On Thu, Oct 13, 2011 at 9:13 PM, Warren Block <wblock at> 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:
>> %%%%%%%%%%
>> <para>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.

Saying something like "The &os; project has a number of established
procedures, one of which is a common coding style." may or may not be
better, as it's common practice for projects to have a style document
and this is more or less just serving as a pointer to that


More information about the freebsd-doc mailing list