X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=HACKING;h=a379f92619e68bc6ef50a3ddd44383f73ed33c16;hp=d6a6b5b835033fb42d94940a492462f735846664;hb=d2f61e1a4592449188305164b27f495f78dca00a;hpb=28b1fbd5ee083732c67e5bf810ae01ad938471ac diff --git a/HACKING b/HACKING index d6a6b5b835..a379f92619 100644 --- a/HACKING +++ b/HACKING @@ -47,14 +47,8 @@ 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 @@ -69,12 +63,12 @@ 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 @@ -86,6 +80,11 @@ wget http://openocd.zylin.com/tools/hooks/commit-msg mv commit-msg .git/hooks chmod +x .git/hooks/commit-msg @endcode +@b NOTE A script exists to simplify the two items above. execute: +@code +tools/initial.sh +@endcode +With @ being your Gerrit username. -# Set up git with your name and email: @code git config --global user.name "John Smith" @@ -117,7 +116,7 @@ Signed-off-by: ... 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 @@ -149,6 +148,9 @@ 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. + +@section browsing Browsing Patches +All OpenOCD patches can be reviewed here. */ /** @file This file contains the @ref patchguide page.