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