Gerrit » History » Version 22
neels, 06/17/2016 04:46 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 | 17 | neels | h1. Tips and Tricks |
87 | 1 | zecke | |
88 | 17 | neels | h2. Throw-away branch |
89 | |||
90 | 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 | 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 | h2. Submitting Branches |
||
94 | |||
95 | On a feature branch, one typically has numerous commits that depend on their preceding commits. |
||
96 | 16 | neels | Unfortunately, Gerrit has some pitfalls with those. Here are solutions and details: |
97 | 1 | zecke | |
98 | 16 | neels | h3. Re-submit a Branch with Amended Commits |
99 | 1 | zecke | |
100 | 16 | neels | To re-submit a branch, make sure to cosmetically tweak the branch's first commit log message |
101 | 22 | neels | before each re-submission (keep the Change-Id, really make just a cosmetic change). |
102 | 13 | neels | |
103 | 16 | neels | <pre> |
104 | git rebase -i master |
||
105 | # replace the first line's 'pick' with 'r' (or 'reword'), exit editor |
||
106 | # git presents you with commit log message, make any tiny modification. |
||
107 | </pre> |
||
108 | 1 | zecke | |
109 | 18 | neels | (For a detailed explanation, see below under [[Gerrit#Amending-a-Submitted-Branch-First-Commit-Unchanged|Amending a Submitted Branch, First Commit Unchanged]]) |
110 | 16 | neels | |
111 | h3. Re-submit Previously Abandoned Changes |
||
112 | |||
113 | You have to edit the Change-Ids, on a branch that would be every single commit log message. |
||
114 | |||
115 | 13 | neels | <pre> |
116 | 1 | zecke | cd openbsc |
117 | git co my-branch |
||
118 | git rebase -i master |
||
119 | # replace all 'pick' with 'r' (or 'reword'), exit your editor |
||
120 | 13 | neels | # git presents each commit log message for editing |
121 | </pre> |
||
122 | |||
123 | 21 | neels | h3. Submit a "private" branch for master |
124 | |||
125 | If you've pushed a branch to refs/heads/* somewhere, gerrit will already know the Change-Ids on it. |
||
126 | 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, |
||
127 | or gerrit will refuse to accept your submission. |
||
128 | |||
129 | |||
130 | 16 | neels | h1. Reasons for Particular Configuration |
131 | 13 | neels | |
132 | 16 | neels | h2. Rebase if necessary |
133 | |||
134 | There are different merge strategies that Gerrit performs to accept patches. |
||
135 | 13 | neels | Each project can be configured to a specific merge strategy, but unfortunately you can't |
136 | decide on a strategy per patch submission. |
||
137 | |||
138 | It seems that the "Merge if Necessary" strategy is best supported, but it creates non-linear |
||
139 | history with numerous merge commits that are usually not at all necessary. |
||
140 | |||
141 | Instead, the "Cherry Pick" strategy puts each patch onto current master's HEAD to create |
||
142 | linear history. However, this will cause merge failures as soon as one patch depends on |
||
143 | 1 | zecke | another submitted patch, as typical for a feature branch submission. |
144 | 13 | neels | |
145 | So we prefer the "Rebase if Necessary" strategy, which always tries to apply your patches to |
||
146 | the current master HEAD, in sequence with the previous patches on the same branch. |
||
147 | However, some problems still remain, including some bugs in "Rebase if Necessary". |
||
148 | |||
149 | 19 | neels | These are problems with "Rebase if Necessary", with different solutions: |
150 | 13 | neels | |
151 | 16 | neels | h3. Fast-Forward |
152 | 13 | neels | |
153 | If your branch sits at master's HEAD, Gerrit may refuse to accept the submission, because |
||
154 | it thinks that no new changes are submitted. This is a bug in Gerrit, which holger has |
||
155 | fixed manually in our Gerrit installation. |
||
156 | |||
157 | https://bugs.chromium.org/p/gerrit/issues/detail?id=4158 |
||
158 | |||
159 | |||
160 | 16 | neels | h3. Amending a Submitted Branch, First Commit Unchanged |
161 | 13 | neels | |
162 | Say you have submitted a branch with 5 commits, and the third commit has gotten a -1 vote. |
||
163 | You have fixed the problem in your local git and now would like to re-submit it. Of course |
||
164 | you want to keep the Change-Ids identical so that Gerrit shows them as amends. |
||
165 | |||
166 | Gerrit will refuse to accept your patch submission if the first commit on the branch is |
||
167 | still identical. |
||
168 | |||
169 | The quickest work-around: slightly reword the first branch commit's commit log message. |
||
170 | Yes, that's enough! All commits that are identical on the branch are now ignored, |
||
171 | it's only the first branch commit that Gerrit will complain about. |
||
172 | |||
173 | The cause: Gerrit refuses to accept a commit with a Change-Id that it already knows and |
||
174 | where the commit hash is identical. |
||
175 | 1 | zecke | |
176 | 13 | neels | Some details: you could modify all the Change-Ids, but now your branch submission would |
177 | open entirely new review entries and you would have to abandon your previous submission. |
||
178 | 1 | zecke | Comments on the first submission are lost and you cannot diff between patch sets. |
179 | 13 | neels | Now, if you just cosmetically tweak the first commit's log message, the commit hash |
180 | is changed. Since the following commits contain their predecessor's commit hash, now |
||
181 | all of the branch's commit hashes are modified, and gerrit happily accepts them as a |
||
182 | 1 | zecke | new patch set. It will still pick up the Change-Ids (which you shouldn't edit) and |
183 | notice if commits have remained identical (keeping the votes). But with the minor |
||
184 | commit log tweak, it will no longer thwart your re-submission with an error message. |
||
185 | |||
186 | 16 | neels | h2. Private Branches: Create a new change for every commit... |
187 | 1 | zecke | |
188 | 13 | neels | Say you have an extensive feature in development, and you want to keep it on the |
189 | upstream git repository to a) keep it safe and b) collaborate with other devs on it. |
||
190 | 16 | neels | So, of course, you have regularly pushed to refs/heads/yoyodyne/feature. |
191 | 13 | neels | |
192 | Since you have the gerrit commit hook installed, your feature branch already has |
||
193 | Change-Id tags in all commit log messages. |
||
194 | |||
195 | Now your feature is complete and you would like to submit it to master. |
||
196 | Alas, Gerrit refuses to accept your patch submission for master, because it |
||
197 | knows the Change-Ids are also on a different branch. |
||
198 | |||
199 | 16 | neels | Gerrit by default enforces that a Change-Id must be unique across all branches, |
200 | so that each submission for review is separate for each branch. Instead, we |
||
201 | want to handle Change-Ids per-branch, so that you can have the same change |
||
202 | submitted to different branches, as separate patch submissions, without having |
||
203 | to cosmetically adjust the Change-Id. |
||
204 | 13 | neels | |
205 | 16 | neels | Solution: set the option |
206 | _Create a new change for every commit not in the target branch_ to _TRUE_ |
||
207 | 13 | neels | |
208 | 20 | neels | h2. Allow content merges |
209 | 14 | neels | |
210 | By default, gerrit compares patches only by the files' paths. If two paths are the same, |
||
211 | it immediately shows them as conflicts (path conflicts). |
||
212 | |||
213 | In software development, a conflict usually means an actual content conflict, so if the |
||
214 | edits are in two entirely separate places in the file, we don't consider this a conflict. |
||
215 | |||
216 | By setting 'Allow content merges' to TRUE in the git project config, we tell Gerrit to |
||
217 | perform text merges of the submitted patches and only complain about actual content |
||
218 | conflicts, in the usual software engineering sense. |