X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=PATCHES;h=74a76fdb4deed549058e56fb979c4c0722dc8779;hp=ea02a1d90e5dcbf1b4e9b03d00979fa453241a61;hb=77aa7ca8d65ac5dc7b46ad9ef79e3f6aed9b4d0e;hpb=5982d4eca8ad4d0aecb5515d39975e39b9d537d7 diff --git a/PATCHES b/PATCHES index ea02a1d90e..74a76fdb4d 100644 --- a/PATCHES +++ b/PATCHES @@ -1,13 +1,16 @@ -Please mail patches to: +// This file is part of the Doxygen Developer Manual +/** @page patchguide Patch Guidelines +Please mail patches to: @par openocd-development@lists.berlios.de Note that you can't send patches to that list unless you're a member, despite what the list info page says. -The patch should be against svn trunk using an SVN -diff. If you use git-svn, a git diff or patch is OK -too; likewise a quilt patch, if you use quilt. +@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 @@ -29,17 +32,16 @@ in response to feedback. Add yourself to the GPL copyright for non-trivial changes. To create a patch from the command line: - - svn diff >mypatch.txt - -See: - - http://svnbook.red-bean.com/en/1.0/re09.html +@code + git diff >mypatch.txt +@endcode -NB! remember to use "svn add" on new files first! +@section More Information on Patching - http://svnbook.red-bean.com/en/1.0/re01.html +The @ref primerpatches provides a more complete guide to creating, +managing, and contributing patches to the OpenOCD project. -If you have a decent SVN GUI, then that should be -able to create and apply patches as well... - + */ +/** @file +This file contains the @ref patchguide page. +*/