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:
parent
9b045f62f4
commit
cf1418e9a8
13
HACKING
13
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
|
||||
|
|
Loading…
Reference in New Issue