X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=HACKING;h=c1a6b0e8a17fb45f2750da611d38223765ce928d;hp=39d98bb96edc1a7f16fe2a7ff9b60e28dfd8aab0;hb=4c364b453488fb5d30c32dfb4f294c30d255d7bf;hpb=9388915dc62198b3653672584f81574bd94484a6 diff --git a/HACKING b/HACKING index 39d98bb96e..c1a6b0e8a1 100644 --- a/HACKING +++ b/HACKING @@ -77,7 +77,7 @@ patch: src/openocd -s ../tcl -f /path/to/openocd.cfg @endcode -Please consider performing these additonal checks where appropriate +Please consider performing these additional 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. @@ -148,7 +148,7 @@ wget http://openocd.zylin.com/tools/hooks/commit-msg mv commit-msg .git/hooks chmod +x .git/hooks/commit-msg @endcode - \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 @@ -160,7 +160,7 @@ git config --global user.email "john@smith.org" @endcode -# Work on your patches. Split the work into multiple small patches that can be reviewed and - applied seperately and safely to the OpenOCD + applied separately and safely to the OpenOCD repository. @code while(!done) {