From: zwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60>
Date: Wed, 8 Jul 2009 22:26:29 +0000 (+0000)
Subject: Add microscopic style guide at the end of the PATCH primer.
X-Git-Tag: v0.2.0~16
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=adae530eb742348a2f41f1bb40aa3d7f7555927b;p=openocd

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
---

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.