X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=PATCHES;h=32f1bda5f070f0bee4b6a55f4b0d8a95b596a147;hp=95eb500a89c2eedf3caf1adad5c0d1c403d70aa7;hb=f86137066a6b42c46c457c9837a8015990bf71e6;hpb=f1f0d5e2d5b0964f87e5fc89da72f14aca024491 diff --git a/PATCHES b/PATCHES index 95eb500a89..32f1bda5f0 100644 --- a/PATCHES +++ b/PATCHES @@ -1,15 +1,16 @@ -/** @page patchguide Patch Policies - -Please mail patches to: +// This file is part of the Doyxgen 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 @@ -31,20 +32,15 @@ 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.