Difference between revisions of "Development Guidelines"

From coreboot
Jump to: navigation, search
(Bug-Tracker)
(Bug-Tracker: Make it clear that it's a quote.)
Line 20: Line 20:
 
* Send patches to the [[Mailinglist]] for review before committing.
 
* Send patches to the [[Mailinglist]] for review before committing.
 
== Bug-Tracker ==
 
== Bug-Tracker ==
It searches commit messages for text in the form of:
 
* command #1
 
* command #1, #2
 
* command #1 & #2
 
* command #1 and #2
 
  
You can have more then one command in a message. The following commands
+
=== How to close Trac issues automatically via email ===
are supported. There is more then one spelling for each command, to make
 
this as user-friendly as possible.
 
  
* closes, fixes<br/>
+
It searches commit messages for text in the form of:
The specified issue numbers are closed with the contents of this
+
* command #1
commit message being added to it.
+
* command #1, #2
*references, refs, addresses, re<br/>
+
* command #1 & #2
The specified issue numbers are left in their current status, but
+
* command #1 and #2<br />
the contents of this commit message are added to their notes.
+
You can have more then one command in a message. The following commands
 
+
are supported. There is more then one spelling for each command, to make
A fairly complicated example of what you can do is with a commit message
+
this as user-friendly as possible.<br />
of:
+
* closes, fixes
 
+
  The specified issue numbers are closed with the contents of this
     Changed blah and foo to do this or that. Fixes #10 and #12, and refs #12.
+
  commit message being added to it.
 
+
* references, refs, addresses, re  
This will close #10 and #12, and add a note to #12.
+
  The specified issue numbers are left in their current status, but
 +
  the contents of this commit message are added to their notes.<br />
 +
A fairly complicated example of what you can do is with a commit message of:<br />
 +
     Changed blah and foo to do this or that. Fixes #10 and #12, and refs #12.<br />
 +
This will close #10 and #12, and add a note to #12.
  
 
== License Issues ==
 
== License Issues ==

Revision as of 09:03, 27 October 2006

This is work in progress!

Development Environment

  • Required toolchains etc.

Coding Guidelines

General Guidelines

Comments

Coding Style

  • Indentation etc.

Documentation

  • General guidelines and tips
  • Doxygen

Testing

  • abuild

How to contribute

Svn Commits

Reviews

  • Send patches to the Mailinglist for review before committing.

Bug-Tracker

How to close Trac issues automatically via email

It searches commit messages for text in the form of:
* command #1
* command #1, #2
* command #1 & #2
* command #1 and #2
You can have more then one command in a message. The following commands are supported. There is more then one spelling for each command, to make this as user-friendly as possible.
* closes, fixes The specified issue numbers are closed with the contents of this commit message being added to it. * references, refs, addresses, re The specified issue numbers are left in their current status, but the contents of this commit message are added to their notes.
A fairly complicated example of what you can do is with a commit message of:
Changed blah and foo to do this or that. Fixes #10 and #12, and refs #12.
This will close #10 and #12, and add a note to #12.

License Issues

  • Contributed code must be GPL'd (preferrably GPLv2 or any later version), or at least have a GPL-compatible license.

Common License Header

Example:

/*
 * This file is part of the LinuxBIOS project.
 *
 * Copyright (C) 2003-2005 John Doe <john@example.com>
 * Copyright (C) 2006 Jane Doe <jane@example.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

Sign-off Procedure

Verbatim copy from the Linux kernel (we might modify this a bit):

To improve tracking of who did what, especially with patches that can
percolate to their final resting place in the kernel through several
layers of maintainers, we've introduced a "sign-off" procedure on
patches that are being emailed around.
The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as a open-source patch. The rules are pretty simple: if you can certify the below:
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
then you just add a line saying
Signed-off-by: Random J Developer <random@developer.example.org>
Some people also put extra tags at the end. They'll just be ignored for now, but you can do this to mark internal company procedures or just point out some special detail about the sign-off.