Project

General

Profile

Gerrit » History » Version 29

neels, 06/17/2016 04:57 PM

1 1 zecke
h1. Contributing using Gerrit
2 1 zecke
3 11 laforge
{{>toc}}
4 11 laforge
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 10 laforge
* patch submission status is automatically tracked, also with several revisions for a patch set.
11 10 laforge
* patches are build-tested (and possibly even further tested) by jenkins before they are applied
12 10 laforge
* developers + maintainers can formally vote on a patch (developer: -1/0/+1, maintainer: -2/0/+2)
13 10 laforge
* once a patch has +2 score, it can be (automatically) merged into master
14 10 laforge
* patch sumissions not via git send-email but direcly from git
15 10 laforge
16 10 laforge
h2. Osmocom Subprojects using Gerrit
17 10 laforge
18 1 zecke
The following projects use Gerrit to contribute changes:
19 1 zecke
20 1 zecke
* libosmocore.git
21 1 zecke
* libosmo-abis.git
22 1 zecke
* libosmo-netif.git
23 1 zecke
* libosmo-sccp.git
24 1 zecke
* libsmpp34.git
25 1 zecke
* openbsc.git
26 1 zecke
* osmo-bts.git
27 1 zecke
* osmo-iuh.git
28 1 zecke
* osmo-pcu.git
29 5 zecke
* cellmgr-ng.git
30 1 zecke
* osmo-sip-connector.git
31 1 zecke
 
32 1 zecke
h2. Configuring Gerrit/Account
33 1 zecke
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 10 laforge
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 1 zecke
44 1 zecke
h2. Setting up Gerrit for commits and pushing
45 1 zecke
46 2 zecke
* Add the remote to be able to fetch and push to gerrit
47 2 zecke
* Fetch the commit hook that adds Change-Id to each commit to uniquely identify a commit
48 2 zecke
49 2 zecke
<pre>
50 7 neels
USERNAME=gerrit_user_name
51 7 neels
PROJECT=$(basename $PWD)
52 7 neels
git remote add gerrit ssh://$USERNAME@gerrit.osmocom.org:29418/$PROJECT.git
53 7 neels
scp -P 29418 $USERNAME@gerrit.osmocom.org:hooks/commit-msg .git/hooks/
54 7 neels
</pre>
55 7 neels
56 7 neels
* In case your local username matches the gerrit username, the setup shortens to
57 7 neels
58 7 neels
<pre>
59 7 neels
PROJECT=$(basename $PWD)
60 7 neels
git remote add gerrit ssh://gerrit.osmocom.org:29418/$PROJECT.git
61 7 neels
scp -P 29418 gerrit.osmocom.org:hooks/commit-msg .git/hooks/
62 7 neels
</pre>
63 7 neels
64 7 neels
Then
65 7 neels
66 7 neels
* Push for review
67 7 neels
<pre>
68 7 neels
git push gerrit HEAD:refs/for/master
69 7 neels
</pre>
70 7 neels
71 7 neels
* Push a user branch
72 7 neels
<pre>
73 9 neels
git push gerrit HEAD:refs/heads/users/$USERNAME/topic
74 7 neels
</pre>
75 7 neels
76 7 neels
* Directly push to master if you are allowed to
77 7 neels
<pre>
78 7 neels
git push gerrit HEAD:refs/heads/master
79 7 neels
</pre>
80 7 neels
81 7 neels
* List changesets in gerrit
82 7 neels
<pre>
83 7 neels
git ls-remote gerrit changes/*
84 2 zecke
</pre>
85 12 msuraev
86 17 neels
h1. Tips and Tricks
87 1 zecke
88 17 neels
h2. Throw-away branch
89 17 neels
90 17 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),
91 17 neels
make your changes/amendments and than send patch(es) back to gerrit while removing temporary branch automatically with "git review -f".
92 13 neels
93 25 neels
h2. Re-submit a Branch with Amended Commits
94 13 neels
95 1 zecke
On a feature branch, one typically has numerous commits that depend on their preceding commits.
96 29 neels
Often, some of the branch commits need to be amended for fixes. But, Gerrit will refuse your branch
97 29 neels
re-submission if the first branch commit is unchanged.
98 1 zecke
99 16 neels
To re-submit a branch, make sure to cosmetically tweak the branch's first commit log message
100 22 neels
before each re-submission (keep the Change-Id, really make just a cosmetic change).
101 13 neels
102 16 neels
<pre>
103 16 neels
git rebase -i master
104 16 neels
# replace the first line's 'pick' with 'r' (or 'reword'), exit editor
105 16 neels
# git presents you with commit log message, make any tiny modification.
106 1 zecke
</pre>
107 1 zecke
108 29 neels
The cause: Gerrit refuses to accept a commit with a Change-Id that it already knows and
109 29 neels
where the commit hash is identical.
110 1 zecke
111 29 neels
If you just cosmetically tweak the first commit's log message, the commit hash
112 29 neels
is changed. Since the following commits contain their predecessor's commit hash, now
113 29 neels
all of the branch's commit hashes are modified, and gerrit happily accepts them as a 
114 29 neels
new patch set. It will still pick up the Change-Ids (which you shouldn't edit) and 
115 29 neels
notice if commits have remained identical (keeping the votes). But with the minor
116 29 neels
commit log tweak, it will no longer thwart your re-submission with an error message.
117 29 neels
118 29 neels
Note: you could modify all the Change-Ids, but now your branch submission would
119 29 neels
open entirely new review entries and you would have to abandon your previous submission.
120 29 neels
Comments on the first submission are lost and you cannot diff between patch sets.
121 29 neels
122 29 neels
123 26 neels
h2. Re-submit Previously Abandoned Changes
124 16 neels
125 16 neels
You have to edit the Change-Ids, on a branch that would be every single commit log message.
126 16 neels
127 13 neels
<pre>
128 1 zecke
cd openbsc
129 1 zecke
git co my-branch
130 1 zecke
git rebase -i master
131 1 zecke
# replace all 'pick' with 'r' (or 'reword'), exit your editor
132 13 neels
# git presents each commit log message for editing
133 13 neels
</pre>
134 13 neels
135 27 neels
h2. Submit a "private" branch for master
136 21 neels
137 21 neels
If you've pushed a branch to refs/heads/* somewhere, gerrit will already know the Change-Ids on it.
138 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,
139 21 neels
or gerrit will refuse to accept your submission.
140 21 neels
141 16 neels
h1. Reasons for Particular Configuration
142 13 neels
143 16 neels
h2. Rebase if necessary
144 16 neels
145 16 neels
There are different merge strategies that Gerrit performs to accept patches.
146 13 neels
Each project can be configured to a specific merge strategy, but unfortunately you can't
147 13 neels
decide on a strategy per patch submission.
148 13 neels
149 13 neels
It seems that the "Merge if Necessary" strategy is best supported, but it creates non-linear
150 13 neels
history with numerous merge commits that are usually not at all necessary.
151 13 neels
152 13 neels
Instead, the "Cherry Pick" strategy puts each patch onto current master's HEAD to create
153 13 neels
linear history. However, this will cause merge failures as soon as one patch depends on
154 13 neels
another submitted patch, as typical for a feature branch submission.
155 13 neels
156 1 zecke
So we prefer the "Rebase if Necessary" strategy, which always tries to apply your patches to
157 13 neels
the current master HEAD, in sequence with the previous patches on the same branch.
158 13 neels
However, some problems still remain, including some bugs in "Rebase if Necessary".
159 1 zecke
160 13 neels
There's a problem with "Rebase if Necessary": If your branch sits at master's HEAD, Gerrit
161 13 neels
refuses to accept the submission, because it thinks that no new changes are submitted.
162 13 neels
This is a bug in Gerrit, which holger has fixed manually in our Gerrit installation:
163 1 zecke
164 1 zecke
https://bugs.chromium.org/p/gerrit/issues/detail?id=4158
165 1 zecke
166 1 zecke
167 16 neels
h2. Private Branches: Create a new change for every commit...
168 1 zecke
169 13 neels
Say you have an extensive feature in development, and you want to keep it on the
170 13 neels
upstream git repository to a) keep it safe and b) collaborate with other devs on it.
171 16 neels
So, of course, you have regularly pushed to refs/heads/yoyodyne/feature.
172 13 neels
173 13 neels
Since you have the gerrit commit hook installed, your feature branch already has
174 13 neels
Change-Id tags in all commit log messages.
175 13 neels
176 13 neels
Now your feature is complete and you would like to submit it to master.
177 13 neels
Alas, Gerrit refuses to accept your patch submission for master, because it
178 13 neels
knows the Change-Ids are also on a different branch.
179 13 neels
180 16 neels
Gerrit by default enforces that a Change-Id must be unique across all branches,
181 16 neels
so that each submission for review is separate for each branch. Instead, we
182 16 neels
want to handle Change-Ids per-branch, so that you can have the same change
183 16 neels
submitted to different branches, as separate patch submissions, without having
184 16 neels
to cosmetically adjust the Change-Id.
185 13 neels
186 16 neels
Solution: set the option 
187 16 neels
_Create a new change for every commit not in the target branch_ to _TRUE_
188 13 neels
189 20 neels
h2. Allow content merges
190 14 neels
191 14 neels
By default, gerrit compares patches only by the files' paths. If two paths are the same,
192 14 neels
it immediately shows them as conflicts (path conflicts).
193 14 neels
194 14 neels
In software development, a conflict usually means an actual content conflict, so if the
195 14 neels
edits are in two entirely separate places in the file, we don't consider this a conflict.
196 14 neels
197 23 neels
By setting _Allow content merges_ to _TRUE_ in the git project config, we tell Gerrit to
198 14 neels
perform text merges of the submitted patches and only complain about actual content
199 14 neels
conflicts, in the usual software engineering sense.
Add picture from clipboard (Maximum size: 48.8 MB)