Coverage Report

Created: 2024-09-08 06:23

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