Bug 160696

Summary:

style(9) should be mentioned in the devs' handbook

Product:

Documentation

Reporter:

Radio Młodych Bandytów <radiomlodychbandytow>

Component:

Books & Articles

Assignee:

Benedict Reuschling <bcr>

Status:

Closed FIXED

Severity:

Affects Only Me

Priority:

Normal

Version:

Latest

Hardware:

Any

OS:

Any

Attachments:

Description	Flags
doc.developers-handbook.policies.chapter.sgml.diff	none
doc.developers-handbook.policies.chapter.sgml.diff	none
patch-devhandbook.diff.txt	none

Description Radio Młodych Bandytów 2011-09-13 08:20:05 UTC

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.

Comment 1 Niclas Zeising 2011-10-12 11:29:19 UTC

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

Comment 2 Niclas Zeising 2011-10-12 13:07:09 UTC

Hi!
Here is an updated patch based on comments from Glen Barber.
Regards!
-- 
Niclas Zeising

Comment 3 Benedict Reuschling freebsd_committer

2011-10-12 13:29:58 UTC

Responsible Changed
From-To: freebsd-doc->bcr

I'll take this one.

Comment 4 Warren Block 2011-10-17 05:41:35 UTC

Updated patch as discussed on freebsd-doc.  Some spelling fixes to the 
original, along with the rewritten paragraph.

Comment 5 dfilter service freebsd_committer

2011-10-17 19:11:06 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"

Comment 6 Benedict Reuschling freebsd_committer

2011-10-17 19:27:23 UTC

State Changed
From-To: open->closed

Patch committed, thanks to all who participated in its creation. 
PR closed!