Project

General

Profile

Gerrit » History » Version 39

neels, 07/12/2016 01:06 PM

1 1 zecke
h1. Contributing using Gerrit
2
3 11 laforge
{{>toc}}
4
5 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
6 1 zecke
7 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/
8 1 zecke
9 10 laforge
The advantages of Gerrit are:
10
* patch submission status is automatically tracked, also with several revisions for a patch set.
11
* patches are build-tested (and possibly even further tested) by jenkins before they are applied
12
* developers + maintainers can formally vote on a patch (developer: -1/0/+1, maintainer: -2/0/+2)
13
* once a patch has +2 score, it can be (automatically) merged into master
14
* patch sumissions not via git send-email but direcly from git
15
16
h2. Osmocom Subprojects using Gerrit
17
18 1 zecke
The following projects use Gerrit to contribute changes:
19
20
* libosmocore.git
21
* libosmo-abis.git
22
* libosmo-netif.git
23
* libosmo-sccp.git
24
* libsmpp34.git
25
* openbsc.git
26
* osmo-bts.git
27
* osmo-iuh.git
28
* osmo-pcu.git
29 5 zecke
* cellmgr-ng.git
30 1 zecke
* osmo-sip-connector.git
31 30 neels
32 1 zecke
h2. Configuring Gerrit/Account
33
34 10 laforge
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. If you have no Osmocom redmine account, you can simply create one online at the "Register" link in the upper right corner.
35
36
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
38
After the initial sign-up you will need to:
39 1 zecke
40
* Pick a username (can not be changed)
41
* Add your public ssh key(s)
42
* Add email addresses you intend to use as author/comitter
43 30 neels
44
If you would like to push private branches to the Gerrit repository, you also need to be added to the "known users" group.
45
Please send a short requesting email to openbsc@lists.osmocom.org.
46 1 zecke
47
h2. Setting up Gerrit for commits and pushing
48
49 33 neels
*Note:* it is easiest to work with gerrit when gerrit is the only remote in your git clone.
50
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
to clone from gerrit only.
54 33 neels
55
h3. Simplest: new clone
56
57 35 neels
* Create a new clone from gerrit
58
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
59 33 neels
<pre>
60
git clone ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
61
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg $PROJECT/.git/hooks/
62
</pre>
63
64
h3. SSH config
65
66
In '~/.ssh/config', add these lines:
67
<pre>
68
Host foo
69
Hostname gerrit.osmocom.org
70
Port 29418
71
User $USERNAME
72
</pre>
73
(replace 'foo' with your favorite shortcut name,
74
replace '$USERNAME' with your user name as used on the gerrit website)
75
76
Then you can shorten above commands to
77 1 zecke
<pre>
78 33 neels
git clone ssh://foo/$PROJECT.git
79 35 neels
scp foo:hooks/commit-msg $PROJECT/.git/hooks/
80 33 neels
</pre>
81
82
h3. Add gerrit to an existing clone
83
84 7 neels
* Add the remote to be able to fetch and push to gerrit
85
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
86
87
<pre>
88
USERNAME=gerrit_user_name
89
PROJECT=$(basename $PWD)
90
git remote add gerrit ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
91
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg .git/hooks/
92
</pre>
93
94 33 neels
h2. Push for review
95 1 zecke
96 38 neels
Checkout the revision or branch that you want to submit for review, then
97
98 31 neels
<pre>
99 1 zecke
git push gerrit HEAD:refs/for/master
100
</pre>
101 38 neels
102
You can optionally add a topic name with
103
104
<pre>
105
git push gerrit HEAD:refs/for/master/my_topic
106
</pre>
107
108
109 1 zecke
110 33 neels
h2. Push a "private" user branch
111
112
*Note* that you must be a member of the "known users" group, see above.
113
114
If gerrit is your only remote, and if your local branch name is of the
115
form 'yourname/topic', you can just
116 1 zecke
<pre>
117 33 neels
git push
118 1 zecke
</pre>
119 33 neels
(and git will tell you what to do)
120 1 zecke
121 33 neels
If you have other remotes as well, do
122 1 zecke
<pre>
123 33 neels
git push gerrit
124 31 neels
</pre>
125 7 neels
126 33 neels
To push with a "nonstandard" local branch name, do
127
<pre>
128
git push gerrit HEAD:refs/heads/$USERNAME/topic
129
</pre>
130 39 neels
(If gerrit is your only remote, use 'git push origin ...' instead)
131 33 neels
132
h2. List changesets in gerrit
133 39 neels
134
If gerrit is your only remote:
135
136
<pre>
137
git ls-remote origin changes/*
138
</pre>
139
140
or, if you've added gerrit as a second remote:
141
142 7 neels
<pre>
143
git ls-remote gerrit changes/*
144 2 zecke
</pre>
145 12 msuraev
146 17 neels
h1. Tips and Tricks
147 1 zecke
148 17 neels
h2. Throw-away branch
149
150
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),
151
make your changes/amendments and than send patch(es) back to gerrit while removing temporary branch automatically with "git review -f".
152 13 neels
153 25 neels
h2. Re-submit a Branch with Amended Commits
154 13 neels
155 1 zecke
On a feature branch, one typically has numerous commits that depend on their preceding commits.
156 29 neels
Often, some of the branch commits need to be amended for fixes. But, Gerrit will refuse your branch
157
re-submission if the first branch commit is unchanged.
158 1 zecke
159 16 neels
To re-submit a branch, make sure to cosmetically tweak the branch's first commit log message
160 22 neels
before each re-submission (keep the Change-Id, really make just a cosmetic change).
161 13 neels
162 16 neels
<pre>
163
git rebase -i master
164
# replace the first line's 'pick' with 'r' (or 'reword'), exit editor
165
# git presents you with commit log message, make any tiny modification.
166 1 zecke
</pre>
167
168 29 neels
The cause: Gerrit refuses to accept a commit with a Change-Id that it already knows and
169
where the commit hash is identical.
170 1 zecke
171 29 neels
If you just cosmetically tweak the first commit's log message, the commit hash
172
is changed. Since the following commits contain their predecessor's commit hash, now
173
all of the branch's commit hashes are modified, and gerrit happily accepts them as a 
174
new patch set. It will still pick up the Change-Ids (which you shouldn't edit) and 
175
notice if commits have remained identical (keeping the votes). But with the minor
176
commit log tweak, it will no longer thwart your re-submission with an error message.
177
178
Note: you could modify all the Change-Ids, but now your branch submission would
179
open entirely new review entries and you would have to abandon your previous submission.
180
Comments on the first submission are lost and you cannot diff between patch sets.
181
182
183 26 neels
h2. Re-submit Previously Abandoned Changes
184 16 neels
185
You have to edit the Change-Ids, on a branch that would be every single commit log message.
186
187 13 neels
<pre>
188 1 zecke
cd openbsc
189
git co my-branch
190
git rebase -i master
191
# replace all 'pick' with 'r' (or 'reword'), exit your editor
192 13 neels
# git presents each commit log message for editing
193
</pre>
194
195 27 neels
h2. Submit a "private" branch for master
196 21 neels
197
If you've pushed a branch to refs/heads/* somewhere, gerrit will already know the Change-Ids on it.
198 24 neels
Make sure the option [[Gerrit#Private-Branches-Create-a-new-change-for-every-commit|Create a new change for every commit not in the target branch]] is _TRUE_ for your project,
199 21 neels
or gerrit will refuse to accept your submission.
200
201 16 neels
h1. Reasons for Particular Configuration
202 13 neels
203 16 neels
h2. Rebase if necessary
204
205
There are different merge strategies that Gerrit performs to accept patches.
206 13 neels
Each project can be configured to a specific merge strategy, but unfortunately you can't
207
decide on a strategy per patch submission.
208
209
It seems that the "Merge if Necessary" strategy is best supported, but it creates non-linear
210
history with numerous merge commits that are usually not at all necessary.
211
212
Instead, the "Cherry Pick" strategy puts each patch onto current master's HEAD to create
213
linear history. However, this will cause merge failures as soon as one patch depends on
214
another submitted patch, as typical for a feature branch submission.
215
216 1 zecke
So we prefer the "Rebase if Necessary" strategy, which always tries to apply your patches to
217 13 neels
the current master HEAD, in sequence with the previous patches on the same branch.
218
However, some problems still remain, including some bugs in "Rebase if Necessary".
219 1 zecke
220 13 neels
There's a problem with "Rebase if Necessary": If your branch sits at master's HEAD, Gerrit
221
refuses to accept the submission, because it thinks that no new changes are submitted.
222
This is a bug in Gerrit, which holger has fixed manually in our Gerrit installation:
223 1 zecke
224
https://bugs.chromium.org/p/gerrit/issues/detail?id=4158
225
226
227 16 neels
h2. Private Branches: Create a new change for every commit...
228 1 zecke
229 13 neels
Say you have an extensive feature in development, and you want to keep it on the
230
upstream git repository to a) keep it safe and b) collaborate with other devs on it.
231 16 neels
So, of course, you have regularly pushed to refs/heads/yoyodyne/feature.
232 13 neels
233
Since you have the gerrit commit hook installed, your feature branch already has
234
Change-Id tags in all commit log messages.
235
236
Now your feature is complete and you would like to submit it to master.
237
Alas, Gerrit refuses to accept your patch submission for master, because it
238
knows the Change-Ids are also on a different branch.
239
240 16 neels
Gerrit by default enforces that a Change-Id must be unique across all branches,
241
so that each submission for review is separate for each branch. Instead, we
242
want to handle Change-Ids per-branch, so that you can have the same change
243
submitted to different branches, as separate patch submissions, without having
244
to cosmetically adjust the Change-Id.
245 13 neels
246 16 neels
Solution: set the option 
247
_Create a new change for every commit not in the target branch_ to _TRUE_
248 13 neels
249 20 neels
h2. Allow content merges
250 14 neels
251
By default, gerrit compares patches only by the files' paths. If two paths are the same,
252
it immediately shows them as conflicts (path conflicts).
253
254
In software development, a conflict usually means an actual content conflict, so if the
255
edits are in two entirely separate places in the file, we don't consider this a conflict.
256
257 23 neels
By setting _Allow content merges_ to _TRUE_ in the git project config, we tell Gerrit to
258 14 neels
perform text merges of the submitted patches and only complain about actual content
259
conflicts, in the usual software engineering sense.
260 32 neels
261
h1. Admin
262
263
h2. Adding users to groups
264
265
Normally, the gerrit UI auto-completes a user name in the edit field. It has happened
266
though that an existing user is not auto-completed, as if it didn't exist. In that case,
267
find out the user ID (seven digit number like 1000123) and just enter that.
268
269
The user ID can be found on the user's "Settings" page, or in the database (s.b.).
270
271
h2. Querying the database directly
272
273
If your user has permission to access the database, you can place SQL queries using the
274
'gerrit gsql' commands over ssh:
275
276
<pre>
277
ssh -p 29418 $USERNAME@gerrit.osmocom.org 'gerrit gsql --format PRETTY -c "show tables"'
278
ssh -p 29418 $USERNAME@gerrit.osmocom.org 'gerrit gsql --format PRETTY -c "select full_name,account_id from accounts"'
279
</pre>
280
281
This seems to be the MySQL dialect.
Add picture from clipboard (Maximum size: 48.8 MB)