aboutsummaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorAndreas Fritiofson <andreas.fritiofson@gmail.com>2012-12-29 00:14:44 +0100
committerSpencer Oliver <spen@spen-soft.co.uk>2012-12-30 20:07:39 +0000
commitcf1418e9a85013bbf8dbcc2d2e9985695993d9f4 (patch)
treef609fa6f5136b8f8467925af5c4c9004f8a6f8eb /HACKING
parent9b045f62f4bac2411a7662d8b312637347aac73d (diff)
downloadriscv-openocd-cf1418e9a85013bbf8dbcc2d2e9985695993d9f4.zip
riscv-openocd-cf1418e9a85013bbf8dbcc2d2e9985695993d9f4.tar.gz
riscv-openocd-cf1418e9a85013bbf8dbcc2d2e9985695993d9f4.tar.bz2
doc: Clarify the topic field in the commit comment template
Change-Id: Iea1f3b665b011ca3748800048039d3f6b33d7756 Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-on: http://openocd.zylin.com/1101 Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com> Reviewed-by: Tomasz CEDRO <cederom@tlen.pl> Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk> Tested-by: Spencer Oliver <spen@spen-soft.co.uk>
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING13
1 files changed, 8 insertions, 5 deletions
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