projects
/
fw
/
openocd
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
flash/stm32h7x: fix FLASH_WPSN_PRG mask used for protection
[fw/openocd]
/
HACKING
diff --git
a/HACKING
b/HACKING
index b7ef0705b0da81cd4b9a31dcf4e1fd77fb366202..cf3f58906064381952c45a52c9494faf8a0aa5ce 100644
(file)
--- a/
HACKING
+++ b/
HACKING
@@
-77,7
+77,7
@@
patch:
src/openocd -s ../tcl -f /path/to/openocd.cfg
@endcode
src/openocd -s ../tcl -f /path/to/openocd.cfg
@endcode
-Please consider performing these additonal checks where appropriate
+Please consider performing these addit
i
onal 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.
(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
@section stepbystep Step by step procedure
--# Create a Gerrit account at: http
://openocd.zylin.com
+-# Create a Gerrit account at: http
s://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.
- 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
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 config remote.review.push HEAD:refs/
publish
/master
+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
@endcode
Or with http only:
@code
-git remote add review http
://USERNAME@openocd.zylin.com
/p/openocd.git
-git config remote.review.push HEAD:refs/
publish
/master
+git remote add review http
s://USERNAME@review.openocd.org
/p/openocd.git
+git config remote.review.push HEAD:refs/
for
/master
@endcode
@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 - http
s://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
\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 http
s://USERNAME:PASSWORD@review.openocd.org
/p/openocd.git
@endcode
@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
-# 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
@endcode
Or with http only:
@code
-wget http
://openocd.zylin.com
/tools/hooks/commit-msg
+wget http
s://review.openocd.org
/tools/hooks/commit-msg
mv commit-msg .git/hooks
chmod +x .git/hooks/commit-msg
@endcode
mv commit-msg .git/hooks
chmod +x .git/hooks/commit-msg
@endcode
- \note A script exists to simplify the two items above.
e
xecute:
+ \note A script exists to simplify the two items above.
E
xecute:
@code
tools/initial.sh <username>
@endcode
@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
@endcode
-# Work on your patches. Split the work into
multiple small patches that can be reviewed and
- applied sep
e
rately and safely to the OpenOCD
+ applied sep
a
rately and safely to the OpenOCD
repository.
@code
while(!done) {
repository.
@code
while(!done) {
@@
-224,10
+228,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
- 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="http
s://review.openocd.org
/">here</a>.
@section reviewing Reviewing Patches
@section reviewing Reviewing Patches
-From the main <a href="http
://openocd.zylin.com
/#/q/status:open,n,z">Review
+From the main <a href="http
s://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"
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"