Project

General

Profile

Gerrit » History » Version 102

stsp, 12/18/2018 04:45 PM
move voting rules section as-is to a subsection further down

1 99 fixeria
2 99 fixeria
{{>toc}}
3 93 neels
4 1 zecke
h1. Contributing using Gerrit
5 11 laforge
6 10 laforge
At [[OpenBSC:OsmoDevCon2016]] we discussed problems with our past contribution / patch submission process using mails on the mailing list as well as patchwork.  The result is that we want to give Gerrit a try for some time and see if it helps us to have a better process
7 1 zecke
8 10 laforge
Gerrit is a review tool that integrates nicely with git and ssh. You can find general information about Gerrit at https://www.gerritcodereview.com/
9 1 zecke
10 10 laforge
The advantages of Gerrit are:
11 10 laforge
* patch submission status is automatically tracked, also with several revisions for a patch set.
12 10 laforge
* patches are build-tested (and possibly even further tested) by jenkins before they are applied
13 10 laforge
* developers + maintainers can formally vote on a patch (developer: -1/0/+1, maintainer: -2/0/+2)
14 10 laforge
* once a patch has +2 score, it can be (automatically) merged into master
15 10 laforge
* patch sumissions not via git send-email but direcly from git
16 10 laforge
17 10 laforge
h2. Osmocom Subprojects using Gerrit
18 10 laforge
19 73 laforge
The majority of Osmocom sub-projects have chosen to use Gerrit for patch review.  In order to check if a given program uses Gerrit, please check the auto-generated list at https://gerrit.osmocom.org/#/admin/projects/
20 1 zecke
21 75 laforge
If the project is listed there, then it uses Gerrit.   If the project is not listed there, please send patches by e-mail to the respective project [[Mailing_Lists]] instead.
22 30 neels
23 1 zecke
h2. Configuring Gerrit/Account
24 1 zecke
25 54 neels
You will need to sign-up at https://gerrit.osmocom.org/login/. If you have an Osmocom Redmine account you can use https://osmocom.org/openid as OpenID provider.
26 1 zecke
27 68 neels
* first sign in on https://osmocom.org. Do this before logging in on gerrit (the redmine login process loses the gerrit login data and you'd have to do the same thing twice if not logged in on osmocom.org already).
28 55 neels
* go to https://gerrit.osmocom.org and click the "Sign in" link.
29 68 neels
* click the "Sign in with Osmocom":https://gerrit.osmocom.org/login/%23%2Fq%2Fstatus%3Aopen?id=https://osmocom.org/openid link (can be bookmarked). -- This is the same as entering https://osmocom.org/openid as OpenID provider and hitting the "Sign in" button.
30 61 neels
31 61 neels
*careful:* enter 'https' to ensure that your openid credentials are passed on encryptedly.
32 68 neels
*pitfall:* if you're logged in on 'projects.osmocom.org' (including the 'projects.' part), you should also use the openid provider: https://projects.osmocom.org/openid; the 'projects.' part may be omitted, what's important is that redmine login and OpenID URLs match. Also, decide for one of those URLs once, because when picking a different OpenID URL next time, you will create a new user instead of logging in as yourself.
33 61 neels
*note:* gerrit will create a distinct user for each openid URL you pass. If you logged in successfully but your user seems to have lost permissions, you may have created an evil twin user: contact us on the mailing list so we can fix it in the user database.
34 54 neels
35 54 neels
If you have no Osmocom redmine account, you can simply create one online at the "Register" link in the upper right corner.
36 10 laforge
Even without an existing or new redmine account, you should also be able to use any other OpenID provider to authenticate against gerrit (untested).
37 10 laforge
38 10 laforge
After the initial sign-up you will need to:
39 1 zecke
40 1 zecke
* Pick a username (can not be changed)
41 1 zecke
* Add your public ssh key(s)
42 1 zecke
* Add email addresses you intend to use as author/comitter
43 30 neels
44 30 neels
If you would like to push private branches to the Gerrit repository, you also need to be added to the "known users" group.
45 30 neels
Please send a short requesting email to openbsc@lists.osmocom.org.
46 1 zecke
47 1 zecke
h2. Setting up Gerrit for commits and pushing
48 1 zecke
49 33 neels
*Note:* it is easiest to work with gerrit when gerrit is the only remote in your git clone.
50 33 neels
When you clone from git.osmocom.org and add the gerrit remote, git will have two remotes,
51 36 neels
so when you first checkout a branch you have to supply the remote explicitly (cumbersome).
52 34 neels
The gerrit repositories and git.osmocom.org are constantly synced, so it is sufficient
53 34 neels
to clone from gerrit only.
54 33 neels
55 33 neels
h3. Simplest: new clone
56 33 neels
57 35 neels
* Create a new clone from gerrit
58 35 neels
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
59 42 neels
60 33 neels
<pre>
61 33 neels
git clone ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
62 33 neels
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg $PROJECT/.git/hooks/
63 33 neels
</pre>
64 33 neels
65 33 neels
h3. SSH config
66 33 neels
67 33 neels
In '~/.ssh/config', add these lines:
68 33 neels
<pre>
69 52 neels
Host go
70 33 neels
Hostname gerrit.osmocom.org
71 33 neels
Port 29418
72 33 neels
User $USERNAME
73 33 neels
</pre>
74 52 neels
('go' means gerrit.osmocom, replace with your favorite shortcut name,
75 33 neels
replace '$USERNAME' with your user name as used on the gerrit website)
76 33 neels
77 33 neels
Then you can shorten above commands to
78 1 zecke
<pre>
79 52 neels
git clone ssh://go/$PROJECT.git
80 51 neels
cd $PROJECT
81 51 neels
scp go:hooks/commit-msg .git/hooks/
82 33 neels
</pre>
83 33 neels
84 1 zecke
h3. Committer must match
85 46 neels
86 1 zecke
Your email address on gerrit and the email address git places in your
87 46 neels
commits must match, or you will get rejected with an error message like
88 1 zecke
"invalid commiter". You can add email addresses on the gerrit web UI.
89 47 neels
90 1 zecke
h3. Add gerrit to an existing clone
91 1 zecke
92 1 zecke
* Add the remote to be able to fetch and push to gerrit
93 46 neels
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
94 1 zecke
95 46 neels
<pre>
96 1 zecke
USERNAME=gerrit_user_name
97 1 zecke
PROJECT=$(basename $PWD)
98 1 zecke
git remote add gerrit ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
99 1 zecke
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg .git/hooks/
100 1 zecke
</pre>
101 1 zecke
102 1 zecke
h2. Push for review
103 1 zecke
104 1 zecke
Prerequisites:
105 1 zecke
106 1 zecke
* your user on gerrit has an SSH public key
107 1 zecke
* your patch is committed in your local clone
108 1 zecke
* the commit log message has a Change-Id (see 'commit-msg' hook above, and 'Tips and Tricks' below to add a Change-Id to a commit that lacks one.)
109 1 zecke
110 1 zecke
<pre>
111 1 zecke
git push $REMOTE $GITHASH:refs/for/$BRANCH/$TOPIC
112 1 zecke
</pre>
113 1 zecke
114 1 zecke
$REMOTE: from above instructions, that's either 'origin' (cloned from gerrit) or 'gerrit' (if you added a second remote).
115 1 zecke
$GITHASH: the committed patch to push, typically you're on your branch and simply push 'HEAD'.
116 1 zecke
$BRANCH: you will typically intend a patch to go to 'master'.
117 1 zecke
$TOPIC: an optional name you may choose.
118 1 zecke
119 1 zecke
For example, checkout the revision or branch that you want to submit for review,
120 1 zecke
i.e. the one where your patch or several patches are committed on top of the current master, then:
121 1 zecke
122 1 zecke
If you cloned directly from gerrit:
123 1 zecke
124 1 zecke
<pre>
125 1 zecke
git push origin HEAD:refs/for/master
126 1 zecke
</pre>
127 1 zecke
128 1 zecke
If you added 'gerrit' as a second remote to an existing clone:
129 1 zecke
130 1 zecke
<pre>
131 1 zecke
git push gerrit HEAD:refs/for/master
132 1 zecke
</pre>
133 1 zecke
134 1 zecke
You can optionally add a topic name with
135 1 zecke
136 1 zecke
<pre>
137 1 zecke
git push origin HEAD:refs/for/master/my_topic
138 1 zecke
</pre>
139 1 zecke
140 102 stsp
h2. Voting Rules for merging a patch to master
141 7 neels
142 102 stsp
Once you are a "Known User" on Gerrit (see below), please follow these voting rules:
143 44 neels
144 102 stsp
h3. Code Review ("CR")
145 77 neels
146 102 stsp
* Please review patches by others.
147 102 stsp
* Do not vote for your own patches (exceptions below).
148 102 stsp
* Before merging, each patch should receive at least two reviews that approve merging.
149 77 neels
150 102 stsp
When voting, please follow this social contract:
151 77 neels
152 102 stsp
* When you approve, vote CR +1.
153 102 stsp
* If there already is someone else's CR +1, you may also choose to vote CR +2.
154 102 stsp
* If the patch owner sees two or more CR +1, the patch owner may apply to self a CR +2.
155 102 stsp
* Once there is at least one CR +2 and one CR +1 vote, a patch may be merged ("Submit" button), except:
156 102 stsp
** If there are two -1 votes, you should not merge, instead clarify the reason and try to fix it.
157 102 stsp
** If there is a single -1 vote, you may still merge the patch, if you are sure that the opinion of the -1 vote does not carry.
158 102 stsp
* Give the benefit of the doubt to the -1 vote, do not lightheartedly overrule.
159 102 stsp
* If there is a CR -2 vote, the patch will likely never pass review, it marks a fundamental flaw.
160 102 stsp
* Merging a patch ("Submit" button) may be done by a reviewer or by the patch owner,
161 102 stsp
  But if there is any negative vote, rather leave merging up to the patch owner.
162 102 stsp
* If you remove a +1 vote, try to make sure that there are no other CR +2 votes left alone
163 102 stsp
  (to prevent accidental "Submit including parents"). If needed, ping other reviewer / admin on IRC.
164 102 stsp
  But try to vote +1 only when you're sure, hence this situation should be rare.
165 102 stsp
* To prevent merging of your own patch before some issue is resolved, consider marking it Work In Progress.
166 102 stsp
167 102 stsp
h4. Exceptions for Trivial / Urgent Patches
168 102 stsp
169 102 stsp
A patch may receive a direct +2 when:
170 102 stsp
171 102 stsp
* it is very trivial, like a typo fix in a comment or log string, so that it is not worth wasting review time on.
172 102 stsp
* it reverts an earlier change that broke the master builds.
173 102 stsp
174 102 stsp
In these cases, the patch submitter may decide to +2 to self, after careful consideration. This should be rare.
175 102 stsp
176 102 stsp
h3. Verification ("V")
177 102 stsp
178 102 stsp
* For most projects, jenkins takes care of voting V +1 automatically.
179 102 stsp
* If you have actually tried out a patch and verified that it works, you may vote V +1.
180 102 stsp
* A patch owner may vote V +1 to self in a project that has no Jenkins verification job.
181 102 stsp
182 102 stsp
h3. Rationale
183 102 stsp
184 102 stsp
Gerrit allows merging a patch as soon as a CR +2 vote and a V +1 vote are in.
185 102 stsp
For quite some time, we had CR +2 permissions for only very few gatekeeper reviewers.
186 102 stsp
The result was that non-gatekeepers' votes seemed to not matter.
187 102 stsp
188 102 stsp
To encourage more peer review that actually has an effect, we would like to sum up +1 votes.
189 102 stsp
We have tried to apply a summing of votes in Gerrit with automatic enforcing
190 102 stsp
( https://gerrit-review.googlesource.com/Documentation/prolog-cookbook.html#_example_13_1_1_2_code_review )
191 102 stsp
but this had numerous quirks, particularly the issues summary shows wildly mismatching voting status.
192 102 stsp
193 102 stsp
The solution is to agree on a social contract: everyone gets +2 permissions,
194 102 stsp
but you shall only use it when it makes sense. Thanks!
195 102 stsp
196 1 zecke
197 84 neels
h2. Manage private branches
198 1 zecke
199 84 neels
Use a sub-directory with your name to group your own branches, please.
200 1 zecke
*Note* that you must be a member of the "known users" group, see above.
201 1 zecke
202 85 neels
To share / backup local branches to git.osmocom.org, without starting a code review process on gerrit.osmocom.org, just push them as usual to gerrit.
203 84 neels
204 84 neels
* Note that the git repository must be cloned from the gerrit SSH URL -- all pushing goes to gerrit ("pushurl" as described below also works).
205 84 neels
* All private branches are automatically synced to git.osmocom.org in a matter of minutes.
206 86 neels
* Private branches do not kick off patch sets for review, they are just branches. To kick off review for all patches on your branch, you'd use a 'refs/for/master' URL, as shown in the example below.
207 84 neels
208 84 neels
The typical transcript for "Fred" developing feature "Kazoo" looks like this:
209 84 neels
210 1 zecke
<pre>
211 84 neels
# Set up ~/.ssh/config so that 'go' points at gerrit.osmocom.org
212 84 neels
git clone ssh://go/libosmocore
213 84 neels
214 84 neels
cd libosmocore
215 84 neels
git checkout -b fred/kazoo   # create local branch
216 84 neels
217 84 neels
$EDITOR
218 84 neels
git add kazoo.c
219 84 neels
git commit -m "implement kazoo"
220 84 neels
221 84 neels
# just invoke 'git push' and git tells you how to create the branch once-off:
222 1 zecke
git push
223 84 neels
|fatal: The current branch asdf has no upstream branch.
224 84 neels
|To push the current branch and set the remote as upstream, use
225 84 neels
|
226 84 neels
|    git push --set-upstream origin fred/kazoo
227 1 zecke
228 84 neels
git push --set-upstream origin fred/kazoo
229 84 neels
# Now the branch exists on gerrit, very soon will also exist on git.osmocom.org
230 84 neels
231 84 neels
# Further tweaks
232 84 neels
$EDITOR
233 84 neels
git add kazoo.h
234 84 neels
git commit --amend
235 84 neels
236 84 neels
# You are free to force-push private branches
237 84 neels
git push -f
238 84 neels
239 84 neels
# origin/master has changed? Rebase onto the latest.
240 84 neels
git fetch
241 84 neels
git rebase -i origin/master
242 84 neels
# resolve conflicts...
243 84 neels
git push -f
244 84 neels
245 84 neels
# Feature is ready
246 84 neels
git push origin HEAD:refs/for/master/kazoo
247 39 neels
</pre>
248 7 neels
249 48 ahuemer
h2. List changesets in gerrit
250 2 zecke
251 12 msuraev
<pre>
252 17 neels
git ls-remote gerrit changes/*
253 1 zecke
</pre>
254 80 neels
255 80 neels
h1. Tips and Tricks
256 80 neels
257 80 neels
h2. A commit lacks a Change-Id
258 80 neels
259 80 neels
once you added the commit hook as above, just re-edit the commit log message, e.g. with
260 80 neels
261 80 neels
<pre>
262 80 neels
git commit --amend
263 80 neels
</pre>
264 80 neels
265 80 neels
or by
266 80 neels
267 80 neels
<pre>
268 80 neels
git rebase -i
269 80 neels
</pre>
270 80 neels
271 80 neels
and in the upcoming editor replacing 'pick' with 'r' in front of the commit to edit.
272 74 neels
273 74 neels
No need to change the commit log if you don't want to, just exit the editor and the commit hook will add a Change-Id.
274 79 neels
275 87 msuraev
h2. Ignore WIP patches
276 87 msuraev
277 87 msuraev
Using following operators in "search" field of web UI allows to ignore Work-in-progress changes:
278 87 msuraev
<pre>
279 87 msuraev
status:open AND -is:wip
280 87 msuraev
</pre>
281 87 msuraev
282 79 neels
h2. Fetch fast from git.osmocom.org, push to gerrit
283 79 neels
284 1 zecke
Gerrit has moved to a faster host, so this should no longer be necessary. Anyway...
285 74 neels
286 74 neels
Adding a second remote forces you to often pass the remote on the command line ("origin").
287 79 neels
It is possible to have only one remote for cmdline convenience, with differing push and pull URLs:
288 79 neels
289 74 neels
<pre>
290 1 zecke
git remote set-url origin git://git.osmocom.org/$PROJECT
291 74 neels
git remote set-url --push origin ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT
292 74 neels
</pre>
293 79 neels
294 74 neels
With above .ssh config you can also use the shorter ssh:// URL:
295 74 neels
<pre>
296 79 neels
git remote set-url --push origin ssh://go/$PROJECT
297 74 neels
</pre>
298 74 neels
299 74 neels
The resulting .git/config in libosmocore would look something like:
300 74 neels
<pre>
301 74 neels
[remote "origin"]
302 74 neels
        url = git://git.osmocom.org/libosmocore
303 74 neels
        pushurl = ssh://go/libosmocore
304 74 neels
        fetch = +refs/heads/*:refs/remotes/origin/*
305 74 neels
</pre>
306 17 neels
307 17 neels
Now you're fetching from git.osmocom.org, which is lightning fast, while pushing patches will still go to gerrit as usual.
308 17 neels
309 45 neels
h2. Throw-away branch
310 13 neels
311 56 neels
If you need to adjust and re-submit patches, it may be handy to create a throw-away branch ("R D" in magit-gerrit in emacs for example),
312 56 neels
make your changes/amendments and then send patch(es) back to gerrit while removing temporary branch automatically with "git review -f".
313 56 neels
314 56 neels
h2. Fetch a patch from gerrit
315 56 neels
316 56 neels
This script (I called it @P@) makes fetching a patch set from gerrit a breeze:
317 56 neels
<pre>
318 56 neels
#!/bin/sh
319 56 neels
# fetch gerrit patch into new branch named like the patch number.
320 56 neels
#
321 56 neels
# Usage: go to a git clone and pass a patch number:
322 56 neels
#
323 56 neels
#   cd openbsc
324 56 neels
#   P 973
325 56 neels
# or
326 56 neels
#   P 973/2
327 56 neels
#
328 56 neels
# Will create new local branches '973_4' (if 4 is the latest patch set)
329 56 neels
# or '973_2', respectively.
330 56 neels
331 56 neels
patch="$1"
332 56 neels
333 56 neels
if [ -z "$patch" ]; then
334 56 neels
  echo "Usage: P 1234[/5]"
335 56 neels
  exit 1
336 56 neels
fi
337 56 neels
338 56 neels
if [ -z "$(echo "$patch" | grep '/')" ]; then
339 56 neels
  patch="/$patch/"
340 56 neels
fi
341 56 neels
342 56 neels
if [ -z "$(echo "$patch" | grep '^/')" ]; then
343 56 neels
  patch="/$patch"
344 56 neels
fi
345 56 neels
346 56 neels
last_set="$(git ls-remote origin "changes/*" | grep "$patch" | sed 's#.*/\([^/]*\)$#\1 &#' | sort -n | tail -n 1)"
347 56 neels
if [ -z "$last_set" ]; then
348 56 neels
  echo "Not found: $patch"
349 56 neels
  exit 1
350 56 neels
fi
351 56 neels
352 56 neels
change_name="$(echo "$last_set" | sed 's/.*\(refs.*\)/\1/')"
353 56 neels
branch_name="$(echo "$change_name" | sed 's#refs/changes/../\([0-9]*\)/\([0-9]*\)#\1_\2#')"
354 56 neels
355 56 neels
set -x
356 56 neels
git fetch origin "$change_name"
357 25 neels
git co -b "$branch_name" FETCH_HEAD
358 13 neels
</pre>
359 1 zecke
360 58 neels
h2. Re-submit a Branch with Amended Commits
361 58 neels
362 22 neels
On a feature branch, one typically has numerous commits that depend on their preceding commits.
363 58 neels
Often, some of the branch commits need to be amended for fixes. You can re-submit changes to
364 58 neels
patches on your branch by pushing in the same way that you first submitted the branch.
365 58 neels
366 29 neels
Note: if you modify the Change-Ids in the commit logs, your push would open entirely new
367 58 neels
review entries and you would have to abandon your previous submission. Comments on the first
368 58 neels
submission are "lost" and you cannot diff between patch sets.
369 29 neels
370 29 neels
(There used to be a bug in gerrit that required editing the first patch to be able to
371 29 neels
re-submit a branch, but that's fixed.)
372 26 neels
373 1 zecke
374 1 zecke
375 1 zecke
h2. Re-submit Previously Abandoned Changes
376 1 zecke
377 1 zecke
You have to edit the Change-Ids, on a branch that would be every single commit log message.
378 1 zecke
379 1 zecke
<pre>
380 1 zecke
cd openbsc
381 1 zecke
git co my-branch
382 1 zecke
git rebase -i master
383 1 zecke
# replace all 'pick' with 'r' (or 'reword'), exit your editor
384 1 zecke
# git presents each commit log message for editing
385 1 zecke
</pre>
386 1 zecke
387 78 neels
h2. 502 Bad Gateway
388 78 neels
389 78 neels
When getting a "Bad Gateway" error message upon trying to login on gerrit, you probably just need to restart your web browser. The reason is not clear.
390 78 neels
391 78 neels
392 78 neels
h2. Commit hook: Always put Change-Id at the bottom of the log message
393 78 neels
394 78 neels
The commit-msg hook places a Change-Id tag in the footer, often above other tags like 'Depends:' or 'Related:'. Since the Change-Id is an implementation detail for Gerrit, I personally prefer it always placed right at the bottom. This simple edit changes the commit-msg hook to add Change-Id at the bottom unconditionally:
395 78 neels
396 78 neels
<pre>
397 78 neels
cd $PROJECT
398 78 neels
sed -i 's/if (unprinted /if (0 \&\& unprinted /' .git/hooks/commit-msg
399 78 neels
</pre>
400 78 neels
401 78 neels
The goal is to disable the condition in line 163 with an 'if (0...':
402 78 neels
403 78 neels
<pre>
404 78 neels
                        if (0 && unprinted && match(tolower(footer[line]), changeIdAfter) != 1) {
405 78 neels
                                unprinted = 0
406 78 neels
                                print "Change-Id: I'"$id"'"
407 78 neels
                        }
408 60 neels
</pre>
409 16 neels
410 13 neels
Then the Change-Id will be placed by line 170 instead.
411 16 neels
412 16 neels
h1. Reasons for Particular Configuration
413 16 neels
414 13 neels
h2. Rebase if necessary
415 13 neels
416 13 neels
There are different merge strategies that Gerrit performs to accept patches.
417 13 neels
Each project can be configured to a specific merge strategy, but unfortunately you can't
418 13 neels
decide on a strategy per patch submission.
419 13 neels
420 13 neels
It seems that the "Merge if Necessary" strategy is best supported, but it creates non-linear
421 13 neels
history with numerous merge commits that are usually not at all necessary.
422 13 neels
423 13 neels
Instead, the "Cherry Pick" strategy puts each patch onto current master's HEAD to create
424 1 zecke
linear history. However, this will cause merge failures as soon as one patch depends on
425 13 neels
another submitted patch, as typical for a feature branch submission.
426 13 neels
427 1 zecke
So we prefer the "Rebase if Necessary" strategy, which always tries to apply your patches to
428 13 neels
the current master HEAD, in sequence with the previous patches on the same branch.
429 13 neels
However, some problems still remain, including some bugs in "Rebase if Necessary".
430 13 neels
431 1 zecke
There's a problem with "Rebase if Necessary": If your branch sits at master's HEAD, Gerrit
432 1 zecke
refuses to accept the submission, because it thinks that no new changes are submitted.
433 1 zecke
This is a bug in Gerrit, which holger has fixed manually in our Gerrit installation:
434 1 zecke
435 16 neels
https://bugs.chromium.org/p/gerrit/issues/detail?id=4158
436 1 zecke
437 13 neels
438 13 neels
h2. Private Branches: Create a new change for every commit...
439 16 neels
440 13 neels
Say you have an extensive feature in development, and you want to keep it on the
441 13 neels
upstream git repository to a) keep it safe and b) collaborate with other devs on it.
442 13 neels
So, of course, you have regularly pushed to refs/heads/yoyodyne/feature.
443 13 neels
444 13 neels
Since you have the gerrit commit hook installed, your feature branch already has
445 13 neels
Change-Id tags in all commit log messages.
446 13 neels
447 13 neels
Now your feature is complete and you would like to submit it to master.
448 16 neels
Alas, Gerrit refuses to accept your patch submission for master, because it
449 16 neels
knows the Change-Ids are also on a different branch.
450 16 neels
451 16 neels
Gerrit by default enforces that a Change-Id must be unique across all branches,
452 16 neels
so that each submission for review is separate for each branch. Instead, we
453 13 neels
want to handle Change-Ids per-branch, so that you can have the same change
454 16 neels
submitted to different branches, as separate patch submissions, without having
455 16 neels
to cosmetically adjust the Change-Id.
456 13 neels
457 20 neels
Solution: set the option 
458 14 neels
_Create a new change for every commit not in the target branch_ to _TRUE_
459 14 neels
460 14 neels
h2. Allow content merges
461 14 neels
462 14 neels
By default, gerrit compares patches only by the files' paths. If two paths are the same,
463 14 neels
it immediately shows them as conflicts (path conflicts).
464 14 neels
465 23 neels
In software development, a conflict usually means an actual content conflict, so if the
466 14 neels
edits are in two entirely separate places in the file, we don't consider this a conflict.
467 14 neels
468 32 neels
By setting _Allow content merges_ to _TRUE_ in the git project config, we tell Gerrit to
469 32 neels
perform text merges of the submitted patches and only complain about actual content
470 32 neels
conflicts, in the usual software engineering sense.
471 72 laforge
472 72 laforge
h1. Admin
473 72 laforge
474 72 laforge
h2. Adding a new repository
475 72 laforge
476 72 laforge
* create the repository in the Gerrit Ui, inherit from "All-Projects"
477 72 laforge
* create an empty git repository using gitosis on git.osmcoom.org
478 88 osmith
* configure a jenkins build testing job for this project (see gerrit-verifications.yml in osmo-ci.git/jobs)
479 92 osmith
480 72 laforge
481 32 neels
git replication to gerrit.osmocom.org is enabled automatically, nothing to be done here.  In case of doubt, try
482 32 neels
@ssh -p 29418 gerrit.osmocom.org replication start --all --wait@
483 32 neels
484 32 neels
h2. Adding users to groups
485 32 neels
486 32 neels
Normally, the gerrit UI auto-completes a user name in the edit field. It has happened
487 32 neels
though that an existing user is not auto-completed, as if it didn't exist. In that case,
488 32 neels
find out the user ID (seven digit number like 1000123) and just enter that.
489 32 neels
490 32 neels
The user ID can be found on the user's "Settings" page, or in the database (s.b.).
491 32 neels
492 32 neels
h2. Querying the database directly
493 32 neels
494 32 neels
If your user has permission to access the database, you can place SQL queries using the
495 71 neels
'gerrit gsql' commands over ssh:
496 71 neels
497 1 zecke
<pre>
498 53 neels
ssh go "gerrit gsql -c \"show tables\""
499 53 neels
ssh go "gerrit gsql -c \"select full_name,account_id from accounts\""
500 1 zecke
</pre>
501 1 zecke
502 71 neels
(see ~/.ssh/config above for the 'go' shortcut)
503 71 neels
504 62 neels
This seems to be the MySQL dialect.
505 62 neels
506 62 neels
The "...\"...\"" quoting allows including single-quotes in the SQL statements.
507 62 neels
508 62 neels
h2. Fix evil twin users
509 62 neels
510 64 neels
If differing openid URLs have lead to evil twin users shadowing the same email address just without the permissions, you can fix it like this:
511 62 neels
512 62 neels
<pre>
513 62 neels
ssh go "gerrit gsql -c \"select * from account_external_ids where email_address like '%foo%'\""
514 62 neels
# ACCOUNT_ID | EMAIL_ADDRESS   | PASSWORD | EXTERNAL_ID
515 62 neels
# -----------+-----------------+----------+----------------------------------
516 64 neels
# 100004     | foo@example.com | NULL     | https://osmocom.org/openid/user/777
517 62 neels
# 100021     | foo@example.com | NULL     | https://projects.osmocom.org/openid/user/777
518 64 neels
519 62 neels
ssh go "gerrit gsql -c \"update account_external_ids set account_id = 100004 where email_address like '%foo%'\""
520 62 neels
521 62 neels
ssh go "gerrit gsql -c \"select * from account_external_ids where email_address like '%foo%'\""
522 62 neels
# ACCOUNT_ID | EMAIL_ADDRESS   | PASSWORD | EXTERNAL_ID
523 62 neels
# -----------+-----------------+----------+----------------------------------
524 1 zecke
# 100004     | foo@example.com | NULL     | https://osmocom.org/openid/user/777
525 1 zecke
# 100004     | foo@example.com | NULL     | https://projects.osmocom.org/openid/user/777
526 1 zecke
</pre>
Add picture from clipboard (Maximum size: 48.8 MB)