X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=HACKING;h=395b5b3167c5ff09f7613f4ac06e3d7ad8315d36;hp=d4f7a79f8ceec3e05092ff44e57d8397c7dcc556;hb=50c93152123feec0f0a063ffb18cd7d91069c115;hpb=57aa19f8460682a41f87b9f7d685278775fff6db diff --git a/HACKING b/HACKING index d4f7a79f8c..395b5b3167 100644 --- a/HACKING +++ b/HACKING @@ -1,10 +1,10 @@ // 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 +\attention 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. @@ -67,8 +67,13 @@ git config remote.review.push HEAD:refs/publish/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/publish/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 -# You will need to install this hook, we will look into a better solution: @code @@ -80,7 +85,7 @@ 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 @@ -101,7 +106,7 @@ 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