From b344ea9b97b52ea99227ece0eed9a3ece5516c7c Mon Sep 17 00:00:00 2001 From: zwelch Date: Wed, 3 Jun 2009 02:17:26 +0000 Subject: [PATCH] Improve doxygen markup of PATCHES file, link to new primer. git-svn-id: svn://svn.berlios.de/openocd/trunk@2022 b42882b7-edfa-0310-969c-e2dbd0fdcd60 --- PATCHES | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/PATCHES b/PATCHES index 95eb500a8..ed980b856 100644 --- a/PATCHES +++ b/PATCHES @@ -1,4 +1,4 @@ -/** @page patchguide Patch Policies +/** @page patchguide Patch Guidelines Please mail patches to: @@ -7,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. @@ -31,20 +33,24 @@ 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.