X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=HACKING;h=d4f7a79f8ceec3e05092ff44e57d8397c7dcc556;hp=47169ee72552930bc2e04cdf1d68245be381b23d;hb=1d1f1b95a7516af3ce845c79af73511c82035528;hpb=a2935397b48ce2a1bbb8e49258b340479e0b9c8e
diff --git a/HACKING b/HACKING
index 47169ee725..d4f7a79f8c 100644
--- a/HACKING
+++ b/HACKING
@@ -47,34 +47,28 @@ 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.
-# Add a new remote to git using Gerrit username:
@code
git remote add review ssh://USERNAME@openocd.zylin.com:29418/openocd.git
-git config remote.review.push HEAD:refs/for/master
+git config remote.review.push HEAD:refs/publish/master
@endcode
Or with http only:
@code
git remote add review http://openocd.zylin.com/p/openocd.git
-git config remote.review.push HEAD:refs/for/master
+git config remote.review.push HEAD:refs/publish/master
@endcode
-# You will need to install this hook, we will look into a better solution:
@code
@@ -108,21 +102,24 @@ 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
that there are no conflicts:
@code
-git pull --rebase origin/master
+git pull --rebase origin master
@endcode
-# Send the patches to the Gerrit server for review:
@code
@@ -155,6 +152,13 @@ master branch will be much reduced.
If a contributor pushes a patch, it is considered good form if another
contributor actually approves and submits that patch.
+It should be noted that a negative review in Gerrit ("-1" or "-2") may (but does
+not have to) be disregarded if all conditions listed below are met:
+
+- the concerns raised in the review have been addressed (or explained),
+- reviewer does not re-examine the change in a month,
+- reviewer does not answer e-mails for another month.
+
@section browsing Browsing Patches
All OpenOCD patches can be reviewed here.
*/