jimtcl: update to 0.77, the current version, enable only specific modules

[openocd] / HACKING

diff --git a/HACKING b/HACKING
index d4f7a79f8ceec3e05092ff44e57d8397c7dcc556..162da8698ea4ba85a516ba1269add777c74a7ff8 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -1,10 +1,10 @@
 // This file is part of the Doxygen Developer Manual
 /** @page patchguide Patch Guidelines
 
-@b NB! If you're behind a corporate wall with http only access to the
+\attention If you're behind a corporate wall with http only access to the
 world, you can still use these instructions!
 
-@b NB2! You can't send patches to the mailing list anymore at all. Nowadays
+\attention You can't send patches to the mailing list anymore at all. Nowadays
 you are expected to send patches to the OpenOCD Gerrit GIT server for a
 review.
 
@@ -47,8 +47,14 @@ 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 on github:
-     https://help.github.com/articles/generating-ssh-keys
+  -# Create an SSH public key following the directions on github:
+     https://help.github.com/articles/generating-ssh-keys . You can skip step 3
+     (adding key to Github account) and 4 (testing) - these are useful only if
+     you actually use Github or want to test whether the new key works fine.
+  -# Add this new SSH key to your Gerrit account:
+     go to 'Settings' > 'SSH Public Keys', paste the contents of
+     ~/.ssh/id_rsa.pub into the text field (if it's not visible click on
+     'Add Key ...' button) and confirm by clicking 'Add' button.
 -# Clone the git repository, rather than just download the source:
  @code
  git clone git://git.code.sf.net/p/openocd/code openocd
@@ -67,8 +73,13 @@ 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 remote add review http://USERNAME@openocd.zylin.com/p/openocd.git
 git config remote.review.push HEAD:refs/publish/master
+@endcode
+  The http password is configured from your gerrit settings - http://openocd.zylin.com/#/settings/http-password.
+  \note If you want to simplify http access you can also add your http password to the url as follows:
+@code
+git remote add review http://USERNAME:PASSWORD@openocd.zylin.com/p/openocd.git
 @endcode
   -# You will need to install this hook, we will look into a better solution:
 @code
@@ -80,7 +91,7 @@ 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:
+  \note A script exists to simplify the two items above. execute:
 @code
 tools/initial.sh <username>
 @endcode
@@ -101,7 +112,7 @@ while(!done) {
   run tools/checkpatch.sh to verify your patch style is ok.
 }
 @endcode
-   @b TIP! use "git add ." before commit to add new files.
+   \note 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
@@ -161,6 +172,13 @@ not have to) be disregarded if all conditions listed below are met:
 
 @section browsing Browsing Patches
 All OpenOCD patches can be reviewed <a href="http://openocd.zylin.com/">here</a>.
+
+@section reviewing Reviewing Patches
+From the main <a href="http://openocd.zylin.com/#/q/status:open,n,z">Review
+page</a> select the patch you want to review and click on that patch. On the
+appearing page select the download method (top right). Apply the
+patch. After building and testing you can leave a note with the "Reply"
+button and mark the patch with -1, 0 and +1.
 */
 /** @file
 This file contains the @ref patchguide page.