imi415
/
openocd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Andreas Fritiofson 2012-12-29 00:14:44 +01:00 committed by Spencer Oliver
parent 9b045f62f4
commit cf1418e9a8
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
HACKING
View File

@ -102,15 +102,18 @@ while(!done) {
} }
@endcode @endcode
@b TIP! use "git add ." before commit to add new files. @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 @code
--- example comment, notice the short first line w/topic --- topic: Short comment
topic: short comment
<blank line> <blank line>
longer comments over several Longer comments over several lines, explaining (where applicable) the
lines... reason for the patch and the general idea the solution is based on,
any major design decisions, etc...
<blank line> <blank line>
Signed-off-by: ... Signed-off-by: ...
-----
@endcode @endcode
-# Next you need to make sure that your patches -# Next you need to make sure that your patches
are on top of the latest stuff on the server and are on top of the latest stuff on the server and