Add microscopic style guide at the end of the PATCH primer.
---
 patches.txt |   13 +++++++++++++
 1 file changed, 13 insertions(+)
Add microscopic style guide at the end of the PATCH primer.
---
 patches.txt |   13 +++++++++++++
 1 file changed, 13 insertions(+)
======
only in patch2:
unchanged:
--- doc/manual/primer/patches.txt	(revision 2495)
+++ doc/manual/primer/patches.txt	(working copy)
@@ -204,6 +204,19 @@
 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.
_______________________________________________
Openocd-development mailing list
Openocd-development@lists.berlios.de
https://lists.berlios.de/mailman/listinfo/openocd-development

Reply via email to