diff options
author | Timo Ketola <timo@exertus.fi> | 2012-01-17 16:10:10 +0200 |
---|---|---|
committer | Spencer Oliver <spen@spen-soft.co.uk> | 2012-01-18 21:46:15 +0000 |
commit | 28b1fbd5ee083732c67e5bf810ae01ad938471ac (patch) | |
tree | 0a61e727a8bbb5f3cf6258a918516c0fbb7b71f5 /PATCHES.txt | |
parent | 3528457ba8f8b41e2bb96ee925dec21eaab1644a (diff) |
doc: Update patch procedure
Change-Id: I3e50357b4ddaf483712bbac68b6427b31529f666
Signed-off-by: Timo Ketola <timo@exertus.fi>
Reviewed-on: http://openocd.zylin.com/387
Tested-by: jenkins
Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com>
Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
Diffstat (limited to 'PATCHES.txt')
-rw-r--r-- | PATCHES.txt | 47 |
1 files changed, 0 insertions, 47 deletions
diff --git a/PATCHES.txt b/PATCHES.txt deleted file mode 100644 index 2757eaca..00000000 --- a/PATCHES.txt +++ /dev/null @@ -1,47 +0,0 @@ -// This file is part of the Doxygen Developer Manual -/** @page patchguide Patch Guidelines - -Please mail patches to: @par - openocd-devel@lists.sourceforge.net - -Note that you can't send patches to that list unless -you're a member, despite what the list info page says. - -@section Patch Guidelines in a Nutshell - -Your patches should be against git mainline. Submit output -of "git diff"; equivalently, quilt patches are OK. - -It should be a "good patch": focus it on a single -issue, and make it be easily reviewable. Don't make -it so large that it's hard to review; split large -patches into smaller ones. (That can also help -track down bugs later on.) All patches should -be "clean", which includes preserving the existing -coding style and updating documentation as needed.j - -Attach the patch to the email as a .txt file and -also write a short change log entry that maintainers -can copy and paste into the commit message - -Say if it's a bugfix (describe the bug) or a new -feature. Don't expect patches to merge immediately -for the next release. Be ready to rework patches -in response to feedback. - -Add yourself to the GPL copyright for non-trivial changes. - -To create a patch from the command line: -@code - git diff >mypatch.txt -@endcode - -@section More Information on Patching - -The @ref primerpatches provides a more complete guide to creating, -managing, and contributing patches to the OpenOCD project. - - */ -/** @file -This file contains the @ref patchguide page. -*/ |