X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=HACKING;h=39d98bb96edc1a7f16fe2a7ff9b60e28dfd8aab0;hp=9e7b92ac2294c46ca10dbe9a6af7aaa4f8ff8dda;hb=80ca927ebc2bb1ca18aff70215222d55c1f196f8;hpb=8e5ea23201033f25323db1f8604a8860129c017a diff --git a/HACKING b/HACKING index 9e7b92ac22..39d98bb96e 100644 --- a/HACKING +++ b/HACKING @@ -1,13 +1,20 @@ // This file is part of the Doxygen Developer Manual /** @page patchguide Patch Guidelines -@b NB! If you're behind a corporate wall with http only access to the -world, you can still use these instructions! - -@b NB2! You can't send patches to the mailing list anymore at all. Nowadays +\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 Link Another Identity 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 @@ -22,12 +29,58 @@ The procedure to create a patch is essentially: - 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 +issue, and make it 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 +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. +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 @@ -47,22 +100,22 @@ 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 for your specific platform: - - for Windows: http://help.github.com/win-set-up-git/#_set_up_ssh_keys - - for OSX: http://help.github.com/mac-set-up-git/#_set_up_ssh_keys - - for Linux: http://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. + -# 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://openocd.git.sourceforge.net/gitroot/openocd/openocd + 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://repo.or.cz/r/openocd.git + 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. @@ -73,9 +126,18 @@ git config remote.review.push HEAD:refs/for/master @endcode Or with http only: @code -git remote add review http://openocd.zylin.com/p/openocd.git +git remote add review http://USERNAME@openocd.zylin.com/p/openocd.git git config remote.review.push HEAD:refs/for/master @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/ @@ -86,11 +148,11 @@ wget http://openocd.zylin.com/tools/hooks/commit-msg mv commit-msg .git/hooks chmod +x .git/hooks/commit-msg @endcode -@b NOTE A script exists to simplify the two items above. execute: + \note A script exists to simplify the two items above. execute: @code tools/initial.sh @endcode -With being your Gerrit username. +With @ being your Gerrit username. -# Set up git with your name and email: @code git config --global user.name "John Smith" @@ -107,22 +169,25 @@ while(!done) { run tools/checkpatch.sh to verify your patch style is ok. } @endcode - @b TIP! use "git add ." before commit to add new files. + \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 ---- example comment, notice the short first line w/topic --- -topic: short comment +topic: Short comment -longer comments over several -lines... +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... 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 +git pull --rebase origin master @endcode -# Send the patches to the Gerrit server for review: @code @@ -140,7 +205,7 @@ Further reading: http://www.coreboot.org/Git 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. +time opportunity 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 @@ -154,6 +219,23 @@ 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. + +@section browsing Browsing Patches +All OpenOCD patches can be reviewed here. + +@section reviewing 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. */ /** @file This file contains the @ref patchguide page.