Fix logger.pl script to avoid spurious empty line in some cases.

[openocd] / PATCHES

diff --git a/PATCHES b/PATCHES
index 8b88ecf70c4e020bcab57b208e8768e36a999111..ed980b856817ff09ae352024e091b3979954adee 100644 (file)
--- a/PATCHES
+++ b/PATCHES
@@ -1,28 +1,57 @@
-Please mail patches to:\r
-\r
-openocd-development@lists.berlios.de\r
-\r
-The patch should be against svn trunk using an SVN\r
-diff. \r
-\r
-Attach the patch to the email as a .txt file and\r
-also write a short change log entry that maintainers\r
-can copy and paste into the commit message\r
-\r
-Add yourself to the GPL copyright for non-trivial changes.\r
-\r
-To create a patch from the command line:\r
- \r
-svn diff >mypatch.txt\r
-\r
-http://svnbook.red-bean.com/en/1.0/re09.html\r
-\r
-NB! remember to use "svn add" on new files first!\r
-\r
-http://svnbook.red-bean.com/en/1.0/re01.html\r
-\r
-\r
-\r
-If you have a decent SVN GUI, then that should be\r
-able to create and apply patches as well...\r
- 
\ No newline at end of file
+/** @page patchguide Patch Guidelines
+
+Please mail patches to:
+
+       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.
+
+It should be a "good patch": focus it on a single
+issue, and make it be easily reviewable. Don't make
+it so large that it's hard to review; split large
+patches into smaller ones. (That can also help
+track down bugs later on.) All patches should
+be "clean", which includes preserving the existing
+coding style and updating documentation as needed.j
+
+Attach the patch to the email as a .txt file and
+also write a short change log entry that maintainers
+can copy and paste into the commit message
+
+Say if it's a bugfix (describe the bug) or a new
+feature. Don't expect patches to merge immediately
+for the next release. Be ready to rework patches
+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: @par
+       http://svnbook.red-bean.com/en/1.0/re09.html
+
+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.
+*/