1 #include "git-compat-util.h"
11 #include "submodule-config.h"
12 #include "run-command.h"
15 struct refspec_item spec
;
16 struct string_list
*srcs
;
21 static int find_tracked_branch(struct remote
*remote
, void *priv
)
23 struct tracking
*tracking
= priv
;
25 if (!remote_find_tracking(remote
, &tracking
->spec
)) {
26 if (++tracking
->matches
== 1) {
27 string_list_append(tracking
->srcs
, tracking
->spec
.src
);
28 tracking
->remote
= remote
->name
;
30 free(tracking
->spec
.src
);
31 string_list_clear(tracking
->srcs
, 0);
33 tracking
->spec
.src
= NULL
;
39 static int should_setup_rebase(const char *origin
)
42 case AUTOREBASE_NEVER
:
44 case AUTOREBASE_LOCAL
:
45 return origin
== NULL
;
46 case AUTOREBASE_REMOTE
:
47 return origin
!= NULL
;
48 case AUTOREBASE_ALWAYS
:
55 * Install upstream tracking configuration for a branch; specifically, add
56 * `branch.<name>.remote` and `branch.<name>.merge` entries.
58 * `flag` contains integer flags for options; currently only
59 * BRANCH_CONFIG_VERBOSE is checked.
61 * `local` is the name of the branch whose configuration we're installing.
63 * `origin` is the name of the remote owning the upstream branches. NULL means
64 * the upstream branches are local to this repo.
66 * `remotes` is a list of refs that are upstream of local
68 static int install_branch_config_multiple_remotes(int flag
, const char *local
,
69 const char *origin
, struct string_list
*remotes
)
71 const char *shortname
= NULL
;
72 struct strbuf key
= STRBUF_INIT
;
73 struct string_list_item
*item
;
74 int rebasing
= should_setup_rebase(origin
);
77 BUG("must provide at least one remote for branch config");
78 if (rebasing
&& remotes
->nr
> 1)
79 die(_("cannot inherit upstream tracking configuration of "
80 "multiple refs when rebasing is requested"));
83 * If the new branch is trying to track itself, something has gone
84 * wrong. Warn the user and don't proceed any further.
87 for_each_string_list_item(item
, remotes
)
88 if (skip_prefix(item
->string
, "refs/heads/", &shortname
)
89 && !strcmp(local
, shortname
)) {
90 warning(_("not setting branch '%s' as its own upstream."),
95 strbuf_addf(&key
, "branch.%s.remote", local
);
96 if (git_config_set_gently(key
.buf
, origin
? origin
: ".") < 0)
100 strbuf_addf(&key
, "branch.%s.merge", local
);
102 * We want to overwrite any existing config with all the branches in
103 * "remotes". Override any existing config, then write our branches. If
104 * more than one is provided, use CONFIG_REGEX_NONE to preserve what
105 * we've written so far.
107 if (git_config_set_gently(key
.buf
, NULL
) < 0)
109 for_each_string_list_item(item
, remotes
)
110 if (git_config_set_multivar_gently(key
.buf
, item
->string
, CONFIG_REGEX_NONE
, 0) < 0)
115 strbuf_addf(&key
, "branch.%s.rebase", local
);
116 if (git_config_set_gently(key
.buf
, "true") < 0)
119 strbuf_release(&key
);
121 if (flag
& BRANCH_CONFIG_VERBOSE
) {
122 struct strbuf tmp_ref_name
= STRBUF_INIT
;
123 struct string_list friendly_ref_names
= STRING_LIST_INIT_DUP
;
125 for_each_string_list_item(item
, remotes
) {
126 shortname
= item
->string
;
127 skip_prefix(shortname
, "refs/heads/", &shortname
);
129 strbuf_addf(&tmp_ref_name
, "%s/%s",
131 string_list_append_nodup(
133 strbuf_detach(&tmp_ref_name
, NULL
));
136 &friendly_ref_names
, shortname
);
140 if (remotes
->nr
== 1) {
142 * Rebasing is only allowed in the case of a single
146 _("branch '%s' set up to track '%s' by rebasing.") :
147 _("branch '%s' set up to track '%s'."),
148 local
, friendly_ref_names
.items
[0].string
);
150 printf_ln(_("branch '%s' set up to track:"), local
);
151 for_each_string_list_item(item
, &friendly_ref_names
)
152 printf_ln(" %s", item
->string
);
155 string_list_clear(&friendly_ref_names
, 0);
161 strbuf_release(&key
);
162 error(_("Unable to write upstream branch configuration"));
164 advise(_("\nAfter fixing the error cause you may try to fix up\n"
165 "the remote tracking information by invoking:"));
166 if (remotes
->nr
== 1)
167 advise(" git branch --set-upstream-to=%s%s%s",
168 origin
? origin
: "",
170 remotes
->items
[0].string
);
172 advise(" git config --add branch.\"%s\".remote %s",
173 local
, origin
? origin
: ".");
174 for_each_string_list_item(item
, remotes
)
175 advise(" git config --add branch.\"%s\".merge %s",
176 local
, item
->string
);
182 int install_branch_config(int flag
, const char *local
, const char *origin
,
186 struct string_list remotes
= STRING_LIST_INIT_DUP
;
188 string_list_append(&remotes
, remote
);
189 ret
= install_branch_config_multiple_remotes(flag
, local
, origin
, &remotes
);
190 string_list_clear(&remotes
, 0);
194 static int inherit_tracking(struct tracking
*tracking
, const char *orig_ref
)
196 const char *bare_ref
;
197 struct branch
*branch
;
201 skip_prefix(orig_ref
, "refs/heads/", &bare_ref
);
203 branch
= branch_get(bare_ref
);
204 if (!branch
->remote_name
) {
205 warning(_("asked to inherit tracking from '%s', but no remote is set"),
210 if (branch
->merge_nr
< 1 || !branch
->merge_name
|| !branch
->merge_name
[0]) {
211 warning(_("asked to inherit tracking from '%s', but no merge configuration is set"),
216 tracking
->remote
= xstrdup(branch
->remote_name
);
217 for (i
= 0; i
< branch
->merge_nr
; i
++)
218 string_list_append(tracking
->srcs
, branch
->merge_name
[i
]);
223 * Used internally to set the branch.<new_ref>.{remote,merge} config
224 * settings so that branch 'new_ref' tracks 'orig_ref'. Unlike
225 * dwim_and_setup_tracking(), this does not do DWIM, i.e. "origin/main"
226 * will not be expanded to "refs/remotes/origin/main", so it is not safe
227 * for 'orig_ref' to be raw user input.
229 static void setup_tracking(const char *new_ref
, const char *orig_ref
,
230 enum branch_track track
, int quiet
)
232 struct tracking tracking
;
233 struct string_list tracking_srcs
= STRING_LIST_INIT_DUP
;
234 int config_flags
= quiet
? 0 : BRANCH_CONFIG_VERBOSE
;
237 BUG("asked to set up tracking, but tracking is disallowed");
239 memset(&tracking
, 0, sizeof(tracking
));
240 tracking
.spec
.dst
= (char *)orig_ref
;
241 tracking
.srcs
= &tracking_srcs
;
242 if (track
!= BRANCH_TRACK_INHERIT
)
243 for_each_remote(find_tracked_branch
, &tracking
);
244 else if (inherit_tracking(&tracking
, orig_ref
))
247 if (!tracking
.matches
)
249 case BRANCH_TRACK_ALWAYS
:
250 case BRANCH_TRACK_EXPLICIT
:
251 case BRANCH_TRACK_OVERRIDE
:
252 case BRANCH_TRACK_INHERIT
:
258 if (tracking
.matches
> 1)
259 die(_("Not tracking: ambiguous information for ref %s"),
262 if (tracking
.srcs
->nr
< 1)
263 string_list_append(tracking
.srcs
, orig_ref
);
264 if (install_branch_config_multiple_remotes(config_flags
, new_ref
,
265 tracking
.remote
, tracking
.srcs
) < 0)
269 string_list_clear(&tracking_srcs
, 0);
272 int read_branch_desc(struct strbuf
*buf
, const char *branch_name
)
275 struct strbuf name
= STRBUF_INIT
;
276 strbuf_addf(&name
, "branch.%s.description", branch_name
);
277 if (git_config_get_string(name
.buf
, &v
)) {
278 strbuf_release(&name
);
281 strbuf_addstr(buf
, v
);
283 strbuf_release(&name
);
288 * Check if 'name' can be a valid name for a branch; die otherwise.
289 * Return 1 if the named branch already exists; return 0 otherwise.
290 * Fill ref with the full refname for the branch.
292 int validate_branchname(const char *name
, struct strbuf
*ref
)
294 if (strbuf_check_branch_ref(ref
, name
))
295 die(_("'%s' is not a valid branch name."), name
);
297 return ref_exists(ref
->buf
);
301 * Check if a branch 'name' can be created as a new branch; die otherwise.
302 * 'force' can be used when it is OK for the named branch already exists.
303 * Return 1 if the named branch already exists; return 0 otherwise.
304 * Fill ref with the full refname for the branch.
306 int validate_new_branchname(const char *name
, struct strbuf
*ref
, int force
)
310 if (!validate_branchname(name
, ref
))
314 die(_("A branch named '%s' already exists."),
315 ref
->buf
+ strlen("refs/heads/"));
317 head
= resolve_ref_unsafe("HEAD", 0, NULL
, NULL
);
318 if (!is_bare_repository() && head
&& !strcmp(head
, ref
->buf
))
319 die(_("Cannot force update the current branch."));
324 static int check_tracking_branch(struct remote
*remote
, void *cb_data
)
326 char *tracking_branch
= cb_data
;
327 struct refspec_item query
;
328 memset(&query
, 0, sizeof(struct refspec_item
));
329 query
.dst
= tracking_branch
;
330 return !remote_find_tracking(remote
, &query
);
333 static int validate_remote_tracking_branch(char *ref
)
335 return !for_each_remote(check_tracking_branch
, ref
);
338 static const char upstream_not_branch
[] =
339 N_("Cannot setup tracking information; starting point '%s' is not a branch.");
340 static const char upstream_missing
[] =
341 N_("the requested upstream branch '%s' does not exist");
342 static const char upstream_advice
[] =
344 "If you are planning on basing your work on an upstream\n"
345 "branch that already exists at the remote, you may need to\n"
346 "run \"git fetch\" to retrieve it.\n"
348 "If you are planning to push out a new local branch that\n"
349 "will track its remote counterpart, you may want to use\n"
350 "\"git push -u\" to set the upstream config as you push.");
353 * DWIMs a user-provided ref to determine the starting point for a
354 * branch and validates it, where:
356 * - r is the repository to validate the branch for
358 * - start_name is the ref that we would like to test. This is
359 * expanded with DWIM and assigned to out_real_ref.
361 * - track is the tracking mode of the new branch. If tracking is
362 * explicitly requested, start_name must be a branch (because
363 * otherwise start_name cannot be tracked)
365 * - out_oid is an out parameter containing the object_id of start_name
367 * - out_real_ref is an out parameter containing the full, 'real' form
368 * of start_name e.g. refs/heads/main instead of main
371 static void dwim_branch_start(struct repository
*r
, const char *start_name
,
372 enum branch_track track
, char **out_real_ref
,
373 struct object_id
*out_oid
)
375 struct commit
*commit
;
376 struct object_id oid
;
378 int explicit_tracking
= 0;
380 if (track
== BRANCH_TRACK_EXPLICIT
|| track
== BRANCH_TRACK_OVERRIDE
)
381 explicit_tracking
= 1;
384 if (get_oid_mb(start_name
, &oid
)) {
385 if (explicit_tracking
) {
386 int code
= die_message(_(upstream_missing
), start_name
);
387 advise_if_enabled(ADVICE_SET_UPSTREAM_FAILURE
,
391 die(_("Not a valid object name: '%s'."), start_name
);
394 switch (dwim_ref(start_name
, strlen(start_name
), &oid
, &real_ref
, 0)) {
396 /* Not branching from any existing branch */
397 if (explicit_tracking
)
398 die(_(upstream_not_branch
), start_name
);
401 /* Unique completion -- good, only if it is a real branch */
402 if (!starts_with(real_ref
, "refs/heads/") &&
403 validate_remote_tracking_branch(real_ref
)) {
404 if (explicit_tracking
)
405 die(_(upstream_not_branch
), start_name
);
407 FREE_AND_NULL(real_ref
);
411 die(_("Ambiguous object name: '%s'."), start_name
);
415 if ((commit
= lookup_commit_reference(r
, &oid
)) == NULL
)
416 die(_("Not a valid branch point: '%s'."), start_name
);
418 *out_real_ref
= real_ref
;
422 oidcpy(out_oid
, &commit
->object
.oid
);
424 FREE_AND_NULL(real_ref
);
427 void create_branch(struct repository
*r
,
428 const char *name
, const char *start_name
,
429 int force
, int clobber_head_ok
, int reflog
,
430 int quiet
, enum branch_track track
, int dry_run
)
432 struct object_id oid
;
434 struct strbuf ref
= STRBUF_INIT
;
436 struct ref_transaction
*transaction
;
437 struct strbuf err
= STRBUF_INIT
;
440 if (track
== BRANCH_TRACK_OVERRIDE
)
441 BUG("'track' cannot be BRANCH_TRACK_OVERRIDE. Did you mean to call dwim_and_setup_tracking()?");
442 if (clobber_head_ok
&& !force
)
443 BUG("'clobber_head_ok' can only be used with 'force'");
445 if (clobber_head_ok
?
446 validate_branchname(name
, &ref
) :
447 validate_new_branchname(name
, &ref
, force
)) {
451 dwim_branch_start(r
, start_name
, track
, &real_ref
, &oid
);
456 log_all_ref_updates
= LOG_REFS_NORMAL
;
459 msg
= xstrfmt("branch: Reset to %s", start_name
);
461 msg
= xstrfmt("branch: Created from %s", start_name
);
462 transaction
= ref_transaction_begin(&err
);
464 ref_transaction_update(transaction
, ref
.buf
,
465 &oid
, forcing
? NULL
: null_oid(),
467 ref_transaction_commit(transaction
, &err
))
469 ref_transaction_free(transaction
);
470 strbuf_release(&err
);
473 if (real_ref
&& track
)
474 setup_tracking(ref
.buf
+ 11, real_ref
, track
, quiet
);
477 strbuf_release(&ref
);
481 void dwim_and_setup_tracking(struct repository
*r
, const char *new_ref
,
482 const char *orig_ref
, enum branch_track track
,
486 dwim_branch_start(r
, orig_ref
, track
, &real_orig_ref
, NULL
);
487 setup_tracking(new_ref
, real_orig_ref
, track
, quiet
);
491 * Creates a branch in a submodule by calling
492 * create_branches_recursively() in a child process. The child process
493 * is necessary because install_branch_config_multiple_remotes() (which
494 * is called by setup_tracking()) does not support writing configs to
497 static int submodule_create_branch(struct repository
*r
,
498 const struct submodule
*submodule
,
499 const char *name
, const char *start_oid
,
500 const char *tracking_name
, int force
,
501 int reflog
, int quiet
,
502 enum branch_track track
, int dry_run
)
505 struct child_process child
= CHILD_PROCESS_INIT
;
506 struct strbuf child_err
= STRBUF_INIT
;
507 struct strbuf out_buf
= STRBUF_INIT
;
508 char *out_prefix
= xstrfmt("submodule '%s': ", submodule
->name
);
511 child
.stdout_to_stderr
= 1;
513 prepare_other_repo_env(&child
.env_array
, r
->gitdir
);
515 * submodule_create_branch() is indirectly invoked by "git
516 * branch", but we cannot invoke "git branch" in the child
517 * process. "git branch" accepts a branch name and start point,
518 * where the start point is assumed to provide both the OID
519 * (start_oid) and the branch to use for tracking
520 * (tracking_name). But when recursing through submodules,
521 * start_oid and tracking name need to be specified separately
522 * (see create_branches_recursively()).
524 strvec_pushl(&child
.args
, "submodule--helper", "create-branch", NULL
);
526 strvec_push(&child
.args
, "--dry-run");
528 strvec_push(&child
.args
, "--force");
530 strvec_push(&child
.args
, "--quiet");
532 strvec_push(&child
.args
, "--create-reflog");
535 case BRANCH_TRACK_NEVER
:
536 strvec_push(&child
.args
, "--no-track");
538 case BRANCH_TRACK_ALWAYS
:
539 case BRANCH_TRACK_EXPLICIT
:
540 strvec_push(&child
.args
, "--track=direct");
542 case BRANCH_TRACK_OVERRIDE
:
543 BUG("BRANCH_TRACK_OVERRIDE cannot be used when creating a branch.");
545 case BRANCH_TRACK_INHERIT
:
546 strvec_push(&child
.args
, "--track=inherit");
548 case BRANCH_TRACK_UNSPECIFIED
:
549 /* Default for "git checkout". Do not pass --track. */
550 case BRANCH_TRACK_REMOTE
:
551 /* Default for "git branch". Do not pass --track. */
555 strvec_pushl(&child
.args
, name
, start_oid
, tracking_name
, NULL
);
557 if ((ret
= start_command(&child
)))
559 ret
= finish_command(&child
);
560 strbuf_read(&child_err
, child
.err
, 0);
561 strbuf_add_lines(&out_buf
, out_prefix
, child_err
.buf
, child_err
.len
);
564 fprintf(stderr
, "%s", out_buf
.buf
);
566 printf("%s", out_buf
.buf
);
568 strbuf_release(&child_err
);
569 strbuf_release(&out_buf
);
573 void create_branches_recursively(struct repository
*r
, const char *name
,
574 const char *start_commitish
,
575 const char *tracking_name
, int force
,
576 int reflog
, int quiet
, enum branch_track track
,
580 char *branch_point
= NULL
;
581 struct object_id super_oid
;
582 struct submodule_entry_list submodule_entry_list
;
584 /* Perform dwim on start_commitish to get super_oid and branch_point. */
585 dwim_branch_start(r
, start_commitish
, BRANCH_TRACK_NEVER
,
586 &branch_point
, &super_oid
);
589 * If we were not given an explicit name to track, then assume we are at
590 * the top level and, just like the non-recursive case, the tracking
591 * name is the branch point.
594 tracking_name
= branch_point
;
596 submodules_of_tree(r
, &super_oid
, &submodule_entry_list
);
598 * Before creating any branches, first check that the branch can
599 * be created in every submodule.
601 for (i
= 0; i
< submodule_entry_list
.entry_nr
; i
++) {
602 if (submodule_entry_list
.entries
[i
].repo
== NULL
) {
603 int code
= die_message(
604 _("submodule '%s': unable to find submodule"),
605 submodule_entry_list
.entries
[i
].submodule
->name
);
606 if (advice_enabled(ADVICE_SUBMODULES_NOT_UPDATED
))
607 advise(_("You may try updating the submodules using 'git checkout %s && git submodule update --init'"),
612 if (submodule_create_branch(
613 submodule_entry_list
.entries
[i
].repo
,
614 submodule_entry_list
.entries
[i
].submodule
, name
,
615 oid_to_hex(&submodule_entry_list
.entries
[i
]
617 tracking_name
, force
, reflog
, quiet
, track
, 1))
618 die(_("submodule '%s': cannot create branch '%s'"),
619 submodule_entry_list
.entries
[i
].submodule
->name
,
623 create_branch(the_repository
, name
, start_commitish
, force
, 0, reflog
, quiet
,
624 BRANCH_TRACK_NEVER
, dry_run
);
628 * NEEDSWORK If tracking was set up in the superproject but not the
629 * submodule, users might expect "git branch --recurse-submodules" to
630 * fail or give a warning, but this is not yet implemented because it is
631 * tedious to determine whether or not tracking was set up in the
635 setup_tracking(name
, tracking_name
, track
, quiet
);
637 for (i
= 0; i
< submodule_entry_list
.entry_nr
; i
++) {
638 if (submodule_create_branch(
639 submodule_entry_list
.entries
[i
].repo
,
640 submodule_entry_list
.entries
[i
].submodule
, name
,
641 oid_to_hex(&submodule_entry_list
.entries
[i
]
643 tracking_name
, force
, reflog
, quiet
, track
, 0))
644 die(_("submodule '%s': cannot create branch '%s'"),
645 submodule_entry_list
.entries
[i
].submodule
->name
,
647 repo_clear(submodule_entry_list
.entries
[i
].repo
);
651 void remove_merge_branch_state(struct repository
*r
)
653 unlink(git_path_merge_head(r
));
654 unlink(git_path_merge_rr(r
));
655 unlink(git_path_merge_msg(r
));
656 unlink(git_path_merge_mode(r
));
657 unlink(git_path_auto_merge(r
));
658 save_autostash(git_path_merge_autostash(r
));
661 void remove_branch_state(struct repository
*r
, int verbose
)
663 sequencer_post_commit_cleanup(r
, verbose
);
664 unlink(git_path_squash_msg(r
));
665 remove_merge_branch_state(r
);
668 void die_if_checked_out(const char *branch
, int ignore_current_worktree
)
670 const struct worktree
*wt
;
672 wt
= find_shared_symref("HEAD", branch
);
673 if (!wt
|| (ignore_current_worktree
&& wt
->is_current
))
675 skip_prefix(branch
, "refs/heads/", &branch
);
676 die(_("'%s' is already checked out at '%s'"),
680 int replace_each_worktree_head_symref(const char *oldref
, const char *newref
,
684 struct worktree
**worktrees
= get_worktrees();
687 for (i
= 0; worktrees
[i
]; i
++) {
688 struct ref_store
*refs
;
690 if (worktrees
[i
]->is_detached
)
692 if (!worktrees
[i
]->head_ref
)
694 if (strcmp(oldref
, worktrees
[i
]->head_ref
))
697 refs
= get_worktree_ref_store(worktrees
[i
]);
698 if (refs_create_symref(refs
, "HEAD", newref
, logmsg
))
699 ret
= error(_("HEAD of working tree %s is not updated"),
703 free_worktrees(worktrees
);