Add comments to top-level files to "excuse" their Doxygen markup.

[openocd.git] / PATCHES

diff --git a/PATCHES b/PATCHES
index 95eb500a89c2eedf3caf1adad5c0d1c403d70aa7..74fd696760e4631bf8d1f51f4c2f98f4108f20c7 100644 (file)
--- a/PATCHES
+++ b/PATCHES
@@ -1,12 +1,14 @@
-/** @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.
 
+@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.