-NB! If you're behind a corporate wall with http only access to the
+// This file is part of the Doxygen Developer Manual
+/** @page patchguide Patch Guidelines
+
+\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!
-Submitting patches to the OpenOCD Gerrit server:
+@section gerrit 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
- 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.
-
-git clone git://openocd.git.sourceforge.net/gitroot/openocd/openocd
-
-or if you have problems with the "git:" protocol, use
-the slower http protocol:
-
-git clone http://repo.or.cz/r/openocd.git
-
-2. Set up Gerrit with your local repository. All this does it
+Your patch (or commit) should be a "good patch": focus it on a single
+issue, and make it easily reviewable. Don't make
+it so large that it's hard to review; split large
+patches into smaller ones (this will also help
+to track down bugs later). All patches should
+be "clean", which includes preserving the existing
+coding style and updating documentation as needed. When adding a new
+command, the corresponding documentation should be added to
+@c doc/openocd.texi in the same commit. OpenOCD runs on both Little
+Endian and Big Endian hosts so the code can't count on specific byte
+ordering (in other words, must be endian-clean).
+
+There are several additional methods of improving the quality of your
+patch:
+
+- Runtime testing with Valgrind Memcheck
+
+ This helps to spot memory leaks, undefined behaviour due to
+ uninitialized data or wrong indexing, memory corruption, etc.
+
+- Clang Static Analyzer
+
+ Using this tool uncovers many different kinds of bugs in C code,
+ with problematic execution paths fully explained. It is a part of
+ standard Clang installation.
+
+ To generate a report, run this in the OpenOCD source directory:
+ @code
+ mkdir build-scanbuild; cd build-scanbuild
+ scan-build ../configure
+ scan-build make CFLAGS="-std=gnu99 -I. -I../../jimtcl"
+ @endcode
+
+- Runtime testing with sanitizers
+
+ Both GCC and LLVM/Clang include advanced instrumentation options to
+ detect undefined behaviour and many kinds of memory
+ errors. Available with @c -fsanitize=* command arguments.
+
+ Example usage:
+ @code
+ mkdir build-sanitizers; cd build-sanitizers
+ ../configure CC=clang CFLAGS="-fno-omit-frame-pointer \
+ -fsanitize=address -fsanitize=undefined -ggdb3"
+ make
+ export ASAN_OPTIONS=detect_stack_use_after_return=1
+ src/openocd -s ../tcl -f /path/to/openocd.cfg
+ @endcode
+
+Please consider performing these additonal checks where appropriate
+(especially Clang Static Analyzer for big portions of new code) and
+mention the results (e.g. "Valgrind-clean, no new Clang analyzer
+warnings") in the commit message.
+
+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.
+
+@section stepbystep Step by step procedure
+
+-# 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
+ -# 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.
+ -# 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
+ @endcode
+ or if you have problems with the "git:" protocol, use
+ the slower http protocol:
+ @code
+ git clone http://git.code.sf.net/p/openocd/code openocd
+ @endcode
+-# Set up Gerrit with your local repository. All this does it
to instruct git locally how to send off the changes.
-
-Add a new remote to git using Gerrit username:
-
+ -# Add a new remote to git using Gerrit username:
+@code
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
+@endcode
+ Or with http only:
+@code
+git remote add review http://USERNAME@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:
-
+@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
+ \note All contributions should be pushed to @c refs/for/master on the
+Gerrit server, even if you plan to use several local branches for different
+topics. It is possible because @c for/master is not a traditional Git
+branch.
+ -# You will need to install this hook, we will look into a better solution:
+@code
scp -p -P 29418 USERNAME@openocd.zylin.com:hooks/commit-msg .git/hooks/
-
-Or with http only:
-
+@endcode
+ Or with http only:
+@code
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:
-
+@endcode
+ \note A script exists to simplify the two items above. execute:
+@code
+tools/initial.sh <username>
+@endcode
+With @<username@> being your Gerrit username.
+-# Set up git with your name and email:
+@code
git config --global user.name "John Smith"
git config --global user.email "john@smith.org"
-
-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.
-
+@endcode
+-# Work on your patches. Split the work into
+ multiple small patches that can be reviewed and
+ applied seperately and safely to the OpenOCD
+ repository.
+@code
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.
}
+@endcode
+ \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.
+@code
+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: ...
+@endcode
+-# 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:
+@code
+git pull --rebase origin master
+@endcode
+-# Send the patches to the Gerrit server for review:
+@code
+git push review
+@endcode
+-# Forgot something, want to add more? Just make the changes and do:
+@code
+git commit --amend
+git push review
+@endcode
-TIP! use "git add ." before commit to add new files.
+Further reading: http://www.coreboot.org/Git
---- example comment, notice the short first line w/topic ---
-topic: short comment
-<blank line>
-longer comments over several
-lines...
------
+@section timeline When can I expect my contribution to be committed?
-5. 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.
+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 opportunity to perform a review and raise objections.
-git pull --rebase origin/master
+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.
-6. Send the patches to the Gerrit server for review.
+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.
-git push review
+If a contributor pushes a patch, it is considered good form if another
+contributor actually approves and submits that patch.
-7. Forgot something, want to add more? Just make the changes and do:
+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:
-git commit --amend
-git push review
+- 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.
-Further reading:
+@section browsing Browsing Patches
+All OpenOCD patches can be reviewed <a href="http://openocd.zylin.com/">here</a>.
-http://www.coreboot.org/Git
\ No newline at end of file
+@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.
+*/
Code Review / openocd.git / blobdiff