From nobody@FreeBSD.org  Tue Sep 13 07:18:36 2011
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 195A7106566C
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 13 Sep 2011 07:18:36 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from red.freebsd.org (red.freebsd.org [IPv6:2001:4f8:fff6::22])
	by mx1.freebsd.org (Postfix) with ESMTP id E3E778FC0A
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 13 Sep 2011 07:18:35 +0000 (UTC)
Received: from red.freebsd.org (localhost [127.0.0.1])
	by red.freebsd.org (8.14.4/8.14.4) with ESMTP id p8D7IZKn029910
	for <freebsd-gnats-submit@FreeBSD.org>; Tue, 13 Sep 2011 07:18:35 GMT
	(envelope-from nobody@red.freebsd.org)
Received: (from nobody@localhost)
	by red.freebsd.org (8.14.4/8.14.4/Submit) id p8D7IZOC029909;
	Tue, 13 Sep 2011 07:18:35 GMT
	(envelope-from nobody)
Message-Id: <201109130718.p8D7IZOC029909@red.freebsd.org>
Date: Tue, 13 Sep 2011 07:18:35 GMT
From: "Radio M&#322;odych Bandytw" <radiomlodychbandytow@o2.pl>
To: freebsd-gnats-submit@FreeBSD.org
Subject: style(9) should be mentioned in the devs' handbook
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         160696
>Category:       docs
>Synopsis:       style(9) should be mentioned in the devs' handbook
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    bcr
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Sep 13 07:20:05 UTC 2011
>Closed-Date:    Mon Oct 17 18:28:14 UTC 2011
>Last-Modified:  Mon Oct 17 18:28:14 UTC 2011
>Originator:     Radio M&#322;odych Bandytw
>Release:        
>Organization:
>Environment:
>Description:
Handbook in question:
http://www.freebsd.org/doc/en_US.ISO8859-1/books/developers-handbook/index.html

style(9) ( http://www.freebsd.org/cgi/man.cgi?query=style ) is an important tool for FreeBSD development and should be mentioned in I.5. Source Tree Guidelines and Policies and probably somewhere in III. Kernel too.
>How-To-Repeat:

>Fix:


>Release-Note:
>Audit-Trail:

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&#39; 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--

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&#39; 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--
Responsible-Changed-From-To: freebsd-doc->bcr 
Responsible-Changed-By: bcr 
Responsible-Changed-When: Wed Oct 12 12:29:58 UTC 2011 
Responsible-Changed-Why:  
I'll take this one. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=160696 

From: Warren Block <wblock@wonkity.com>
To: bug-followup@FreeBSD.org, radiomlodychbandytow@o2.pl
Cc: Benedict Reuschling <bcr@FreeBSD.org>
Subject: Re: docs/160696: style(9) should be mentioned in the devs&#39;
 handbook
Date: Sun, 16 Oct 2011 22:41:35 -0600 (MDT)

   This message is in MIME format.  The first part should be readable text,
   while the remaining parts are likely unreadable without MIME-aware tools.
 
 --234685094-839292105-1318826495=:320
 Content-Type: TEXT/PLAIN; format=flowed; charset=US-ASCII
 
 Updated patch as discussed on freebsd-doc.  Some spelling fixes to the 
 original, along with the rewritten paragraph.
 --234685094-839292105-1318826495=:320
 Content-Type: TEXT/PLAIN; charset=US-ASCII; name=patch-devhandbook.diff.txt
 Content-Transfer-Encoding: BASE64
 Content-ID: <alpine.BSF.2.00.1110162241350.320@lightning.wonkity.com>
 Content-Description: 
 Content-Disposition: attachment; filename=patch-devhandbook.diff.txt
 
 SW5kZXg6IGVuX1VTLklTTzg4NTktMS9ib29rcy9kZXZlbG9wZXJzLWhhbmRi
 b29rL3BvbGljaWVzL2NoYXB0ZXIuc2dtbA0KPT09PT09PT09PT09PT09PT09
 PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09
 PT09PQ0KUkNTIGZpbGU6IC9ob21lL2RjdnMvZG9jL2VuX1VTLklTTzg4NTkt
 MS9ib29rcy9kZXZlbG9wZXJzLWhhbmRib29rL3BvbGljaWVzL2NoYXB0ZXIu
 c2dtbCx2DQpyZXRyaWV2aW5nIHJldmlzaW9uIDEuMzcNCmRpZmYgLXUgLXIx
 LjM3IGNoYXB0ZXIuc2dtbA0KLS0tIGVuX1VTLklTTzg4NTktMS9ib29rcy9k
 ZXZlbG9wZXJzLWhhbmRib29rL3BvbGljaWVzL2NoYXB0ZXIuc2dtbAk3IE1h
 eSAyMDEwIDA2OjMzOjA5IC0wMDAwCTEuMzcNCisrKyBlbl9VUy5JU084ODU5
 LTEvYm9va3MvZGV2ZWxvcGVycy1oYW5kYm9vay9wb2xpY2llcy9jaGFwdGVy
 LnNnbWwJMTcgT2N0IDIwMTEgMDQ6Mzg6MDEgLTAwMDANCkBAIC0yNCw2ICsy
 NCwxNiBAQA0KICAgDQogICA8cGFyYT5UaGlzIGNoYXB0ZXIgZG9jdW1lbnRz
 IHZhcmlvdXMgZ3VpZGVsaW5lcyBhbmQgcG9saWNpZXMgaW4gZm9yY2UgZm9y
 DQogICAgIHRoZSBGcmVlQlNEIHNvdXJjZSB0cmVlLjwvcGFyYT4NCisNCisg
 IDxzZWN0MSBpZD0icG9saWNpZXMtc3R5bGUiPg0KKyAgICA8dGl0bGU+U3R5
 bGUgR3VpZGVsaW5lczwvdGl0bGU+DQorICAgIDxpbmRleHRlcm0+PHByaW1h
 cnk+c3R5bGU8L3ByaW1hcnk+PC9pbmRleHRlcm0+DQorDQorICAgIDxwYXJh
 PkNvbnNpc3RlbnQgY29kaW5nIHN0eWxlIGlzIGV4dHJlbWVseSBpbXBvcnRh
 bnQsIHBhcnRpY3VsYXJseQ0KKyAgICAgIHdpdGggbGFyZ2UgcHJvamVjdHMg
 bGlrZSAmb3M7LiAgQ29kZSBzaG91bGQgZm9sbG93IHRoZSAmb3M7IGNvZGlu
 Zw0KKyAgICAgIHN0eWxlcyBkZXNjcmliZWQgaW4gJm1hbi5zdHlsZS45OyBh
 bmQNCisgICAgICAmbWFuLnN0eWxlLk1ha2VmaWxlLjU7LjwvcGFyYT4NCisg
 IDwvc2VjdDE+DQogICANCiAgIDxzZWN0MSBpZD0icG9saWNpZXMtbWFpbnRh
 aW5lciI+DQogICAgIDx0aXRsZT48bWFrZXZhcj5NQUlOVEFJTkVSPC9tYWtl
 dmFyPiBvbiBNYWtlZmlsZXM8L3RpdGxlPg0KSW5kZXg6IHNoYXJlL3NnbWwv
 bWFuLXJlZnMuZW50DQo9PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09
 PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09PT09DQpSQ1MgZmls
 ZTogL2hvbWUvZGN2cy9kb2Mvc2hhcmUvc2dtbC9tYW4tcmVmcy5lbnQsdg0K
 cmV0cmlldmluZyByZXZpc2lvbiAxLjUxMw0KZGlmZiAtdSAtcjEuNTEzIG1h
 bi1yZWZzLmVudA0KLS0tIHNoYXJlL3NnbWwvbWFuLXJlZnMuZW50CTI1IEF1
 ZyAyMDExIDIwOjI3OjE5IC0wMDAwCTEuNTEzDQorKysgc2hhcmUvc2dtbC9t
 YW4tcmVmcy5lbnQJMTcgT2N0IDIwMTEgMDQ6Mzg6MDEgLTAwMDANCkBAIC00
 MDQ3LDYgKzQwNDcsNyBAQA0KIDwhRU5USVRZIG1hbi5zc2guY29uZmlnLjUg
 IjxjaXRlcmVmZW50cnkvPHJlZmVudHJ5dGl0bGUvc3NoX2NvbmZpZy88bWFu
 dm9sbnVtLzUvLyI+DQogPCFFTlRJVFkgbWFuLnNzaGQuY29uZmlnLjUgIjxj
 aXRlcmVmZW50cnkvPHJlZmVudHJ5dGl0bGUvc3NoZF9jb25maWcvPG1hbnZv
 bG51bS81Ly8iPg0KIDwhRU5USVRZIG1hbi5zdGFiLjUgIjxjaXRlcmVmZW50
 cnkvPHJlZmVudHJ5dGl0bGUvc3RhYi88bWFudm9sbnVtLzUvLyI+DQorPCFF
 TlRJVFkgbWFuLnN0eWxlLk1ha2VmaWxlLjUgIjxjaXRlcmVmZW50cnkvPHJl
 ZmVudHJ5dGl0bGUvc3R5bGVfTWFrZWZpbGUvPG1hbnZvbG51bS81Ly8iPg0K
 IDwhRU5USVRZIG1hbi5zeXNjdGwuY29uZi41ICI8Y2l0ZXJlZmVudHJ5Lzxy
 ZWZlbnRyeXRpdGxlL3N5c2N0bC5jb25mLzxtYW52b2xudW0vNS8vIj4NCiA8
 IUVOVElUWSBtYW4uc3lzbG9nLmNvbmYuNSAiPGNpdGVyZWZlbnRyeS88cmVm
 ZW50cnl0aXRsZS9zeXNsb2cuY29uZi88bWFudm9sbnVtLzUvLyI+DQogPCFF
 TlRJVFkgbWFuLnRhY3BsdXMuY29uZi41ICI8Y2l0ZXJlZmVudHJ5LzxyZWZl
 bnRyeXRpdGxlL3RhY3BsdXMuY29uZi88bWFudm9sbnVtLzUvLyI+DQo=
 
 --234685094-839292105-1318826495=:320--

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/160696: commit references a PR
Date: Mon, 17 Oct 2011 18:11:06 +0000 (UTC)

 bcr         2011-10-17 18:10:51 UTC
 
   FreeBSD doc repository
 
   Modified files:
     share/sgml           man-refs.ent 
     en_US.ISO8859-1/books/developers-handbook/policies 
                                                        chapter.sgml 
   Log:
   Mention style(9) as an important guideline for FreeBSD development
   and provide links to STYLE.MAKEFILE(5).
   
   PR:                     docs/160696
   Submitted by:           radiomlodychbandytow at o2 dot pl
   Discussed on:           freebsd-doc
   ^M removal help by:     gjb
   
   Revision  Changes    Path
   1.38      +10 -0     doc/en_US.ISO8859-1/books/developers-handbook/policies/chapter.sgml
   1.514     +1 -0      doc/share/sgml/man-refs.ent
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: open->closed 
State-Changed-By: bcr 
State-Changed-When: Mon Oct 17 18:27:23 UTC 2011 
State-Changed-Why:  
Patch committed, thanks to all who participated in its creation. 
PR closed! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=160696 
>Unformatted:
