esp32s2: convert counted timeout to timeval_ms

[openocd.git] / HACKING

diff --git a/HACKING b/HACKING
index 86bfde5f66a19d9a9c213d3238a264a898850818..96b05f2d62b20e41818726e977ce406743f68069 100644 (file)
--- 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.
@@ -91,7 +91,7 @@ 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
+-# Create a Gerrit account at: https://review.openocd.org
   - 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.
@@ -121,30 +121,34 @@ Add yourself to the GPL copyright for non-trivial changes.
 to instruct git locally how to send off the changes.
   -# Add a new remote to git using Gerrit username:
 @code
-git remote add review ssh://USERNAME@openocd.zylin.com:29418/openocd.git
+git remote add review ssh://USERNAME@review.openocd.org:29418/openocd.git
 git config remote.review.push HEAD:refs/for/master
 @endcode
   Or with http only:
 @code
-git remote add review http://USERNAME@openocd.zylin.com/p/openocd.git
+git remote add review https://USERNAME@review.openocd.org/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.
+  The http password is configured from your gerrit settings - https://review.openocd.org/#/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
+git remote add review https://USERNAME:PASSWORD@review.openocd.org/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/
+scp -p -P 29418 USERNAME@review.openocd.org:hooks/commit-msg .git/hooks/
 @endcode
   Or with http only:
 @code
-wget http://openocd.zylin.com/tools/hooks/commit-msg
+wget https://review.openocd.org/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 <username>
 @endcode
@@ -156,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) {
@@ -167,11 +171,11 @@ while(!done) {
 @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
+   Commit message template, notice the short first line.
+   The field '<c>specify touched area</c>'
+   should identify the main part or subsystem the patch touches.
+@code{.unparsed}
+specify touched area: 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,
@@ -179,6 +183,32 @@ any major design decisions, etc...
 <blank line>
 Signed-off-by: ...
 @endcode
+   Examples:
+@code{.unparsed}
+flash/nor/atsame5: add SAME59 support
+
+Add new device ID
+@endcode
+@code{.unparsed}
+flash/nor: flash driver for XYZ123
+
+Add new flash driver for internal flash of ...
+@endcode
+@code{.unparsed}
+target/cortex_m: fix segmentation fault in cmd 'soft_reset_halt'
+
+soft_reset_halt command failed reproducibly under following conditions: ...
+Test for NULL pointer and return error ...
+
+Reported-by: John Reporter <rep9876@gmail.com>
+Fixes: 123456789abc ("target: the commit where the problem started")
+BugLink: https://sourceforge.net/p/openocd/tickets/999/
+@endcode
+@code{.unparsed}
+doc: fix typos
+@endcode
+   See "git log" for more examples.
+
 -# 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:
@@ -224,10 +254,10 @@ not have to) be disregarded if all conditions listed below are met:
 - 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>.
+All OpenOCD patches can be reviewed <a href="https://review.openocd.org/">here</a>.
 
 @section reviewing Reviewing Patches
-From the main <a href="http://openocd.zylin.com/#/q/status:open,n,z">Review
+From the main <a href="https://review.openocd.org/#/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"