HACKING - checkpatch before pushing makes life quicker

[fw/openocd] / HACKING

diff --git a/HACKING b/HACKING
index 42c50f0a7aec223ade6f4d2d1904c2c03ac403d1..6d89b01e357b4970b317461ee41c0bec37a98600 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -1,3 +1,6 @@
+NB! If you're behind a corporate wall with http only access to the
+world, you can still use these instructions!
+
 Submitting patches to the OpenOCD Gerrit server:
 
 OpenOCD is to some extent a "self service" open source project, so to
@@ -10,14 +13,40 @@ The procedure to create a patch is essentially:
 - create a commit
 - send the changes to the Gerrit server for review
 - correct the patch and re-send it according to review feedback
- 
+
 
 0. Create a Gerrit account at:
 
 http://openocd.zylin.com
 
+- On subsequent sign ins, use the full URL prefaced with 'http://'
+  For example:
+
+       http://user_identifier.open_id_provider.com
+
+0.1. Add a username to your profile.
+
+After creating the Gerrit account and signing in, you will need to
+add a username to your profile. To do this, go to 'Settings', and
+add a username of your choice.
+
+Your username will be required in step 2 and substituted wherever
+the string 'USERNAME' is found.
+
+0.2. Add an SSH public key
+
+Following the directions for your specific platform:
+
+       for Windows: help.github.com/win-set-up-git/#_set_up_ssh_keys
+       for OSX:     help.github.com/mac-set-up-git/#_set_up_ssh_keys
+       for Linux:   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.
+
 1. Clone the git repository, rather than just
-download the source. 
+download the source.
 
 git clone git://openocd.git.sourceforge.net/gitroot/openocd/openocd
 
@@ -34,24 +63,36 @@ Add a new remote to git using Gerrit username:
 git remote add review ssh://USERNAME@openocd.zylin.com:29418/openocd.git
 git config remote.review.push HEAD:refs/for/master
 
+Or with http only:
+
+git remote add review http://openocd.zylin.com/p/openocd.git
+git config remote.review.push HEAD:refs/for/master
+
 You will need to install this hook, we will look into a better
 solution:
 
 scp -p -P 29418 USERNAME@openocd.zylin.com:hooks/commit-msg .git/hooks/
 
+Or with http only:
+
+wget http://openocd.zylin.com/tools/hooks/commit-msg
+mv commit-msg .git/hooks
+chmod +x .git/hooks/commit-msg
+
 3. Set up git with your name and email:
 
 git config --global user.name "John Smith"
 git config --global user.email "john@smith.org"
 
-4. Work on your patches. Split the work into 
+4. Work on your patches. Split the work into
 multiple small patches that can be reviewed and
 applied seperately and safely to the OpenOCD
 repository.
 
 while(!done) {
   work - edit files using your favorite editor.
-  run "git commit -s -a" to commit all changes. 
+  run "git commit -s -a" to commit all changes.
+  run tools/checkpatch.sh to verify your patch style is ok.
 }
 
 TIP! use "git add ." before commit to add new files.