Date: Wed, 12 Oct 2011 10:30: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: <201110121030.p9CAUDxd032245@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 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 @@
<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. 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.</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 10:23:24 -0000
@@ -5239,6 +5239,7 @@
<!ENTITY man.stack.9 "<citerefentry/<refentrytitle/stack/<manvolnum/9//">
<!ENTITY man.store.9 "<citerefentry/<refentrytitle/store/<manvolnum/9//">
<!ENTITY man.style.9 "<citerefentry/<refentrytitle/style/<manvolnum/9//">
+<!ENTITY man.style.Makefile.5 "<citerefentry/<refentrytitle/style_Makefile/<manvolnum/5//">
<!ENTITY man.subyte.9 "<citerefentry/<refentrytitle/subyte/<manvolnum/9//">
<!ENTITY man.suser.9 "<citerefentry/<refentrytitle/suser/<manvolnum/9//">
<!ENTITY man.suser.cred.9 "<citerefentry/<refentrytitle/suser_cred/<manvolnum/9//">
--------------090008080408060608000208--
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201110121030.p9CAUDxd032245>