make checkpatch.sh take an optional 'since' refspec
[openocd.git] / PATCHES.txt
1 // This file is part of the Doxygen Developer Manual
2 /** @page patchguide Patch Guidelines
3
4 Please mail patches to: @par
5         openocd-devel@lists.sourceforge.net
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 @section Patch Guidelines in a Nutshell
11
12 Your patches should be against git mainline.  Submit output
13 of "git diff"; equivalently, quilt patches are OK.
14
15 It should be a "good patch": focus it on a single
16 issue, and make it be easily reviewable. Don't make
17 it so large that it's hard to review; split large
18 patches into smaller ones. (That can also help
19 track down bugs later on.) All patches should
20 be "clean", which includes preserving the existing
21 coding style and updating documentation as needed.j
22
23 Attach the patch to the email as a .txt file and
24 also write a short change log entry that maintainers
25 can copy and paste into the commit message
26
27 Say if it's a bugfix (describe the bug) or a new
28 feature. Don't expect patches to merge immediately
29 for the next release. Be ready to rework patches
30 in response to feedback.
31
32 Add yourself to the GPL copyright for non-trivial changes.
33
34 To create a patch from the command line:
35 @code
36         git diff >mypatch.txt
37 @endcode
38
39 @section More Information on Patching
40
41 The @ref primerpatches provides a more complete guide to creating,
42 managing, and contributing patches to the OpenOCD project.
43
44  */
45 /** @file
46 This file contains the @ref patchguide page.
47 */