From owner-freebsd-doc@FreeBSD.ORG Wed Oct 12 10:30:13 2011 Return-Path: Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id A17FD106566B for ; Wed, 12 Oct 2011 10:30:13 +0000 (UTC) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id 86A128FC0C for ; Wed, 12 Oct 2011 10:30:13 +0000 (UTC) Received: from freefall.freebsd.org (localhost [127.0.0.1]) by freefall.freebsd.org (8.14.4/8.14.4) with ESMTP id p9CAUDbp032248 for ; Wed, 12 Oct 2011 10:30:13 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.14.4/8.14.4/Submit) id p9CAUDxd032245; Wed, 12 Oct 2011 10:30:13 GMT (envelope-from gnats) Date: Wed, 12 Oct 2011 10:30:13 GMT Message-Id: <201110121030.p9CAUDxd032245@freefall.freebsd.org> To: freebsd-doc@FreeBSD.org From: Niclas Zeising Cc: 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 Reply-To: Niclas Zeising List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 12 Oct 2011 10:30:13 -0000 The following reply was made to PR docs/160696; it has been noted by GNATS. From: Niclas Zeising To: bug-followup@FreeBSD.org, radiomlodychbandytow@o2.pl Cc: Subject: Re: docs/160696: style(9) should be mentioned in the devs' handbook Date: Wed, 12 Oct 2011 12:29:19 +0200 This is a multi-part message in MIME format. --------------090008080408060608000208 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Hi! Here is a patch that adds a section to the source tree guidelines and policies chapter of the developer's handbook about code style, with links to relevant manual pages. It has not been build tested yet, since I'm away from my build environment. -- Niclas Zeising --------------090008080408060608000208 Content-Type: text/plain; name="doc.developers-handbook.policies.chapter.sgml.diff" Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename="doc.developers-handbook.policies.chapter.sgml.diff" Index: en_US.ISO8859-1/books/developers-handbook/policies/chapter.sgml =================================================================== RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/developers-handbook/policies/chapter.sgml,v retrieving revision 1.37 diff -u -d -r1.37 chapter.sgml --- en_US.ISO8859-1/books/developers-handbook/policies/chapter.sgml 7 May 2010 06:33:09 -0000 1.37 +++ en_US.ISO8859-1/books/developers-handbook/policies/chapter.sgml 12 Oct 2011 10:22:12 -0000 @@ -24,6 +24,19 @@ This chapter documents various guidelines and policies in force for the FreeBSD source tree. + + + Style Guidlines + style + + In a big programming project like the &os; project, it is important + that everybody involved adheres to the same coding style. This ensures + that all code looks consistent, and will improve the ability for people + in the project to read and understand the source. In &os; there are + two manual pages describing the code style to adhere to. These are + &man.style.9; and &man.style.Makefile.5;, for c code and make files, + respectively. + <makevar>MAINTAINER</makevar> on Makefiles Index: share/sgml/man-refs.ent =================================================================== RCS file: /home/ncvs/doc/share/sgml/man-refs.ent,v retrieving revision 1.513 diff -u -d -r1.513 man-refs.ent --- share/sgml/man-refs.ent 25 Aug 2011 20:27:19 -0000 1.513 +++ share/sgml/man-refs.ent 12 Oct 2011 10:23:24 -0000 @@ -5239,6 +5239,7 @@ + --------------090008080408060608000208--