Project

General

Profile

Gerrit » History » Version 16

neels, 06/17/2016 04:30 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
 
32
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
44
h2. Setting up Gerrit for commits and pushing
45
46 2 zecke
* Add the remote to be able to fetch and push to gerrit
47
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
48
49
<pre>
50 7 neels
USERNAME=gerrit_user_name
51
PROJECT=$(basename $PWD)
52
git remote add gerrit ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
53
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg .git/hooks/
54
</pre>
55
56
* In case your local username matches the gerrit username, the setup shortens to
57
58
<pre>
59
PROJECT=$(basename $PWD)
60
git remote add gerrit ssh://gerrit.osmocom.org:29418/$PROJECT.git
61
scp -P 29418 gerrit.osmocom.org:hooks/commit-msg .git/hooks/
62
</pre>
63
64
Then
65
66
* Push for review
67
<pre>
68
git push gerrit HEAD:refs/for/master
69
</pre>
70
71
* Push a user branch
72
<pre>
73 9 neels
git push gerrit HEAD:refs/heads/users/$USERNAME/topic
74 7 neels
</pre>
75
76
* Directly push to master if you are allowed to
77
<pre>
78
git push gerrit HEAD:refs/heads/master
79
</pre>
80
81
* List changesets in gerrit
82
<pre>
83
git ls-remote gerrit changes/*
84 2 zecke
</pre>
85 12 msuraev
86
h2. Tips and Tricks
87
88
If you need to adjust and re-submit patches the easiest way is to create throw-away branch ("R D" in magit-gerrit in emacs for example), make you changes/amendments and than send patch(es) back to gerrit while removing temporary branch automatically with "git review -f".
89 13 neels
90
h2. Submitting Branches
91
92
On a feature branch, one typically has numerous commits that depend on their preceding commits.
93 16 neels
Unfortunately, Gerrit has some pitfalls with those. Here are solutions and details:
94 1 zecke
95 16 neels
h3. Re-submit a Branch with Amended Commits
96 1 zecke
97 16 neels
To re-submit a branch, make sure to cosmetically tweak the branch's first commit log message
98
before each re-submission (keep the Change-Id, really just a cosmetic change).
99 13 neels
100 16 neels
<pre>
101
git rebase -i master
102
# replace the first line's 'pick' with 'r' (or 'reword'), exit editor
103
# git presents you with commit log message, make any tiny modification.
104
</pre>
105 1 zecke
106 16 neels
(For a detailed explanation, see below under "Amending a Submitted Branch, First Commit Unchanged")
107
108
h3. Re-submit Previously Abandoned Changes
109
110
You have to edit the Change-Ids, on a branch that would be every single commit log message.
111
112 13 neels
<pre>
113 1 zecke
cd openbsc
114
git co my-branch
115
git rebase -i master
116
# replace all 'pick' with 'r' (or 'reword'), exit your editor
117 13 neels
# git presents each commit log message for editing
118
</pre>
119
120 16 neels
h1. Reasons for Particular Configuration
121 13 neels
122 16 neels
h2. Rebase if necessary
123
124
There are different merge strategies that Gerrit performs to accept patches.
125 13 neels
Each project can be configured to a specific merge strategy, but unfortunately you can't
126
decide on a strategy per patch submission.
127
128
It seems that the "Merge if Necessary" strategy is best supported, but it creates non-linear
129
history with numerous merge commits that are usually not at all necessary.
130
131
Instead, the "Cherry Pick" strategy puts each patch onto current master's HEAD to create
132
linear history. However, this will cause merge failures as soon as one patch depends on
133 1 zecke
another submitted patch, as typical for a feature branch submission.
134 13 neels
135
So we prefer the "Rebase if Necessary" strategy, which always tries to apply your patches to
136
the current master HEAD, in sequence with the previous patches on the same branch.
137
However, some problems still remain, including some bugs in "Rebase if Necessary".
138
139 1 zecke
There are in general three problems with "Rebase if Necessary", with different solutions:
140 13 neels
141 16 neels
h3. Fast-Forward
142 13 neels
143
If your branch sits at master's HEAD, Gerrit may refuse to accept the submission, because
144
it thinks that no new changes are submitted. This is a bug in Gerrit, which holger has
145
fixed manually in our Gerrit installation.
146
147
https://bugs.chromium.org/p/gerrit/issues/detail?id=4158
148
149
150 16 neels
h3. Amending a Submitted Branch, First Commit Unchanged
151 13 neels
152
Say you have submitted a branch with 5 commits, and the third commit has gotten a -1 vote.
153
You have fixed the problem in your local git and now would like to re-submit it. Of course
154
you want to keep the Change-Ids identical so that Gerrit shows them as amends.
155
156
Gerrit will refuse to accept your patch submission if the first commit on the branch is
157
still identical.
158
159
The quickest work-around: slightly reword the first branch commit's commit log message.
160
Yes, that's enough! All commits that are identical on the branch are now ignored,
161
it's only the first branch commit that Gerrit will complain about.
162
163
The cause: Gerrit refuses to accept a commit with a Change-Id that it already knows and
164
where the commit hash is identical.
165 1 zecke
166 13 neels
Some details: you could modify all the Change-Ids, but now your branch submission would
167
open entirely new review entries and you would have to abandon your previous submission.
168 1 zecke
Comments on the first submission are lost and you cannot diff between patch sets.
169 13 neels
Now, if you just cosmetically tweak the first commit's log message, the commit hash
170
is changed. Since the following commits contain their predecessor's commit hash, now
171
all of the branch's commit hashes are modified, and gerrit happily accepts them as a 
172 1 zecke
new patch set. It will still pick up the Change-Ids (which you shouldn't edit) and 
173
notice if commits have remained identical (keeping the votes). But with the minor
174
commit log tweak, it will no longer thwart your re-submission with an error message.
175
176
177 16 neels
h2. Private Branches: Create a new change for every commit...
178 1 zecke
179 13 neels
Say you have an extensive feature in development, and you want to keep it on the
180
upstream git repository to a) keep it safe and b) collaborate with other devs on it.
181 16 neels
So, of course, you have regularly pushed to refs/heads/yoyodyne/feature.
182 13 neels
183
Since you have the gerrit commit hook installed, your feature branch already has
184
Change-Id tags in all commit log messages.
185
186
Now your feature is complete and you would like to submit it to master.
187
Alas, Gerrit refuses to accept your patch submission for master, because it
188
knows the Change-Ids are also on a different branch.
189
190 16 neels
Gerrit by default enforces that a Change-Id must be unique across all branches,
191
so that each submission for review is separate for each branch. Instead, we
192
want to handle Change-Ids per-branch, so that you can have the same change
193
submitted to different branches, as separate patch submissions, without having
194
to cosmetically adjust the Change-Id.
195 13 neels
196 16 neels
Solution: set the option 
197
_Create a new change for every commit not in the target branch_ to _TRUE_
198 13 neels
199 14 neels
200
201
h2. Project Config Details
202
203
There are more non-obvious configuration items with Gerrit.
204
205
h3. Allow content merges
206
207
By default, gerrit compares patches only by the files' paths. If two paths are the same,
208
it immediately shows them as conflicts (path conflicts).
209
210
In software development, a conflict usually means an actual content conflict, so if the
211
edits are in two entirely separate places in the file, we don't consider this a conflict.
212
213
By setting 'Allow content merges' to TRUE in the git project config, we tell Gerrit to
214
perform text merges of the submitted patches and only complain about actual content
215
conflicts, in the usual software engineering sense.
Add picture from clipboard (Maximum size: 48.8 MB)