Project

General

Profile

Gerrit » History » Version 101

neels, 12/17/2018 01:55 PM

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