aboutsummaryrefslogtreecommitdiff
path: root/HACKING
AgeCommit message (Collapse)AuthorFilesLines
2023-12-10HACKING: fix how to retrieve hooks/commit-msgAntonio Borneo1-4/+0
Probably due to new version of gerrit, the download of the gerrit hooks via scp is not working anymore. Also the instructions available, after login, in https://review.openocd.org/admin/repos/openocd,general report that the hook file has to be downloaded via https also when the user want to use ssh for gerrit access. Drop scp in the suggestions to download the hook file and keep https download only. Change-Id: I0c8e5bb61ed8c7423a42a0d5d92866e071a814bb Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Reported-by: Rolf Nooteboom <rolf@Onethinx.com> Reviewed-on: https://review.openocd.org/c/openocd/+/8034 Tested-by: jenkins Reviewed-by: Paul Fertser <fercerpav@gmail.com>
2023-05-18HACKING: add info on usage of sparseAntonio Borneo1-0/+15
Add short example on how to run the static analyser 'sparse' on OpenOCD code. Change-Id: Ieba8ae926d0e02ca9e6ac619b13b0832136f82cb Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Reviewed-on: https://review.openocd.org/c/openocd/+/7679 Tested-by: jenkins
2022-09-18HACKING: add chapter on checkpatchAntonio Borneo1-1/+64
Include hints on how to skip some of the tests in some really exceptional case. Note: the file includes an example of commit message with a signed off tag that triggers a checkpatch error. Let checkpatch to ignore BAD_SIGN_OFF error. Checkpatch-ignore: BAD_SIGN_OFF Change-Id: I05bf0ab8008649f3f9b38452e056dc3df83a1a4f Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Reviewed-on: https://review.openocd.org/c/openocd/+/5609 Tested-by: jenkins
2022-05-17doc: prevent writing "topic:" to commit messageTomas Vanek1-5/+31
First time contributors surprisingly often write "topic:" instead of "the main part or subsystem the patch touches" as requested in patchguide.html To prevent them doing so: Use longer self-explaing "specify touched area" instead of "topic" Give some examples in addition to recommended looking at "git log" Change-Id: I1c307b460d7a79ba3c9918af8dbc9e9f827e1fb9 Signed-off-by: Tomas Vanek <vanekt@fbl.cz> Reviewed-on: https://review.openocd.org/c/openocd/+/6683 Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com> Tested-by: Paul Fertser <fercerpav@gmail.com>
2021-09-18gerrit url: update the gerrit server address to https://review.openocd.orgTarek BOCHKATI1-9/+9
change the gerrit server address from http://openocd.zylin.com to the new address in order to avoid re-directions. Change-Id: I76e128c277f63783d1a6f63a6a387aa838f51f80 Signed-off-by: Tarek BOCHKATI <tarek.bouchkati@gmail.com> Reviewed-on: https://review.openocd.org/c/openocd/+/6481 Tested-by: jenkins Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
2019-05-23HACKING: fix minor typosAntonio Borneo1-3/+3
s/additonal/additional/ s/seperately/separately/ Use uppercase after a '.' Change-Id: I933894ae44924363d634fa07d3de4ceeb4b329e2 Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Reviewed-on: http://openocd.zylin.com/5162 Tested-by: jenkins Reviewed-by: Jonathan McDowell <noodles-openocd@earth.li> Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
2019-01-08HACKING: add note about refs/for/masterJerome Forissier1-0/+4
The fact that one needs to always push contributions to a single remote reference (refs/for/master) might seem odd to people unfamiliar with Gerrit. GitHub, for instance, hosts personal repositories where developers typically create topic branches for each contribution and use a proprietary mecanism to request a review (the "pull request"). More generally, one normally does not expect to be able to push non-fast-forwarding stuff to a remote branch. This commit adds a clarifying note to the patch guidelines. Change-Id: Ia750b815b82b18e92b6109c07f451000dcbecf9b Signed-off-by: Jerome Forissier <jerome.forissier@linaro.org> Reviewed-on: http://openocd.zylin.com/4806 Tested-by: jenkins Reviewed-by: Christopher Head <chead@zaber.com> Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
2019-01-08HACKING: replace refs/publish/master with refs/for/masterJerome Forissier1-2/+2
refs/publish/master is deprecated and gives a warning in newer Gerrit. Replace with refs/for/master. Change-Id: I56871cc6e80c014ba81f4458230cd67dc318ecb3 Suggested-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Signed-off-by: Jerome Forissier <jerome.forissier@linaro.org> Reviewed-on: http://openocd.zylin.com/4810 Tested-by: jenkins Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
2018-11-10docs: fix typo in manualSpencer Oliver1-1/+1
Change-Id: I28717105eb2a907b0cb4b03f4b5ff1f47194413b Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/4751 Tested-by: jenkins Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
2018-04-09HACKING: document practices to improve code qualityPaul Fertser1-4/+50
Change-Id: I58a7d978b7d5bca3037c4535f06746b9f4411950 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/4343 Tested-by: jenkins
2018-03-13HACKING: clarify linking identities procedurePaul Fertser1-3/+10
Change-Id: I89e93002181926eec5fc5a339765b773559a8ff1 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/4354 Tested-by: jenkins Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
2014-11-24Hacking: Some note how to review.Uwe Bonnes1-0/+7
Change-Id: Ied682884abdba27da265f1ce3632417f54a80fe2 Signed-off-by: Uwe Bonnes <bon@elektron.ikp.physik.tu-darmstadt.de> Reviewed-on: http://openocd.zylin.com/2380 Tested-by: jenkins Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
2013-04-21Improve HACKINGFreddie Chopin1-2/+8
Reword info about creating SSH key - it's not required to add it to Github account. Mention adding created SSH key to Gerrit account - without this step it's not possible to access Gerrit in further steps. Change-Id: Ibd81521fbe47d4b4beae0b77cdc9d939fd3ee20c Signed-off-by: Freddie Chopin <freddie.chopin@gmail.com> Reviewed-on: http://openocd.zylin.com/1350 Tested-by: jenkins Reviewed-by: Paul Fertser <fercerpav@gmail.com>
2013-03-13docs: add gerrit http password urlSpencer Oliver1-2/+7
Add url to show where the http password is configured. Also add note that password can also be saved to url git config. Change-Id: I3c1a022580e5f73372b0c50e8d1d2f0b1498966f Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/1207 Tested-by: jenkins
2013-03-07docs: use doxygen keywords for formattingSpencer Oliver1-3/+3
Rather than use bold fonts etc, use the correct keywords so doxygen formats better. Change-Id: Id9d63f0fc3465665376d7a536c4d6da71998f40e Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/1210 Tested-by: jenkins Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com>
2013-02-28Update HACKING infoFreddie Chopin1-0/+7
Inform about possibility of discarding negative review in Gerrit when specific conditions are met. Change-Id: I432b6c93cefc368fa22ce1096bea4cd174e03816 Signed-off-by: Freddie Chopin <freddie.chopin@gmail.com> Reviewed-on: http://openocd.zylin.com/747 Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com> Tested-by: Øyvind Harboe <oyvindharboe@gmail.com>
2012-12-30doc: Clarify the topic field in the commit comment templateAndreas Fritiofson1-5/+8
Change-Id: Iea1f3b665b011ca3748800048039d3f6b33d7756 Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-on: http://openocd.zylin.com/1101 Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com> Reviewed-by: Tomasz CEDRO <cederom@tlen.pl> Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk> Tested-by: Spencer Oliver <spen@spen-soft.co.uk>
2012-11-16doc: update to new sourceforge git urlSpencer Oliver1-2/+2
The new sourceforge platform also supports http access, so use that rather then repo.or.cz. Change-Id: Ica89d9475847a2095c179b240053145795549802 Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/982 Tested-by: jenkins
2012-08-02Update link and instructions about ssh keys in HACKINGFreddie Chopin1-8/+2
Gitweb changed their instructions, info about ssh keys is now on separate page for all platforms (selector at top of the page). Change-Id: I3eab5dfae06cfb73f4a76718f92518454021e557 Signed-off-by: Freddie Chopin <freddie.chopin@gmail.com> Reviewed-on: http://openocd.zylin.com/768 Tested-by: jenkins Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
2012-04-20docs: update gerrit publish refsSpencer Oliver1-2/+2
since gerrit 2.3 pushing changes to refs/for/ is deprecated in favour of using refs/publish/. Change-Id: I6244b9645da2144921583bd9778a95c563fac89f Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/567 Tested-by: jenkins
2012-04-18HACKING: Fix instruction for git pull --rebaseBill Traynor1-1/+1
When following the Patch Guidelines step by step, an error occurs at step 6. "git pull --rebase origin/master" results in the error: fatal: 'origin/master' does not appear to be a git repository Removing the / seems to fix this. Change-Id: I4e2fa23c60654abeaebd3b25a8c8375aa07b0abd Signed-off-by: Bill Traynor <wmat@alphatroop.com> Signed-off-by: Peter Stuge <peter@stuge.se> Reviewed-on: http://openocd.zylin.com/574 Reviewed-by: David Anders <danders.dev@gmail.com> Tested-by: jenkins
2012-04-10doxygen: remove warningsSpencer Oliver1-1/+1
Change-Id: I020845a8df7b67f3b6c1a233b3ee07a5d14fa685 Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/556 Tested-by: jenkins
2012-04-04docs: add gerrit server urlSpencer Oliver1-0/+3
Change-Id: If39b522594a4ee3758fb85309af01f7a98c9f939 Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/553 Tested-by: jenkins
2012-04-04tools/initial.shUlf Samuelsson1-0/+5
Small script to setup Gerrit with the local repository Usage: tools/initial.sh <username> Change-Id: I26527c35cfe040c7752efec06064d5dc9e3ec6a2 Signed-off-by: Ulf Samuelsson <ulf@emagii.com> Signed-off-by: Attila Kinali <attila@kinali.ch> Reviewed-on: http://openocd.zylin.com/290 Tested-by: jenkins Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
2012-01-18doc: Update patch procedureTimo Ketola1-86/+96
Change-Id: I3e50357b4ddaf483712bbac68b6427b31529f666 Signed-off-by: Timo Ketola <timo@exertus.fi> Reviewed-on: http://openocd.zylin.com/387 Tested-by: jenkins Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com> Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
2011-12-12HACKING: add explanation why we want cool-off times as long as a week or twoØyvind Harboe1-1/+22
Change-Id: I281e9145f43bc7ac173e02c4e209834f0deaae2b Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com> Reviewed-on: http://openocd.zylin.com/254 Tested-by: jenkins Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-by: Mathias Küster <kesmtp@freenet.de> Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com>
2011-12-05HACKING - checkpatch before pushing makes life quickerrodrigo_l_rosa1-0/+1
Change-Id: I4c3cde2aae7bdea138413e373ac986be3efd54de Signed-off-by: rodrigo_l_rosa <rodrigorosa.lg@gmail.com> Reviewed-on: http://openocd.zylin.com/252 Tested-by: jenkins Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com>
2011-11-03HACKING: all you need is http accessØyvind Harboe1-4/+18
Change-Id: I191c1da5126c4c9ea1ff8826576b6b24feaf9881 Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com> Reviewed-on: http://openocd.zylin.com/157 Tested-by: jenkins Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com> Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
2011-10-15Add some more detail for setting up Gerrit account.Jim Norris1-0/+26
1) Add a couple more steps when setting up the Gerrit account. Change-Id: I5d81feac4650d4d28653d14cfc0baf14270424c1 Signed-off-by: Jim Norris <u17263@att.net> Reviewed-on: http://openocd.zylin.com/28 Reviewed-by: Peter Stuge <peter@stuge.se> Tested-by: Peter Stuge <peter@stuge.se>
2011-10-12docs: update HACKING to point to GerritØyvind Harboe1-17/+44
Change-Id: If79e86c731ac06aaefca1aebde40e7cb3de68e4d Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2011-06-12HACKING: add tip on how to write commentsØyvind Harboe1-0/+7
2011-03-30docs: add HACKING file to help users get started with patchesØyvind Harboe1-0/+49
Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
generated by cgit v1.1 at 2024-09-10 02:14:48 +0000