Author: David Brownell <david-b@pacbell.net>
[openocd.git] / PATCHES
1 Please mail patches to:
2
3         openocd-development@lists.berlios.de
4
5 Note that you can't send patches to that list unless
6 you're a member, despite what the list info page says.
7
8 The patch should be against svn trunk using an SVN
9 diff. If you use git-svn, a git diff or patch is OK
10 too; likewise a quilt patch, if you use quilt.
11
12 It should be a "good patch": focus it on a single
13 issue, and make it be easily reviewable. Don't make
14 it so large that it's hard to review; split large
15 patches into smaller ones. (That can also help
16 track down bugs later on.) All patches should
17 be "clean", which includes preserving the existing
18 coding style and updating documentation as needed.j
19
20 Attach the patch to the email as a .txt file and
21 also write a short change log entry that maintainers
22 can copy and paste into the commit message
23
24 Say if it's a bugfix (describe the bug) or a new
25 feature. Don't expect patches to merge immediately
26 for the next release. Be ready to rework patches
27 in response to feedback.
28
29 Add yourself to the GPL copyright for non-trivial changes.
30
31 To create a patch from the command line:
32  
33         svn diff >mypatch.txt
34
35 See:
36
37         http://svnbook.red-bean.com/en/1.0/re09.html
38
39 NB! remember to use "svn add" on new files first!
40
41         http://svnbook.red-bean.com/en/1.0/re01.html
42
43 If you have a decent SVN GUI, then that should be
44 able to create and apply patches as well...
45