X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=HACKING;h=ed971715406b79db363d395920915294ed7dfcc8;hp=dc06b4558e6a0ca0a82c81fcd05f5440bdaac2eb;hb=2a34cc8eb6a8431ecebad1279d19ce919978a778;hpb=2d4bdb9fe089b5fe169639cecf32fbe38dca1a16 diff --git a/HACKING b/HACKING index dc06b4558e..ed97171540 100644 --- 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,7 +13,7 @@ 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: @@ -43,7 +46,7 @@ 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 @@ -60,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. @@ -106,4 +121,25 @@ git push review Further reading: -http://www.coreboot.org/Git \ No newline at end of file +http://www.coreboot.org/Git + + +When can I expect my contribution to be committed? +================================================== + +The code review is intended to take as long as a week or two to allow +maintainers and contributors who work on OpenOCD only in their spare +time oportunity to perform a review and raise objections. + +With Gerrit much of the urgency of getting things committed has been +removed as the work in progress is safely stored in Gerrit and +available if someone needs to build on your work before it is +submitted to the official repository. + +Another factor that contributes to the desire for longer cool-off +times (the time a patch lies around without any further changes or +comments), it means that the chances of quality regression on the +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.