This is an automated email from Gerrit.

Andreas Fritiofson ([email protected]) just uploaded a new patch set 
to Gerrit, which you can find at http://openocd.zylin.com/1101

-- gerrit

commit a3246a8ef131e69d7abde505019ff4372bdd8f47
Author: Andreas Fritiofson <[email protected]>
Date:   Sat Dec 29 00:14:44 2012 +0100

    doc: Clarify the topic field in the commit comment template
    
    Change-Id: Iea1f3b665b011ca3748800048039d3f6b33d7756
    Signed-off-by: Andreas Fritiofson <[email protected]>

diff --git a/HACKING b/HACKING
index 658aa76..2bd3114 100644
--- a/HACKING
+++ b/HACKING
@@ -102,15 +102,18 @@ while(!done) {
 }
 @endcode
    @b TIP! use "git add ." before commit to add new files.
+
+   Comment template, notice the short first line w/topic. The topic field
+   should identify the main part or subsystem the patch touches. Check
+   git log for examples.
 @code
---- example comment, notice the short first line w/topic ---
-topic: short comment
+topic: Short comment
 <blank line>
-longer comments over several
-lines...
+Longer comments over several lines, explaining (where applicable) the
+reason for the patch and the general idea the solution is based on,
+any major design decisions, etc...
 <blank line>
 Signed-off-by: ...
------
 @endcode
 -# Next you need to make sure that your patches
    are on top of the latest stuff on the server and

-- 

------------------------------------------------------------------------------
Master HTML5, CSS3, ASP.NET, MVC, AJAX, Knockout.js, Web API and
much more. Get web development skills now with LearnDevNow -
350+ hours of step-by-step video tutorials by Microsoft MVPs and experts.
SALE $99.99 this month only -- learn more at:
http://p.sf.net/sfu/learnmore_122812
_______________________________________________
OpenOCD-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/openocd-devel

Reply via email to