OpenOCD
Patch Guidelines
Attention
If you're behind a corporate wall with http only access to the world, you can still use these instructions!
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.

Submitting patches to the OpenOCD Gerrit server

OpenOCD is to some extent a "self service" open source project, so to contribute, you must follow the standard procedures to have the best possible chance to get your changes accepted.

The procedure to create a patch is essentially:

  • make the changes
  • create a commit
  • send the changes to the Gerrit server for review
  • correct the patch and re-send it according to review feedback

Your patch (or commit) should be a "good patch": focus it on a single issue, and make it be easily reviewable. Don't make it so large that it's hard to review; split large patches into smaller ones. (That can also help track down bugs later on.) All patches should be "clean", which includes preserving the existing coding style and updating documentation as needed.

Say in the commit message if it's a bugfix (describe the bug) or a new feature. Don't expect patches to merge immediately for the next release. Be ready to rework patches in response to feedback.

Add yourself to the GPL copyright for non-trivial changes.

Step by step procedure

  1. Create a Gerrit account at: http://openocd.zylin.com
    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 3 and substituted wherever the string 'USERNAME' is found.
    2. 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.
    3. 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.
  2. Clone the git repository, rather than just download the source:
    git clone git://git.code.sf.net/p/openocd/code openocd
    or if you have problems with the "git:" protocol, use the slower http protocol:
    git clone http://git.code.sf.net/p/openocd/code openocd
  3. Set up Gerrit with your local repository. All this does it to instruct git locally how to send off the changes.
    1. 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/publish/master
      Or with http only:
      git remote add review http://USERNAME@openocd.zylin.com/p/openocd.git
      git config remote.review.push HEAD:refs/publish/master
      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:
      git remote add review http://USERNAME:PASSWORD@openocd.zylin.com/p/openocd.git
    2. 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
      Note
      A script exists to simplify the two items above. execute:
      tools/initial.sh <username>
      With <username> being your Gerrit username.
  4. Set up git with your name and email:
    git config --global user.name "John Smith"
    git config --global user.email "john@smith.org"
  5. 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 tools/checkpatch.sh to verify your patch style is ok.
    }
    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 git log for examples.
    topic: Short comment
    <blank line>
    Longer comments over several lines, explaining (where applicable) the
    reason for the patch and the general idea the solution is based on,
    any major design decisions, etc...
    <blank line>
    Signed-off-by: ...
  6. Next you need to make sure that your patches are on top of the latest stuff on the server and that there are no conflicts:
    git pull --rebase origin master
  7. Send the patches to the Gerrit server for review:
    git push review
  8. Forgot something, want to add more? Just make the changes and do:
    git commit --amend
    git push review

Further reading: 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.

It should be noted that a negative review in Gerrit ("-1" or "-2") may (but does not have to) be disregarded if all conditions listed below are met:

  • the concerns raised in the review have been addressed (or explained),
  • reviewer does not re-examine the change in a month,
  • reviewer does not answer e-mails for another month.

Browsing Patches

All OpenOCD patches can be reviewed here.

Reviewing Patches

From the main Review page 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.