Date: Wed, 12 Oct 2011 12:10:13 GMT From: Niclas Zeising <niclas.zeising@gmail.com> To: freebsd-doc@FreeBSD.org Subject: Re: docs/160696: style(9) should be mentioned in the devs' handbook Message-ID: <201110121210.p9CCADuq030225@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
The following reply was made to PR docs/160696; it has been noted by GNATS. From: Niclas Zeising <niclas.zeising@gmail.com> 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 14:07:09 +0200 This is a multi-part message in MIME format. --------------050804040700070501000005 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit Hi! Here is an updated patch based on comments from Glen Barber. Regards! -- Niclas Zeising --------------050804040700070501000005 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 12:01:40 -0000 @@ -24,6 +24,19 @@ <para>This chapter documents various guidelines and policies in force for the FreeBSD source tree.</para> + + <sect1 id="policies-style"> + <title>Style Guidlines</title> + <indeterm><primary>style</primary></indexterm> + + <para>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 code. In &os; there + are two manual pages describing the code style to which to adhere. These + are &man.style.9; and &man.style.Makefile.5;, for c code and Makefiles, + respectively.</para> + </sect1> <sect1 id="policies-maintainer"> <title><makevar>MAINTAINER</makevar> on Makefiles</title> 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 12:02:49 -0000 @@ -4047,6 +4047,7 @@ <!ENTITY man.ssh.config.5 "<citerefentry/<refentrytitle/ssh_config/<manvolnum/5//"> <!ENTITY man.sshd.config.5 "<citerefentry/<refentrytitle/sshd_config/<manvolnum/5//"> <!ENTITY man.stab.5 "<citerefentry/<refentrytitle/stab/<manvolnum/5//"> +<!ENTITY man.style.Makefile.5 "<citerefentry/<refentrytitle/style_Makefile/<manvolnum/5//"> <!ENTITY man.sysctl.conf.5 "<citerefentry/<refentrytitle/sysctl.conf/<manvolnum/5//"> <!ENTITY man.syslog.conf.5 "<citerefentry/<refentrytitle/syslog.conf/<manvolnum/5//"> <!ENTITY man.tacplus.conf.5 "<citerefentry/<refentrytitle/tacplus.conf/<manvolnum/5//"> --------------050804040700070501000005--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201110121210.p9CCADuq030225>