X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=HACKING;h=2bd3114275e010c682102eaef249a4662de6e7ce;hp=9eb41a5cc8aeaee2a0d12497572a7bc78afc3f1b;hb=08fc7417333dc8ba4dd4ac15776ed2e9ede504bd;hpb=26f1354edae2f24da85c2860b6739cbd4821115f
diff --git a/HACKING b/HACKING
index 9eb41a5cc8..2bd3114275 100644
--- a/HACKING
+++ b/HACKING
@@ -47,22 +47,16 @@ Add yourself to the GPL copyright for non-trivial changes.
add a username of your choice.
Your username will be required in step 3 and substituted wherever
the string 'USERNAME' is found.
- -# Add an SSH public key following the directions for your specific platform:
- - for Windows: http://help.github.com/win-set-up-git/#_set_up_ssh_keys
- - for OSX: http://help.github.com/mac-set-up-git/#_set_up_ssh_keys
- - for Linux: http://help.github.com/linux-set-up-git/#_set_up_ssh_keys
- .
- While these pages describe the setting up of git as well,
- you should scroll down the page till you get to the section:
- Next: Set Up SSH Keys, and follow the steps described.
+ -# Add an SSH public key following the directions on github:
+ 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.
@@ -108,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
-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...
Signed-off-by: ...
------
@endcode
-# Next you need to make sure that your patches
are on top of the latest stuff on the server and