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