tcl/fpga/xilinx-xadc.cfg: add support for XADC

[openocd.git] / HACKING

diff --git a/HACKING b/HACKING
index 395b5b3167c5ff09f7613f4ac06e3d7ad8315d36..0bea65a751c673f329bc5f4e2ef244e32137c96f 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -1,13 +1,20 @@
 // This file is part of the Doxygen Developer Manual
 /** @page patchguide Patch Guidelines
 
-\attention If you're behind a corporate wall with http only access to the
-world, you can still use these instructions!
-
 \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.
 
+\attention If you already have a Gerrit account and want to try a
+different sign in method, please first sign in as usually, press your
+name in the upper-right corner, go to @a Settings, select @a
+Identities pane, press <em>Link Another Identity</em> button. In case
+you already have duplicated accounts, ask administrators for manual
+merging.
+
+\attention If you're behind a corporate wall with http only access to the
+world, you can still use these instructions!
+
 @section gerrit Submitting patches to the OpenOCD Gerrit server
 
 OpenOCD is to some extent a "self service" open source project, so to
@@ -47,8 +54,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
@@ -166,6 +179,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.