Project

General

Profile

Gerrit » History » Version 98

neels, 12/14/2018 05:03 PM

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