summaryrefslogtreecommitdiff
path: root/doc/manual/primer
diff options
context:
space:
mode:
authorzwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2009-07-08 22:26:29 +0000
committerzwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2009-07-08 22:26:29 +0000
commitadae530eb742348a2f41f1bb40aa3d7f7555927b (patch)
tree558f3e81bdd43ed73d423d6559a23b00db2d9452 /doc/manual/primer
parentdeda6ea50913b95deb536d5596037512584d13a7 (diff)
downloadopenocd_libswd-adae530eb742348a2f41f1bb40aa3d7f7555927b.tar.gz
openocd_libswd-adae530eb742348a2f41f1bb40aa3d7f7555927b.tar.bz2
openocd_libswd-adae530eb742348a2f41f1bb40aa3d7f7555927b.tar.xz
openocd_libswd-adae530eb742348a2f41f1bb40aa3d7f7555927b.zip
Add microscopic style guide at the end of the PATCH primer.
git-svn-id: svn://svn.berlios.de/openocd/trunk@2501 b42882b7-edfa-0310-969c-e2dbd0fdcd60
Diffstat (limited to 'doc/manual/primer')
-rw-r--r--doc/manual/primer/patches.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/manual/primer/patches.txt b/doc/manual/primer/patches.txt
index a3d0453f..098766eb 100644
--- a/doc/manual/primer/patches.txt
+++ b/doc/manual/primer/patches.txt
@@ -204,6 +204,19 @@ it or prompt for feedback. Please have patience, as many maintainers
work on the project voluntarily and without compensation for the time
that they spend doing these tasks.
+@section primerpatchguide Guidelines for Submitting Patches
+
+- Each patch file should contain:
+ - A commit description that describes all of the changes.
+ - A separator line that contains three hyphens: <code>---</code>
+ - A summary of the changes produced by diffstat (optional)
+ - Another separator line (optional)
+ - The actual patch contents, containing a single change.
+
+- Each patch series should include:
+ - A summary of the patches in the series.
+ - Logically-related patches that contain incremental changes.
+
*/
/** @file
This file contains the @ref primerpatches page.