doc: Clarify the topic field in the commit comment template

[openocd.git] / HACKING

diff --git a/HACKING b/HACKING
index 658aa76b592c13379584a2b9953eedf32438308d..2bd3114275e010c682102eaef249a4662de6e7ce 100644 (file)
--- 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