Revert "target: remove unused working area 'user' field"

[fw/openocd] / HACKING

diff --git a/HACKING b/HACKING
index 9e7b92ac2294c46ca10dbe9a6af7aaa4f8ff8dda..a379f92619e68bc6ef50a3ddd44383f73ed33c16 100644 (file)
--- 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<br>
-     .
-     While these pages describe the setting up of git as well,
-     you should scroll down the page till you get to the section:
-     <i>Next: Set Up SSH Keys</i>, 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
@@ -90,7 +84,7 @@ chmod +x .git/hooks/commit-msg
 @code
 tools/initial.sh <username>
 @endcode
-With <username> being your Gerrit username.
+With @<username@> being your Gerrit username.
 -# Set up git with your name and email:
 @code
 git config --global user.name "John Smith"
@@ -122,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
@@ -154,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 <a href="http://openocd.zylin.com/">here</a>.
 */
 /** @file
 This file contains the @ref patchguide page.