X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=HACKING;h=2bd3114275e010c682102eaef249a4662de6e7ce;hp=a379f92619e68bc6ef50a3ddd44383f73ed33c16;hb=bd5df8520b5d1755c8c8a86a0f64d3aa452729ca;hpb=7d11ee207b640db7997ad3e6d0f4109ace767e95

diff --git a/HACKING b/HACKING
index a379f92619..2bd3114275 100644
--- a/HACKING
+++ b/HACKING
@@ -51,12 +51,12 @@ Add yourself to the GPL copyright for non-trivial changes.
      https://help.github.com/articles/generating-ssh-keys
 -# Clone the git repository, rather than just download the source:
  @code
- git clone git://openocd.git.sourceforge.net/gitroot/openocd/openocd
+ git clone git://git.code.sf.net/p/openocd/code openocd
  @endcode
    or if you have problems with the "git:" protocol, use
    the slower http protocol:
  @code
- git clone http://repo.or.cz/r/openocd.git
+ git clone http://git.code.sf.net/p/openocd/code openocd
  @endcode
 -# Set up Gerrit with your local repository. All this does it
 to instruct git locally how to send off the changes.
@@ -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