X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=PATCHES;h=ed980b856817ff09ae352024e091b3979954adee;hp=ea02a1d90e5dcbf1b4e9b03d00979fa453241a61;hb=fb1a9b2cb2f844a17d26dfeb3d26849364d93e26;hpb=5982d4eca8ad4d0aecb5515d39975e39b9d537d7 diff --git a/PATCHES b/PATCHES index ea02a1d90e..ed980b8568 100644 --- a/PATCHES +++ b/PATCHES @@ -1,3 +1,5 @@ +/** @page patchguide Patch Guidelines + Please mail patches to: openocd-development@lists.berlios.de @@ -5,6 +7,8 @@ Please mail patches to: 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 + 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. @@ -29,17 +33,25 @@ in response to feedback. Add yourself to the GPL copyright for non-trivial changes. To create a patch from the command line: - +@code svn diff >mypatch.txt +@endcode -See: - +See: @par http://svnbook.red-bean.com/en/1.0/re09.html -NB! remember to use "svn add" on new files first! - +Remember to use "svn add" on new files first: @par http://svnbook.red-bean.com/en/1.0/re01.html If you have a decent SVN GUI, then that should be able to create and apply patches as well... +@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. +*/