]>
Commit | Line | Data |
---|---|---|
303d1d0b | 1 | #include "git-compat-util.h" |
6c6ddf92 | 2 | #include "advice.h" |
b2141fc1 | 3 | #include "config.h" |
e496c003 | 4 | #include "branch.h" |
32a8f510 | 5 | #include "environment.h" |
f394e093 | 6 | #include "gettext.h" |
41771fa4 | 7 | #include "hex.h" |
dabab1d6 | 8 | #include "object-name.h" |
c339932b | 9 | #include "path.h" |
e496c003 | 10 | #include "refs.h" |
ec0cb496 | 11 | #include "refspec.h" |
e496c003 | 12 | #include "remote.h" |
d1cbe1e6 | 13 | #include "repository.h" |
b07d9bfd | 14 | #include "sequencer.h" |
e496c003 | 15 | #include "commit.h" |
ac6c561b | 16 | #include "worktree.h" |
961b130d GC |
17 | #include "submodule-config.h" |
18 | #include "run-command.h" | |
31ad6b61 | 19 | #include "strmap.h" |
e496c003 DB |
20 | |
21 | struct tracking { | |
0ad4a5ff | 22 | struct refspec_item spec; |
d3115660 | 23 | struct string_list *srcs; |
e496c003 DB |
24 | const char *remote; |
25 | int matches; | |
26 | }; | |
27 | ||
e4921d87 TK |
28 | struct find_tracked_branch_cb { |
29 | struct tracking *tracking; | |
30 | struct string_list ambiguous_remotes; | |
31 | }; | |
32 | ||
e496c003 DB |
33 | static int find_tracked_branch(struct remote *remote, void *priv) |
34 | { | |
e4921d87 TK |
35 | struct find_tracked_branch_cb *ftb = priv; |
36 | struct tracking *tracking = ftb->tracking; | |
e496c003 DB |
37 | |
38 | if (!remote_find_tracking(remote, &tracking->spec)) { | |
e4921d87 TK |
39 | switch (++tracking->matches) { |
40 | case 1: | |
861c56f6 | 41 | string_list_append_nodup(tracking->srcs, tracking->spec.src); |
e496c003 | 42 | tracking->remote = remote->name; |
e4921d87 TK |
43 | break; |
44 | case 2: | |
45 | /* there are at least two remotes; backfill the first one */ | |
46 | string_list_append(&ftb->ambiguous_remotes, tracking->remote); | |
47 | /* fall through */ | |
48 | default: | |
49 | string_list_append(&ftb->ambiguous_remotes, remote->name); | |
e496c003 | 50 | free(tracking->spec.src); |
d3115660 | 51 | string_list_clear(tracking->srcs, 0); |
e4921d87 | 52 | break; |
e496c003 | 53 | } |
bdaf1dfa | 54 | /* remote_find_tracking() searches by src if present */ |
e496c003 DB |
55 | tracking->spec.src = NULL; |
56 | } | |
e496c003 DB |
57 | return 0; |
58 | } | |
59 | ||
a9f2c136 | 60 | static int should_setup_rebase(const char *origin) |
c998ae9b DS |
61 | { |
62 | switch (autorebase) { | |
63 | case AUTOREBASE_NEVER: | |
64 | return 0; | |
65 | case AUTOREBASE_LOCAL: | |
a9f2c136 | 66 | return origin == NULL; |
c998ae9b | 67 | case AUTOREBASE_REMOTE: |
a9f2c136 | 68 | return origin != NULL; |
c998ae9b DS |
69 | case AUTOREBASE_ALWAYS: |
70 | return 1; | |
71 | } | |
72 | return 0; | |
73 | } | |
74 | ||
a3f40ec4 JS |
75 | /** |
76 | * Install upstream tracking configuration for a branch; specifically, add | |
77 | * `branch.<name>.remote` and `branch.<name>.merge` entries. | |
78 | * | |
79 | * `flag` contains integer flags for options; currently only | |
80 | * BRANCH_CONFIG_VERBOSE is checked. | |
81 | * | |
82 | * `local` is the name of the branch whose configuration we're installing. | |
83 | * | |
84 | * `origin` is the name of the remote owning the upstream branches. NULL means | |
85 | * the upstream branches are local to this repo. | |
86 | * | |
87 | * `remotes` is a list of refs that are upstream of local | |
88 | */ | |
89 | static int install_branch_config_multiple_remotes(int flag, const char *local, | |
90 | const char *origin, struct string_list *remotes) | |
a9f2c136 | 91 | { |
cf4fff57 | 92 | const char *shortname = NULL; |
a9f2c136 | 93 | struct strbuf key = STRBUF_INIT; |
a3f40ec4 | 94 | struct string_list_item *item; |
a9f2c136 JH |
95 | int rebasing = should_setup_rebase(origin); |
96 | ||
a3f40ec4 JS |
97 | if (!remotes->nr) |
98 | BUG("must provide at least one remote for branch config"); | |
99 | if (rebasing && remotes->nr > 1) | |
100 | die(_("cannot inherit upstream tracking configuration of " | |
101 | "multiple refs when rebasing is requested")); | |
102 | ||
103 | /* | |
104 | * If the new branch is trying to track itself, something has gone | |
105 | * wrong. Warn the user and don't proceed any further. | |
106 | */ | |
107 | if (!origin) | |
108 | for_each_string_list_item(item, remotes) | |
109 | if (skip_prefix(item->string, "refs/heads/", &shortname) | |
110 | && !strcmp(local, shortname)) { | |
0669bdf4 | 111 | warning(_("not setting branch '%s' as its own upstream"), |
a3f40ec4 JS |
112 | local); |
113 | return 0; | |
114 | } | |
85e2233f | 115 | |
a9f2c136 | 116 | strbuf_addf(&key, "branch.%s.remote", local); |
30598ad0 | 117 | if (git_config_set_gently(key.buf, origin ? origin : ".") < 0) |
27852b2c | 118 | goto out_err; |
a9f2c136 JH |
119 | |
120 | strbuf_reset(&key); | |
121 | strbuf_addf(&key, "branch.%s.merge", local); | |
a3f40ec4 JS |
122 | /* |
123 | * We want to overwrite any existing config with all the branches in | |
124 | * "remotes". Override any existing config, then write our branches. If | |
125 | * more than one is provided, use CONFIG_REGEX_NONE to preserve what | |
126 | * we've written so far. | |
127 | */ | |
128 | if (git_config_set_gently(key.buf, NULL) < 0) | |
27852b2c | 129 | goto out_err; |
a3f40ec4 JS |
130 | for_each_string_list_item(item, remotes) |
131 | if (git_config_set_multivar_gently(key.buf, item->string, CONFIG_REGEX_NONE, 0) < 0) | |
132 | goto out_err; | |
a9f2c136 JH |
133 | |
134 | if (rebasing) { | |
135 | strbuf_reset(&key); | |
136 | strbuf_addf(&key, "branch.%s.rebase", local); | |
30598ad0 | 137 | if (git_config_set_gently(key.buf, "true") < 0) |
27852b2c | 138 | goto out_err; |
a9f2c136 | 139 | } |
d53a3503 | 140 | strbuf_release(&key); |
a9f2c136 | 141 | |
72f60083 | 142 | if (flag & BRANCH_CONFIG_VERBOSE) { |
a3f40ec4 JS |
143 | struct strbuf tmp_ref_name = STRBUF_INIT; |
144 | struct string_list friendly_ref_names = STRING_LIST_INIT_DUP; | |
145 | ||
146 | for_each_string_list_item(item, remotes) { | |
147 | shortname = item->string; | |
148 | skip_prefix(shortname, "refs/heads/", &shortname); | |
149 | if (origin) { | |
150 | strbuf_addf(&tmp_ref_name, "%s/%s", | |
151 | origin, shortname); | |
152 | string_list_append_nodup( | |
153 | &friendly_ref_names, | |
154 | strbuf_detach(&tmp_ref_name, NULL)); | |
155 | } else { | |
156 | string_list_append( | |
157 | &friendly_ref_names, shortname); | |
158 | } | |
159 | } | |
160 | ||
161 | if (remotes->nr == 1) { | |
162 | /* | |
163 | * Rebasing is only allowed in the case of a single | |
164 | * upstream branch. | |
165 | */ | |
166 | printf_ln(rebasing ? | |
167 | _("branch '%s' set up to track '%s' by rebasing.") : | |
168 | _("branch '%s' set up to track '%s'."), | |
169 | local, friendly_ref_names.items[0].string); | |
9fe0cf3a | 170 | } else { |
a3f40ec4 JS |
171 | printf_ln(_("branch '%s' set up to track:"), local); |
172 | for_each_string_list_item(item, &friendly_ref_names) | |
173 | printf_ln(" %s", item->string); | |
9fe0cf3a | 174 | } |
a3f40ec4 JS |
175 | |
176 | string_list_clear(&friendly_ref_names, 0); | |
72f60083 | 177 | } |
27852b2c PS |
178 | |
179 | return 0; | |
180 | ||
181 | out_err: | |
182 | strbuf_release(&key); | |
7435e7e2 | 183 | error(_("unable to write upstream branch configuration")); |
27852b2c | 184 | |
a3f40ec4 JS |
185 | advise(_("\nAfter fixing the error cause you may try to fix up\n" |
186 | "the remote tracking information by invoking:")); | |
187 | if (remotes->nr == 1) | |
188 | advise(" git branch --set-upstream-to=%s%s%s", | |
189 | origin ? origin : "", | |
190 | origin ? "/" : "", | |
191 | remotes->items[0].string); | |
192 | else { | |
193 | advise(" git config --add branch.\"%s\".remote %s", | |
194 | local, origin ? origin : "."); | |
195 | for_each_string_list_item(item, remotes) | |
196 | advise(" git config --add branch.\"%s\".merge %s", | |
197 | local, item->string); | |
198 | } | |
27852b2c PS |
199 | |
200 | return -1; | |
a9f2c136 JH |
201 | } |
202 | ||
a3f40ec4 JS |
203 | int install_branch_config(int flag, const char *local, const char *origin, |
204 | const char *remote) | |
205 | { | |
206 | int ret; | |
207 | struct string_list remotes = STRING_LIST_INIT_DUP; | |
208 | ||
209 | string_list_append(&remotes, remote); | |
210 | ret = install_branch_config_multiple_remotes(flag, local, origin, &remotes); | |
211 | string_list_clear(&remotes, 0); | |
212 | return ret; | |
213 | } | |
214 | ||
d3115660 JS |
215 | static int inherit_tracking(struct tracking *tracking, const char *orig_ref) |
216 | { | |
217 | const char *bare_ref; | |
218 | struct branch *branch; | |
219 | int i; | |
220 | ||
221 | bare_ref = orig_ref; | |
222 | skip_prefix(orig_ref, "refs/heads/", &bare_ref); | |
223 | ||
224 | branch = branch_get(bare_ref); | |
225 | if (!branch->remote_name) { | |
226 | warning(_("asked to inherit tracking from '%s', but no remote is set"), | |
227 | bare_ref); | |
228 | return -1; | |
229 | } | |
230 | ||
231 | if (branch->merge_nr < 1 || !branch->merge_name || !branch->merge_name[0]) { | |
232 | warning(_("asked to inherit tracking from '%s', but no merge configuration is set"), | |
233 | bare_ref); | |
234 | return -1; | |
235 | } | |
236 | ||
a88a3d7c | 237 | tracking->remote = branch->remote_name; |
d3115660 JS |
238 | for (i = 0; i < branch->merge_nr; i++) |
239 | string_list_append(tracking->srcs, branch->merge_name[i]); | |
240 | return 0; | |
241 | } | |
242 | ||
e496c003 | 243 | /* |
e89f151d GC |
244 | * Used internally to set the branch.<new_ref>.{remote,merge} config |
245 | * settings so that branch 'new_ref' tracks 'orig_ref'. Unlike | |
246 | * dwim_and_setup_tracking(), this does not do DWIM, i.e. "origin/main" | |
247 | * will not be expanded to "refs/remotes/origin/main", so it is not safe | |
248 | * for 'orig_ref' to be raw user input. | |
e496c003 | 249 | */ |
27852b2c PS |
250 | static void setup_tracking(const char *new_ref, const char *orig_ref, |
251 | enum branch_track track, int quiet) | |
e496c003 | 252 | { |
e496c003 | 253 | struct tracking tracking; |
d3115660 | 254 | struct string_list tracking_srcs = STRING_LIST_INIT_DUP; |
f9a482e6 | 255 | int config_flags = quiet ? 0 : BRANCH_CONFIG_VERBOSE; |
e4921d87 TK |
256 | struct find_tracked_branch_cb ftb_cb = { |
257 | .tracking = &tracking, | |
258 | .ambiguous_remotes = STRING_LIST_INIT_DUP, | |
259 | }; | |
e496c003 | 260 | |
75388bf5 GC |
261 | if (!track) |
262 | BUG("asked to set up tracking, but tracking is disallowed"); | |
263 | ||
e496c003 DB |
264 | memset(&tracking, 0, sizeof(tracking)); |
265 | tracking.spec.dst = (char *)orig_ref; | |
d3115660 JS |
266 | tracking.srcs = &tracking_srcs; |
267 | if (track != BRANCH_TRACK_INHERIT) | |
e4921d87 | 268 | for_each_remote(find_tracked_branch, &ftb_cb); |
d3115660 | 269 | else if (inherit_tracking(&tracking, orig_ref)) |
679e3693 | 270 | goto cleanup; |
e496c003 | 271 | |
9ed36cfa JS |
272 | if (!tracking.matches) |
273 | switch (track) { | |
bdaf1dfa | 274 | /* If ref is not remote, still use local */ |
9ed36cfa JS |
275 | case BRANCH_TRACK_ALWAYS: |
276 | case BRANCH_TRACK_EXPLICIT: | |
4fc50066 | 277 | case BRANCH_TRACK_OVERRIDE: |
bdaf1dfa | 278 | /* Remote matches not evaluated */ |
d3115660 | 279 | case BRANCH_TRACK_INHERIT: |
9ed36cfa | 280 | break; |
bdaf1dfa | 281 | /* Otherwise, if no remote don't track */ |
9ed36cfa | 282 | default: |
679e3693 | 283 | goto cleanup; |
9ed36cfa JS |
284 | } |
285 | ||
bdaf1dfa TK |
286 | /* |
287 | * This check does not apply to BRANCH_TRACK_INHERIT; | |
288 | * that supports multiple entries in tracking_srcs but | |
289 | * leaves tracking.matches at 0. | |
290 | */ | |
e4921d87 TK |
291 | if (tracking.matches > 1) { |
292 | int status = die_message(_("not tracking: ambiguous information for ref '%s'"), | |
293 | orig_ref); | |
294 | if (advice_enabled(ADVICE_AMBIGUOUS_FETCH_REFSPEC)) { | |
295 | struct strbuf remotes_advice = STRBUF_INIT; | |
296 | struct string_list_item *item; | |
297 | ||
298 | for_each_string_list_item(item, &ftb_cb.ambiguous_remotes) | |
299 | /* | |
300 | * TRANSLATORS: This is a line listing a remote with duplicate | |
301 | * refspecs in the advice message below. For RTL languages you'll | |
302 | * probably want to swap the "%s" and leading " " space around. | |
303 | */ | |
304 | strbuf_addf(&remotes_advice, _(" %s\n"), item->string); | |
305 | ||
306 | /* | |
307 | * TRANSLATORS: The second argument is a \n-delimited list of | |
308 | * duplicate refspecs, composed above. | |
309 | */ | |
310 | advise(_("There are multiple remotes whose fetch refspecs map to the remote\n" | |
311 | "tracking ref '%s':\n" | |
312 | "%s" | |
313 | "\n" | |
314 | "This is typically a configuration error.\n" | |
315 | "\n" | |
316 | "To support setting up tracking branches, ensure that\n" | |
317 | "different remotes' fetch refspecs map into different\n" | |
318 | "tracking namespaces."), orig_ref, | |
319 | remotes_advice.buf); | |
320 | strbuf_release(&remotes_advice); | |
321 | } | |
322 | exit(status); | |
323 | } | |
e496c003 | 324 | |
bdaf1dfa TK |
325 | if (track == BRANCH_TRACK_SIMPLE) { |
326 | /* | |
327 | * Only track if remote branch name matches. | |
328 | * Reaching into items[0].string is safe because | |
329 | * we know there is at least one and not more than | |
330 | * one entry (because only BRANCH_TRACK_INHERIT can | |
331 | * produce more than one entry). | |
332 | */ | |
333 | const char *tracked_branch; | |
334 | if (!skip_prefix(tracking.srcs->items[0].string, | |
335 | "refs/heads/", &tracked_branch) || | |
336 | strcmp(tracked_branch, new_ref)) | |
5ace483a | 337 | goto cleanup; |
bdaf1dfa TK |
338 | } |
339 | ||
d3115660 JS |
340 | if (tracking.srcs->nr < 1) |
341 | string_list_append(tracking.srcs, orig_ref); | |
342 | if (install_branch_config_multiple_remotes(config_flags, new_ref, | |
343 | tracking.remote, tracking.srcs) < 0) | |
5391e948 | 344 | exit(1); |
e496c003 | 345 | |
679e3693 GC |
346 | cleanup: |
347 | string_list_clear(&tracking_srcs, 0); | |
e4921d87 | 348 | string_list_clear(&ftb_cb.ambiguous_remotes, 0); |
e496c003 DB |
349 | } |
350 | ||
6f9a3321 JH |
351 | int read_branch_desc(struct strbuf *buf, const char *branch_name) |
352 | { | |
540b0f49 | 353 | char *v = NULL; |
6f9a3321 JH |
354 | struct strbuf name = STRBUF_INIT; |
355 | strbuf_addf(&name, "branch.%s.description", branch_name); | |
540b0f49 TA |
356 | if (git_config_get_string(name.buf, &v)) { |
357 | strbuf_release(&name); | |
358 | return -1; | |
359 | } | |
360 | strbuf_addstr(buf, v); | |
361 | free(v); | |
6f9a3321 JH |
362 | strbuf_release(&name); |
363 | return 0; | |
364 | } | |
365 | ||
bc1c9c0e JH |
366 | /* |
367 | * Check if 'name' can be a valid name for a branch; die otherwise. | |
368 | * Return 1 if the named branch already exists; return 0 otherwise. | |
369 | * Fill ref with the full refname for the branch. | |
370 | */ | |
371 | int validate_branchname(const char *name, struct strbuf *ref) | |
55c4a673 | 372 | { |
55c4a673 | 373 | if (strbuf_check_branch_ref(ref, name)) |
7435e7e2 | 374 | die(_("'%s' is not a valid branch name"), name); |
55c4a673 | 375 | |
bc1c9c0e JH |
376 | return ref_exists(ref->buf); |
377 | } | |
55c4a673 | 378 | |
31ad6b61 DS |
379 | static int initialized_checked_out_branches; |
380 | static struct strmap current_checked_out_branches = STRMAP_INIT; | |
381 | ||
382 | static void prepare_checked_out_branches(void) | |
383 | { | |
384 | int i = 0; | |
385 | struct worktree **worktrees; | |
386 | ||
387 | if (initialized_checked_out_branches) | |
388 | return; | |
389 | initialized_checked_out_branches = 1; | |
390 | ||
391 | worktrees = get_worktrees(); | |
392 | ||
393 | while (worktrees[i]) { | |
4b6e18f5 | 394 | char *old; |
d2ba271a | 395 | struct wt_status_state state = { 0 }; |
31ad6b61 | 396 | struct worktree *wt = worktrees[i++]; |
aa7f2fd1 | 397 | struct string_list update_refs = STRING_LIST_INIT_DUP; |
31ad6b61 DS |
398 | |
399 | if (wt->is_bare) | |
400 | continue; | |
401 | ||
4b6e18f5 DS |
402 | if (wt->head_ref) { |
403 | old = strmap_put(¤t_checked_out_branches, | |
404 | wt->head_ref, | |
405 | xstrdup(wt->path)); | |
406 | free(old); | |
407 | } | |
d2ba271a DS |
408 | |
409 | if (wt_status_check_rebase(wt, &state) && | |
410 | (state.rebase_in_progress || state.rebase_interactive_in_progress) && | |
411 | state.branch) { | |
412 | struct strbuf ref = STRBUF_INIT; | |
413 | strbuf_addf(&ref, "refs/heads/%s", state.branch); | |
4b6e18f5 DS |
414 | old = strmap_put(¤t_checked_out_branches, |
415 | ref.buf, | |
416 | xstrdup(wt->path)); | |
417 | free(old); | |
d2ba271a DS |
418 | strbuf_release(&ref); |
419 | } | |
420 | wt_status_state_free_buffers(&state); | |
421 | ||
422 | if (wt_status_check_bisect(wt, &state) && | |
990adccb | 423 | state.bisecting_from) { |
d2ba271a | 424 | struct strbuf ref = STRBUF_INIT; |
990adccb | 425 | strbuf_addf(&ref, "refs/heads/%s", state.bisecting_from); |
4b6e18f5 DS |
426 | old = strmap_put(¤t_checked_out_branches, |
427 | ref.buf, | |
428 | xstrdup(wt->path)); | |
429 | free(old); | |
d2ba271a DS |
430 | strbuf_release(&ref); |
431 | } | |
432 | wt_status_state_free_buffers(&state); | |
aa7f2fd1 DS |
433 | |
434 | if (!sequencer_get_update_refs_state(get_worktree_git_dir(wt), | |
435 | &update_refs)) { | |
436 | struct string_list_item *item; | |
437 | for_each_string_list_item(item, &update_refs) { | |
438 | old = strmap_put(¤t_checked_out_branches, | |
439 | item->string, | |
440 | xstrdup(wt->path)); | |
441 | free(old); | |
442 | } | |
443 | string_list_clear(&update_refs, 1); | |
444 | } | |
31ad6b61 DS |
445 | } |
446 | ||
447 | free_worktrees(worktrees); | |
448 | } | |
449 | ||
450 | const char *branch_checked_out(const char *refname) | |
451 | { | |
452 | prepare_checked_out_branches(); | |
453 | return strmap_get(¤t_checked_out_branches, refname); | |
454 | } | |
455 | ||
bc1c9c0e JH |
456 | /* |
457 | * Check if a branch 'name' can be created as a new branch; die otherwise. | |
458 | * 'force' can be used when it is OK for the named branch already exists. | |
459 | * Return 1 if the named branch already exists; return 0 otherwise. | |
460 | * Fill ref with the full refname for the branch. | |
461 | */ | |
462 | int validate_new_branchname(const char *name, struct strbuf *ref, int force) | |
463 | { | |
d2ba271a | 464 | const char *path; |
bc1c9c0e | 465 | if (!validate_branchname(name, ref)) |
55c4a673 | 466 | return 0; |
55c4a673 | 467 | |
8280c4c1 | 468 | if (!force) |
7435e7e2 | 469 | die(_("a branch named '%s' already exists"), |
8280c4c1 JH |
470 | ref->buf + strlen("refs/heads/")); |
471 | ||
d2ba271a | 472 | if ((path = branch_checked_out(ref->buf))) |
68d924e1 | 473 | die(_("cannot force update the branch '%s' " |
4970bede | 474 | "used by worktree at '%s'"), |
d2ba271a | 475 | ref->buf + strlen("refs/heads/"), path); |
55c4a673 CI |
476 | |
477 | return 1; | |
478 | } | |
479 | ||
41c21f22 JH |
480 | static int check_tracking_branch(struct remote *remote, void *cb_data) |
481 | { | |
482 | char *tracking_branch = cb_data; | |
0ad4a5ff | 483 | struct refspec_item query; |
caee1d66 | 484 | int res; |
0ad4a5ff | 485 | memset(&query, 0, sizeof(struct refspec_item)); |
41c21f22 | 486 | query.dst = tracking_branch; |
caee1d66 RJ |
487 | res = !remote_find_tracking(remote, &query); |
488 | free(query.src); | |
489 | return res; | |
41c21f22 JH |
490 | } |
491 | ||
492 | static int validate_remote_tracking_branch(char *ref) | |
493 | { | |
494 | return !for_each_remote(check_tracking_branch, ref); | |
495 | } | |
496 | ||
e2b6aa5f | 497 | static const char upstream_not_branch[] = |
7435e7e2 | 498 | N_("cannot set up tracking information; starting point '%s' is not a branch"); |
a5e91c72 | 499 | static const char upstream_missing[] = |
caa2036b JK |
500 | N_("the requested upstream branch '%s' does not exist"); |
501 | static const char upstream_advice[] = | |
502 | N_("\n" | |
503 | "If you are planning on basing your work on an upstream\n" | |
504 | "branch that already exists at the remote, you may need to\n" | |
505 | "run \"git fetch\" to retrieve it.\n" | |
506 | "\n" | |
507 | "If you are planning to push out a new local branch that\n" | |
508 | "will track its remote counterpart, you may want to use\n" | |
509 | "\"git push -u\" to set the upstream config as you push."); | |
e2b6aa5f | 510 | |
e89f151d GC |
511 | /** |
512 | * DWIMs a user-provided ref to determine the starting point for a | |
513 | * branch and validates it, where: | |
514 | * | |
515 | * - r is the repository to validate the branch for | |
516 | * | |
517 | * - start_name is the ref that we would like to test. This is | |
518 | * expanded with DWIM and assigned to out_real_ref. | |
519 | * | |
520 | * - track is the tracking mode of the new branch. If tracking is | |
521 | * explicitly requested, start_name must be a branch (because | |
522 | * otherwise start_name cannot be tracked) | |
523 | * | |
524 | * - out_oid is an out parameter containing the object_id of start_name | |
525 | * | |
526 | * - out_real_ref is an out parameter containing the full, 'real' form | |
527 | * of start_name e.g. refs/heads/main instead of main | |
528 | * | |
529 | */ | |
530 | static void dwim_branch_start(struct repository *r, const char *start_name, | |
531 | enum branch_track track, char **out_real_ref, | |
532 | struct object_id *out_oid) | |
e496c003 | 533 | { |
e496c003 | 534 | struct commit *commit; |
48713bfa | 535 | struct object_id oid; |
3818b258 | 536 | char *real_ref; |
4fc50066 IL |
537 | int explicit_tracking = 0; |
538 | ||
539 | if (track == BRANCH_TRACK_EXPLICIT || track == BRANCH_TRACK_OVERRIDE) | |
540 | explicit_tracking = 1; | |
e496c003 | 541 | |
e496c003 | 542 | real_ref = NULL; |
4a93b899 | 543 | if (repo_get_oid_mb(r, start_name, &oid)) { |
caa2036b | 544 | if (explicit_tracking) { |
66966012 GC |
545 | int code = die_message(_(upstream_missing), start_name); |
546 | advise_if_enabled(ADVICE_SET_UPSTREAM_FAILURE, | |
547 | _(upstream_advice)); | |
548 | exit(code); | |
caa2036b | 549 | } |
7435e7e2 | 550 | die(_("not a valid object name: '%s'"), start_name); |
a5e91c72 | 551 | } |
e496c003 | 552 | |
4a93b899 ÆAB |
553 | switch (repo_dwim_ref(r, start_name, strlen(start_name), &oid, |
554 | &real_ref, 0)) { | |
e496c003 DB |
555 | case 0: |
556 | /* Not branching from any existing branch */ | |
4fc50066 | 557 | if (explicit_tracking) |
1a15d00b | 558 | die(_(upstream_not_branch), start_name); |
e496c003 DB |
559 | break; |
560 | case 1: | |
21b5b1e8 | 561 | /* Unique completion -- good, only if it is a real branch */ |
59556548 | 562 | if (!starts_with(real_ref, "refs/heads/") && |
41c21f22 | 563 | validate_remote_tracking_branch(real_ref)) { |
21b5b1e8 | 564 | if (explicit_tracking) |
1a15d00b | 565 | die(_(upstream_not_branch), start_name); |
21b5b1e8 | 566 | else |
d895804b | 567 | FREE_AND_NULL(real_ref); |
21b5b1e8 | 568 | } |
e496c003 DB |
569 | break; |
570 | default: | |
7435e7e2 | 571 | die(_("ambiguous object name: '%s'"), start_name); |
e496c003 DB |
572 | break; |
573 | } | |
574 | ||
afe8a907 | 575 | if (!(commit = lookup_commit_reference(r, &oid))) |
7435e7e2 | 576 | die(_("not a valid branch point: '%s'"), start_name); |
e89f151d GC |
577 | if (out_real_ref) { |
578 | *out_real_ref = real_ref; | |
579 | real_ref = NULL; | |
580 | } | |
581 | if (out_oid) | |
582 | oidcpy(out_oid, &commit->object.oid); | |
583 | ||
584 | FREE_AND_NULL(real_ref); | |
585 | } | |
586 | ||
587 | void create_branch(struct repository *r, | |
588 | const char *name, const char *start_name, | |
589 | int force, int clobber_head_ok, int reflog, | |
3f3e7608 | 590 | int quiet, enum branch_track track, int dry_run) |
e89f151d GC |
591 | { |
592 | struct object_id oid; | |
593 | char *real_ref; | |
594 | struct strbuf ref = STRBUF_INIT; | |
595 | int forcing = 0; | |
bc0893cf GC |
596 | struct ref_transaction *transaction; |
597 | struct strbuf err = STRBUF_INIT; | |
598 | char *msg; | |
599 | ||
600 | if (track == BRANCH_TRACK_OVERRIDE) | |
601 | BUG("'track' cannot be BRANCH_TRACK_OVERRIDE. Did you mean to call dwim_and_setup_tracking()?"); | |
602 | if (clobber_head_ok && !force) | |
603 | BUG("'clobber_head_ok' can only be used with 'force'"); | |
604 | ||
605 | if (clobber_head_ok ? | |
606 | validate_branchname(name, &ref) : | |
607 | validate_new_branchname(name, &ref, force)) { | |
608 | forcing = 1; | |
e89f151d GC |
609 | } |
610 | ||
611 | dwim_branch_start(r, start_name, track, &real_ref, &oid); | |
3f3e7608 GC |
612 | if (dry_run) |
613 | goto cleanup; | |
e496c003 | 614 | |
d43f990f | 615 | if (reflog) |
341fb286 | 616 | log_all_ref_updates = LOG_REFS_NORMAL; |
d43f990f | 617 | |
bc0893cf GC |
618 | if (forcing) |
619 | msg = xstrfmt("branch: Reset to %s", start_name); | |
620 | else | |
621 | msg = xstrfmt("branch: Created from %s", start_name); | |
622 | transaction = ref_transaction_begin(&err); | |
623 | if (!transaction || | |
624 | ref_transaction_update(transaction, ref.buf, | |
625 | &oid, forcing ? NULL : null_oid(), | |
626 | 0, msg, &err) || | |
627 | ref_transaction_commit(transaction, &err)) | |
628 | die("%s", err.buf); | |
629 | ref_transaction_free(transaction); | |
630 | strbuf_release(&err); | |
631 | free(msg); | |
d43f990f | 632 | |
e496c003 | 633 | if (real_ref && track) |
82a0672f | 634 | setup_tracking(ref.buf + 11, real_ref, track, quiet); |
e496c003 | 635 | |
3f3e7608 | 636 | cleanup: |
8415d5c7 | 637 | strbuf_release(&ref); |
9ed36cfa | 638 | free(real_ref); |
e496c003 | 639 | } |
c369e7b8 | 640 | |
e89f151d GC |
641 | void dwim_and_setup_tracking(struct repository *r, const char *new_ref, |
642 | const char *orig_ref, enum branch_track track, | |
643 | int quiet) | |
644 | { | |
1533bda7 | 645 | char *real_orig_ref = NULL; |
e89f151d GC |
646 | dwim_branch_start(r, orig_ref, track, &real_orig_ref, NULL); |
647 | setup_tracking(new_ref, real_orig_ref, track, quiet); | |
1533bda7 | 648 | free(real_orig_ref); |
e89f151d GC |
649 | } |
650 | ||
961b130d GC |
651 | /** |
652 | * Creates a branch in a submodule by calling | |
653 | * create_branches_recursively() in a child process. The child process | |
654 | * is necessary because install_branch_config_multiple_remotes() (which | |
655 | * is called by setup_tracking()) does not support writing configs to | |
656 | * submodules. | |
657 | */ | |
658 | static int submodule_create_branch(struct repository *r, | |
659 | const struct submodule *submodule, | |
660 | const char *name, const char *start_oid, | |
661 | const char *tracking_name, int force, | |
662 | int reflog, int quiet, | |
663 | enum branch_track track, int dry_run) | |
664 | { | |
665 | int ret = 0; | |
666 | struct child_process child = CHILD_PROCESS_INIT; | |
667 | struct strbuf child_err = STRBUF_INIT; | |
668 | struct strbuf out_buf = STRBUF_INIT; | |
669 | char *out_prefix = xstrfmt("submodule '%s': ", submodule->name); | |
670 | child.git_cmd = 1; | |
671 | child.err = -1; | |
672 | child.stdout_to_stderr = 1; | |
673 | ||
29fda24d | 674 | prepare_other_repo_env(&child.env, r->gitdir); |
961b130d GC |
675 | /* |
676 | * submodule_create_branch() is indirectly invoked by "git | |
677 | * branch", but we cannot invoke "git branch" in the child | |
678 | * process. "git branch" accepts a branch name and start point, | |
679 | * where the start point is assumed to provide both the OID | |
680 | * (start_oid) and the branch to use for tracking | |
681 | * (tracking_name). But when recursing through submodules, | |
682 | * start_oid and tracking name need to be specified separately | |
683 | * (see create_branches_recursively()). | |
684 | */ | |
685 | strvec_pushl(&child.args, "submodule--helper", "create-branch", NULL); | |
686 | if (dry_run) | |
687 | strvec_push(&child.args, "--dry-run"); | |
688 | if (force) | |
689 | strvec_push(&child.args, "--force"); | |
690 | if (quiet) | |
691 | strvec_push(&child.args, "--quiet"); | |
692 | if (reflog) | |
693 | strvec_push(&child.args, "--create-reflog"); | |
75388bf5 GC |
694 | |
695 | switch (track) { | |
696 | case BRANCH_TRACK_NEVER: | |
697 | strvec_push(&child.args, "--no-track"); | |
698 | break; | |
699 | case BRANCH_TRACK_ALWAYS: | |
700 | case BRANCH_TRACK_EXPLICIT: | |
701 | strvec_push(&child.args, "--track=direct"); | |
702 | break; | |
703 | case BRANCH_TRACK_OVERRIDE: | |
704 | BUG("BRANCH_TRACK_OVERRIDE cannot be used when creating a branch."); | |
705 | break; | |
706 | case BRANCH_TRACK_INHERIT: | |
707 | strvec_push(&child.args, "--track=inherit"); | |
708 | break; | |
709 | case BRANCH_TRACK_UNSPECIFIED: | |
1f888282 | 710 | /* Default for "git checkout". Do not pass --track. */ |
75388bf5 | 711 | case BRANCH_TRACK_REMOTE: |
1f888282 | 712 | /* Default for "git branch". Do not pass --track. */ |
bdaf1dfa TK |
713 | case BRANCH_TRACK_SIMPLE: |
714 | /* Config-driven only. Do not pass --track. */ | |
75388bf5 GC |
715 | break; |
716 | } | |
961b130d GC |
717 | |
718 | strvec_pushl(&child.args, name, start_oid, tracking_name, NULL); | |
719 | ||
720 | if ((ret = start_command(&child))) | |
721 | return ret; | |
722 | ret = finish_command(&child); | |
723 | strbuf_read(&child_err, child.err, 0); | |
724 | strbuf_add_lines(&out_buf, out_prefix, child_err.buf, child_err.len); | |
725 | ||
726 | if (ret) | |
727 | fprintf(stderr, "%s", out_buf.buf); | |
728 | else | |
729 | printf("%s", out_buf.buf); | |
730 | ||
731 | strbuf_release(&child_err); | |
732 | strbuf_release(&out_buf); | |
733 | return ret; | |
734 | } | |
735 | ||
736 | void create_branches_recursively(struct repository *r, const char *name, | |
737 | const char *start_commitish, | |
738 | const char *tracking_name, int force, | |
739 | int reflog, int quiet, enum branch_track track, | |
740 | int dry_run) | |
741 | { | |
742 | int i = 0; | |
743 | char *branch_point = NULL; | |
744 | struct object_id super_oid; | |
745 | struct submodule_entry_list submodule_entry_list; | |
746 | ||
747 | /* Perform dwim on start_commitish to get super_oid and branch_point. */ | |
748 | dwim_branch_start(r, start_commitish, BRANCH_TRACK_NEVER, | |
749 | &branch_point, &super_oid); | |
750 | ||
751 | /* | |
752 | * If we were not given an explicit name to track, then assume we are at | |
753 | * the top level and, just like the non-recursive case, the tracking | |
754 | * name is the branch point. | |
755 | */ | |
756 | if (!tracking_name) | |
757 | tracking_name = branch_point; | |
758 | ||
759 | submodules_of_tree(r, &super_oid, &submodule_entry_list); | |
760 | /* | |
761 | * Before creating any branches, first check that the branch can | |
762 | * be created in every submodule. | |
763 | */ | |
764 | for (i = 0; i < submodule_entry_list.entry_nr; i++) { | |
e6bf70d1 | 765 | if (!submodule_entry_list.entries[i].repo) { |
cfbda6ba GC |
766 | int code = die_message( |
767 | _("submodule '%s': unable to find submodule"), | |
768 | submodule_entry_list.entries[i].submodule->name); | |
961b130d | 769 | if (advice_enabled(ADVICE_SUBMODULES_NOT_UPDATED)) |
97cf0c7d | 770 | advise(_("You may try updating the submodules using 'git checkout --no-recurse-submodules %s && git submodule update --init'"), |
961b130d | 771 | start_commitish); |
cfbda6ba | 772 | exit(code); |
961b130d GC |
773 | } |
774 | ||
775 | if (submodule_create_branch( | |
776 | submodule_entry_list.entries[i].repo, | |
777 | submodule_entry_list.entries[i].submodule, name, | |
778 | oid_to_hex(&submodule_entry_list.entries[i] | |
779 | .name_entry->oid), | |
780 | tracking_name, force, reflog, quiet, track, 1)) | |
781 | die(_("submodule '%s': cannot create branch '%s'"), | |
782 | submodule_entry_list.entries[i].submodule->name, | |
783 | name); | |
784 | } | |
785 | ||
4a93b899 | 786 | create_branch(r, name, start_commitish, force, 0, reflog, quiet, |
961b130d GC |
787 | BRANCH_TRACK_NEVER, dry_run); |
788 | if (dry_run) | |
789 | return; | |
790 | /* | |
791 | * NEEDSWORK If tracking was set up in the superproject but not the | |
792 | * submodule, users might expect "git branch --recurse-submodules" to | |
793 | * fail or give a warning, but this is not yet implemented because it is | |
794 | * tedious to determine whether or not tracking was set up in the | |
795 | * superproject. | |
796 | */ | |
75388bf5 GC |
797 | if (track) |
798 | setup_tracking(name, tracking_name, track, quiet); | |
961b130d GC |
799 | |
800 | for (i = 0; i < submodule_entry_list.entry_nr; i++) { | |
801 | if (submodule_create_branch( | |
802 | submodule_entry_list.entries[i].repo, | |
803 | submodule_entry_list.entries[i].submodule, name, | |
804 | oid_to_hex(&submodule_entry_list.entries[i] | |
805 | .name_entry->oid), | |
806 | tracking_name, force, reflog, quiet, track, 0)) | |
807 | die(_("submodule '%s': cannot create branch '%s'"), | |
808 | submodule_entry_list.entries[i].submodule->name, | |
809 | name); | |
810 | repo_clear(submodule_entry_list.entries[i].repo); | |
811 | } | |
812 | } | |
813 | ||
b6433555 | 814 | void remove_merge_branch_state(struct repository *r) |
c369e7b8 | 815 | { |
4edce172 NTND |
816 | unlink(git_path_merge_head(r)); |
817 | unlink(git_path_merge_rr(r)); | |
818 | unlink(git_path_merge_msg(r)); | |
819 | unlink(git_path_merge_mode(r)); | |
fd7c6ffa PS |
820 | refs_delete_ref(get_main_ref_store(r), "", "AUTO_MERGE", |
821 | NULL, REF_NO_DEREF); | |
3f921c75 | 822 | save_autostash_ref(r, "MERGE_AUTOSTASH"); |
b6433555 NTND |
823 | } |
824 | ||
f496b064 | 825 | void remove_branch_state(struct repository *r, int verbose) |
b6433555 | 826 | { |
f496b064 | 827 | sequencer_post_commit_cleanup(r, verbose); |
4edce172 | 828 | unlink(git_path_squash_msg(r)); |
b6433555 | 829 | remove_merge_branch_state(r); |
c369e7b8 | 830 | } |
ed89f84b | 831 | |
8d9fdd70 | 832 | void die_if_checked_out(const char *branch, int ignore_current_worktree) |
41af6565 | 833 | { |
c8dd491f | 834 | struct worktree **worktrees = get_worktrees(); |
41af6565 | 835 | |
faa4d598 RJ |
836 | for (int i = 0; worktrees[i]; i++) { |
837 | if (worktrees[i]->is_current && ignore_current_worktree) | |
838 | continue; | |
839 | ||
840 | if (is_shared_symref(worktrees[i], "HEAD", branch)) { | |
841 | skip_prefix(branch, "refs/heads/", &branch); | |
2a499264 | 842 | die(_("'%s' is already used by worktree at '%s'"), |
faa4d598 RJ |
843 | branch, worktrees[i]->path); |
844 | } | |
c8dd491f AK |
845 | } |
846 | ||
847 | free_worktrees(worktrees); | |
ed89f84b | 848 | } |