X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=HACKING;h=395b5b3167c5ff09f7613f4ac06e3d7ad8315d36;hp=658aa76b592c13379584a2b9953eedf32438308d;hb=50c93152123feec0f0a063ffb18cd7d91069c115;hpb=0355d987938d57fcb50b2a9b39b0f89495403357

diff --git a/HACKING b/HACKING
index 658aa76b59..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 <username>
 @endcode
@@ -101,16 +106,19 @@ 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
 <blank line>
-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...
 <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
@@ -149,6 +157,13 @@ 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 <a href="http://openocd.zylin.com/">here</a>.
 */