]> git.ipfire.org Git - thirdparty/git.git/blame - builtin/branch.c
Merge branch 'jk/clone-allow-bare-and-o-together'
[thirdparty/git.git] / builtin / branch.c
CommitLineData
c31820c2
LH
1/*
2 * Builtin "git branch"
3 *
d972cce0 4 * Copyright (c) 2006 Kristian Høgsberg <krh@redhat.com>
c31820c2
LH
5 * Based on git-branch.sh by Junio C Hamano.
6 */
7
8#include "cache.h"
b2141fc1 9#include "config.h"
85023577 10#include "color.h"
c31820c2
LH
11#include "refs.h"
12#include "commit.h"
13#include "builtin.h"
6f084a56 14#include "remote.h"
a8dfd5ea 15#include "parse-options.h"
e496c003 16#include "branch.h"
68067ca1
JH
17#include "diff.h"
18#include "revision.h"
ebe31ef2
NTND
19#include "string-list.h"
20#include "column.h"
1452bd64 21#include "utf8.h"
c8183cd2 22#include "wt-status.h"
1511b22d 23#include "ref-filter.h"
f292244c 24#include "worktree.h"
3ac68a93 25#include "help.h"
64043556 26#include "commit-reach.h"
a8dfd5ea
PH
27
28static const char * const builtin_branch_usage[] = {
21bf9339 29 N_("git branch [<options>] [-r | -a] [--merged] [--no-merged]"),
961b130d
GC
30 N_("git branch [<options>] [-f] [--recurse-submodules] <branch-name> [<start-point>]"),
31 N_("git branch [<options>] [-l] [<pattern>...]"),
9c9b4f2f
AH
32 N_("git branch [<options>] [-r] (-d | -D) <branch-name>..."),
33 N_("git branch [<options>] (-m | -M) [<old-branch>] <new-branch>"),
52d59cc6 34 N_("git branch [<options>] (-c | -C) [<old-branch>] <new-branch>"),
aa3bc55e 35 N_("git branch [<options>] [-r | -a] [--points-at]"),
3d9e4ce3 36 N_("git branch [<options>] [-r | -a] [--format]"),
a8dfd5ea
PH
37 NULL
38};
c31820c2 39
c31820c2 40static const char *head;
0c77cd24 41static struct object_id head_oid;
961b130d
GC
42static int recurse_submodules = 0;
43static int submodule_propagate_branches = 0;
c31820c2 44
6b2f2d98 45static int branch_use_color = -1;
a1158cae 46static char branch_colors[][COLOR_MAXLEN] = {
dc6ebd4c 47 GIT_COLOR_RESET,
949af068
KN
48 GIT_COLOR_NORMAL, /* PLAIN */
49 GIT_COLOR_RED, /* REMOTE */
50 GIT_COLOR_NORMAL, /* LOCAL */
51 GIT_COLOR_GREEN, /* CURRENT */
52 GIT_COLOR_BLUE, /* UPSTREAM */
ab313814 53 GIT_COLOR_CYAN, /* WORKTREE */
a1158cae
AP
54};
55enum color_branch {
74bb2dfb
AL
56 BRANCH_COLOR_RESET = 0,
57 BRANCH_COLOR_PLAIN = 1,
58 BRANCH_COLOR_REMOTE = 2,
59 BRANCH_COLOR_LOCAL = 3,
dbda21fa 60 BRANCH_COLOR_CURRENT = 4,
ab313814
NB
61 BRANCH_COLOR_UPSTREAM = 5,
62 BRANCH_COLOR_WORKTREE = 6
a1158cae
AP
63};
64
a73b3680
NTND
65static const char *color_branch_slots[] = {
66 [BRANCH_COLOR_RESET] = "reset",
67 [BRANCH_COLOR_PLAIN] = "plain",
68 [BRANCH_COLOR_REMOTE] = "remote",
69 [BRANCH_COLOR_LOCAL] = "local",
70 [BRANCH_COLOR_CURRENT] = "current",
71 [BRANCH_COLOR_UPSTREAM] = "upstream",
ab313814 72 [BRANCH_COLOR_WORKTREE] = "worktree",
a73b3680
NTND
73};
74
ebe31ef2
NTND
75static struct string_list output = STRING_LIST_INIT_DUP;
76static unsigned int colopts;
77
3ac68a93 78define_list_config_array(color_branch_slots);
a1158cae 79
ef90d6d4 80static int git_branch_config(const char *var, const char *value, void *cb)
a1158cae 81{
e3f1da98 82 const char *slot_name;
560ae1c1
SM
83
84 if (!strcmp(var, "branch.sort")) {
85 if (!value)
86 return config_error_nonbool(var);
98e7ab6d 87 string_list_append(cb, value);
560ae1c1
SM
88 return 0;
89 }
e3f1da98 90
59556548 91 if (starts_with(var, "column."))
ebe31ef2 92 return git_column_config(var, value, "branch", &colopts);
a1158cae 93 if (!strcmp(var, "color.branch")) {
e269eb79 94 branch_use_color = git_config_colorbool(var, value);
a1158cae
AP
95 return 0;
96 }
e3f1da98 97 if (skip_prefix(var, "color.branch.", &slot_name)) {
a73b3680 98 int slot = LOOKUP_CONFIG(color_branch_slots, slot_name);
8b8e8624
JK
99 if (slot < 0)
100 return 0;
5768c98a
JH
101 if (!value)
102 return config_error_nonbool(var);
f6c5a296 103 return color_parse(value, branch_colors[slot]);
a1158cae 104 }
961b130d
GC
105 if (!strcmp(var, "submodule.recurse")) {
106 recurse_submodules = git_config_bool(var, value);
107 return 0;
108 }
109 if (!strcasecmp(var, "submodule.propagateBranches")) {
110 submodule_propagate_branches = git_config_bool(var, value);
111 return 0;
112 }
113
33c643bb 114 return git_color_default_config(var, value, cb);
a1158cae
AP
115}
116
52fae7de 117static const char *branch_get_color(enum color_branch ix)
a1158cae 118{
daa0c3d9 119 if (want_color(branch_use_color))
a1158cae
AP
120 return branch_colors[ix];
121 return "";
122}
123
99c419c9
JH
124static int branch_merged(int kind, const char *name,
125 struct commit *rev, struct commit *head_rev)
126{
127 /*
128 * This checks whether the merge bases of branch and HEAD (or
129 * the other branch this branch builds upon) contains the
130 * branch, which means that the branch has already been merged
131 * safely to HEAD (or the other branch).
132 */
133 struct commit *reference_rev = NULL;
134 const char *reference_name = NULL;
96ec7b1e 135 void *reference_name_to_free = NULL;
99c419c9
JH
136 int merged;
137
1511b22d 138 if (kind == FILTER_REFS_BRANCHES) {
99c419c9 139 struct branch *branch = branch_get(name);
3a429d0a 140 const char *upstream = branch_get_upstream(branch, NULL);
0c77cd24 141 struct object_id oid;
99c419c9 142
a9f9f8cc 143 if (upstream &&
96ec7b1e 144 (reference_name = reference_name_to_free =
a9f9f8cc 145 resolve_refdup(upstream, RESOLVE_REF_READING,
0f2dc722 146 &oid, NULL)) != NULL)
2122f675
SB
147 reference_rev = lookup_commit_reference(the_repository,
148 &oid);
99c419c9
JH
149 }
150 if (!reference_rev)
151 reference_rev = head_rev;
152
a20efee9 153 merged = in_merge_bases(rev, reference_rev);
99c419c9
JH
154
155 /*
156 * After the safety valve is fully redefined to "check with
157 * upstream, if any, otherwise with HEAD", we should just
158 * return the result of the in_merge_bases() above without
159 * any of the following code, but during the transition period,
160 * a gentle reminder is in order.
161 */
162 if ((head_rev != reference_rev) &&
a20efee9 163 in_merge_bases(rev, head_rev) != merged) {
99c419c9 164 if (merged)
49df4b02 165 warning(_("deleting branch '%s' that has been merged to\n"
6c80cd29 166 " '%s', but not yet merged to HEAD."),
99c419c9
JH
167 name, reference_name);
168 else
49df4b02
ÆAB
169 warning(_("not deleting branch '%s' that is not yet merged to\n"
170 " '%s', even though it is merged to HEAD."),
99c419c9
JH
171 name, reference_name);
172 }
96ec7b1e 173 free(reference_name_to_free);
99c419c9
JH
174 return merged;
175}
176
f5d0e162 177static int check_branch_commit(const char *branchname, const char *refname,
0c77cd24 178 const struct object_id *oid, struct commit *head_rev,
f5d0e162
RS
179 int kinds, int force)
180{
2122f675 181 struct commit *rev = lookup_commit_reference(the_repository, oid);
597a9774 182 if (!force && !rev) {
f5d0e162
RS
183 error(_("Couldn't look up commit object for '%s'"), refname);
184 return -1;
185 }
186 if (!force && !branch_merged(kinds, branchname, rev, head_rev)) {
187 error(_("The branch '%s' is not fully merged.\n"
188 "If you are sure you want to delete it, "
189 "run 'git branch -D %s'."), branchname, branchname);
190 return -1;
191 }
192 return 0;
193}
194
22ed7927
RS
195static void delete_branch_config(const char *branchname)
196{
197 struct strbuf buf = STRBUF_INIT;
198 strbuf_addf(&buf, "branch.%s", branchname);
199 if (git_config_rename_section(buf.buf, NULL) < 0)
200 warning(_("Update of config-file failed"));
201 strbuf_release(&buf);
202}
203
d65ddf19
JK
204static int delete_branches(int argc, const char **argv, int force, int kinds,
205 int quiet)
c31820c2 206{
f5d0e162 207 struct commit *head_rev = NULL;
0c77cd24 208 struct object_id oid;
b8e9a00d 209 char *name = NULL;
c179837c 210 const char *fmt;
c31820c2 211 int i;
b8e9a00d 212 int ret = 0;
c179837c 213 int remote_branch = 0;
8415d5c7 214 struct strbuf bname = STRBUF_INIT;
6b145e01 215 unsigned allowed_interpret;
81989077
PH
216 struct string_list refs_to_delete = STRING_LIST_INIT_DUP;
217 struct string_list_item *item;
218 int branch_name_pos;
c31820c2 219
f3d985c3 220 switch (kinds) {
1511b22d 221 case FILTER_REFS_REMOTES:
f3d985c3 222 fmt = "refs/remotes/%s";
c179837c
ÆAB
223 /* For subsequent UI messages */
224 remote_branch = 1;
6b145e01 225 allowed_interpret = INTERPRET_BRANCH_REMOTE;
c179837c 226
f3d985c3
JH
227 force = 1;
228 break;
1511b22d 229 case FILTER_REFS_BRANCHES:
f3d985c3 230 fmt = "refs/heads/%s";
6b145e01 231 allowed_interpret = INTERPRET_BRANCH_LOCAL;
f3d985c3
JH
232 break;
233 default:
49df4b02 234 die(_("cannot use -a with -d"));
f3d985c3 235 }
81989077 236 branch_name_pos = strcspn(fmt, "%");
c31820c2 237
67affd51 238 if (!force) {
2122f675 239 head_rev = lookup_commit_reference(the_repository, &head_oid);
67affd51 240 if (!head_rev)
49df4b02 241 die(_("Couldn't look up commit object for HEAD"));
67affd51 242 }
c8dd491f 243
a9155c50 244 for (i = 0; i < argc; i++, strbuf_reset(&bname)) {
8bb04553 245 char *target = NULL;
0fe700e3
RS
246 int flags = 0;
247
6b145e01 248 strbuf_branchname(&bname, argv[i], allowed_interpret);
8e0f7003 249 free(name);
4e2d094d 250 name = mkpathdup(fmt, bname.buf);
f292244c
KY
251
252 if (kinds == FILTER_REFS_BRANCHES) {
b489b9d9
DS
253 const char *path;
254 if ((path = branch_checked_out(name))) {
f292244c
KY
255 error(_("Cannot delete branch '%s' "
256 "checked out at '%s'"),
b489b9d9 257 bname.buf, path);
f292244c
KY
258 ret = 1;
259 continue;
260 }
261 }
262
8bb04553
MH
263 target = resolve_refdup(name,
264 RESOLVE_REF_READING
265 | RESOLVE_REF_NO_RECURSE
266 | RESOLVE_REF_ALLOW_BAD_NAME,
0f2dc722 267 &oid, &flags);
18f29fc6 268 if (!target) {
c179837c 269 error(remote_branch
ccd593cf 270 ? _("remote-tracking branch '%s' not found.")
c179837c 271 : _("branch '%s' not found."), bname.buf);
b8e9a00d
QT
272 ret = 1;
273 continue;
274 }
c31820c2 275
d0f810f0 276 if (!(flags & (REF_ISSYMREF|REF_ISBROKEN)) &&
0c77cd24 277 check_branch_commit(bname.buf, name, &oid, head_rev, kinds,
f5d0e162 278 force)) {
b8e9a00d 279 ret = 1;
8bb04553 280 goto next;
c31820c2
LH
281 }
282
81989077
PH
283 item = string_list_append(&refs_to_delete, name);
284 item->util = xstrdup((flags & REF_ISBROKEN) ? "broken"
285 : (flags & REF_ISSYMREF) ? target
286 : find_unique_abbrev(&oid, DEFAULT_ABBREV));
8bb04553
MH
287
288 next:
289 free(target);
c31820c2 290 }
c31820c2 291
81989077
PH
292 if (delete_refs(NULL, &refs_to_delete, REF_NO_DEREF))
293 ret = 1;
294
295 for_each_string_list_item(item, &refs_to_delete) {
296 char *describe_ref = item->util;
297 char *name = item->string;
298 if (!ref_exists(name)) {
299 char *refname = name + branch_name_pos;
300 if (!quiet)
301 printf(remote_branch
302 ? _("Deleted remote-tracking branch %s (was %s).\n")
303 : _("Deleted branch %s (was %s).\n"),
304 name + branch_name_pos, describe_ref);
305
306 delete_branch_config(refname);
307 }
308 free(describe_ref);
309 }
310 string_list_clear(&refs_to_delete, 0);
311
8e0f7003 312 free(name);
a9155c50 313 strbuf_release(&bname);
b8e9a00d 314
a9155c50 315 return ret;
c31820c2 316}
c31820c2 317
949af068 318static int calc_maxwidth(struct ref_array *refs, int remote_bonus)
94fcb730 319{
949af068
KN
320 int i, max = 0;
321 for (i = 0; i < refs->nr; i++) {
322 struct ref_array_item *it = refs->items[i];
323 const char *desc = it->refname;
324 int w;
dbda21fa 325
949af068
KN
326 skip_prefix(it->refname, "refs/heads/", &desc);
327 skip_prefix(it->refname, "refs/remotes/", &desc);
328 if (it->kind == FILTER_REFS_DETACHED_HEAD) {
329 char *head_desc = get_head_description();
330 w = utf8_strwidth(head_desc);
331 free(head_desc);
332 } else
333 w = utf8_strwidth(desc);
21dfc09d 334
949af068
KN
335 if (it->kind == FILTER_REFS_REMOTES)
336 w += remote_bonus;
337 if (w > max)
338 max = w;
21dfc09d 339 }
949af068 340 return max;
94fcb730
JH
341}
342
949af068 343static const char *quote_literal_for_format(const char *s)
6e0332ec 344{
949af068
KN
345 static struct strbuf buf = STRBUF_INIT;
346
347 strbuf_reset(&buf);
348 while (*s) {
349 const char *ep = strchrnul(s, '%');
350 if (s < ep)
351 strbuf_add(&buf, s, ep - s);
352 if (*ep == '%') {
353 strbuf_addstr(&buf, "%%");
354 s = ep + 1;
355 } else {
356 s = ep;
357 }
6e0332ec 358 }
949af068 359 return buf.buf;
6e0332ec
JN
360}
361
949af068 362static char *build_format(struct ref_filter *filter, int maxwidth, const char *remote_prefix)
75e6e213 363{
949af068
KN
364 struct strbuf fmt = STRBUF_INIT;
365 struct strbuf local = STRBUF_INIT;
366 struct strbuf remote = STRBUF_INIT;
75e6e213 367
ab313814
NB
368 strbuf_addf(&local, "%%(if)%%(HEAD)%%(then)* %s%%(else)%%(if)%%(worktreepath)%%(then)+ %s%%(else) %s%%(end)%%(end)",
369 branch_get_color(BRANCH_COLOR_CURRENT),
370 branch_get_color(BRANCH_COLOR_WORKTREE),
371 branch_get_color(BRANCH_COLOR_LOCAL));
7ca260ab
JK
372 strbuf_addf(&remote, " %s",
373 branch_get_color(BRANCH_COLOR_REMOTE));
75e6e213 374
1511b22d 375 if (filter->verbose) {
ac5bbc02
JH
376 struct strbuf obname = STRBUF_INIT;
377
378 if (filter->abbrev < 0)
379 strbuf_addf(&obname, "%%(objectname:short)");
380 else if (!filter->abbrev)
381 strbuf_addf(&obname, "%%(objectname)");
382 else
383 strbuf_addf(&obname, "%%(objectname:short=%d)", filter->abbrev);
384
949af068 385 strbuf_addf(&local, "%%(align:%d,left)%%(refname:lstrip=2)%%(end)", maxwidth);
72d4a9a7 386 strbuf_addstr(&local, branch_get_color(BRANCH_COLOR_RESET));
ac5bbc02 387 strbuf_addf(&local, " %s ", obname.buf);
949af068
KN
388
389 if (filter->verbose > 1)
6e938146
NB
390 {
391 strbuf_addf(&local, "%%(if:notequals=*)%%(HEAD)%%(then)%%(if)%%(worktreepath)%%(then)(%s%%(worktreepath)%s) %%(end)%%(end)",
392 branch_get_color(BRANCH_COLOR_WORKTREE), branch_get_color(BRANCH_COLOR_RESET));
949af068
KN
393 strbuf_addf(&local, "%%(if)%%(upstream)%%(then)[%s%%(upstream:short)%s%%(if)%%(upstream:track)"
394 "%%(then): %%(upstream:track,nobracket)%%(end)] %%(end)%%(contents:subject)",
395 branch_get_color(BRANCH_COLOR_UPSTREAM), branch_get_color(BRANCH_COLOR_RESET));
6e938146 396 }
949af068
KN
397 else
398 strbuf_addf(&local, "%%(if)%%(upstream:track)%%(then)%%(upstream:track) %%(end)%%(contents:subject)");
399
7ca260ab 400 strbuf_addf(&remote, "%%(align:%d,left)%s%%(refname:lstrip=2)%%(end)%s"
ac5bbc02
JH
401 "%%(if)%%(symref)%%(then) -> %%(symref:short)"
402 "%%(else) %s %%(contents:subject)%%(end)",
7ca260ab 403 maxwidth, quote_literal_for_format(remote_prefix),
ac5bbc02
JH
404 branch_get_color(BRANCH_COLOR_RESET), obname.buf);
405 strbuf_release(&obname);
ebe31ef2 406 } else {
949af068
KN
407 strbuf_addf(&local, "%%(refname:lstrip=2)%s%%(if)%%(symref)%%(then) -> %%(symref:short)%%(end)",
408 branch_get_color(BRANCH_COLOR_RESET));
7ca260ab
JK
409 strbuf_addf(&remote, "%s%%(refname:lstrip=2)%s%%(if)%%(symref)%%(then) -> %%(symref:short)%%(end)",
410 quote_literal_for_format(remote_prefix),
949af068 411 branch_get_color(BRANCH_COLOR_RESET));
ebe31ef2 412 }
75e6e213 413
949af068 414 strbuf_addf(&fmt, "%%(if:notequals=refs/remotes)%%(refname:rstrip=-2)%%(then)%s%%(else)%s%%(end)", local.buf, remote.buf);
aedcb7dc 415
949af068
KN
416 strbuf_release(&local);
417 strbuf_release(&remote);
418 return strbuf_detach(&fmt, NULL);
7e9ff00b
LT
419}
420
d72d4f92
ÆAB
421static void print_ref_list(struct ref_filter *filter, struct ref_sorting *sorting,
422 struct ref_format *format, struct string_list *output)
c31820c2
LH
423{
424 int i;
1511b22d 425 struct ref_array array;
844c3f0b
ZH
426 struct strbuf out = STRBUF_INIT;
427 struct strbuf err = STRBUF_INIT;
1051e40d
KN
428 int maxwidth = 0;
429 const char *remote_prefix = "";
3d9e4ce3 430 char *to_free = NULL;
1051e40d 431
35257aa0 432 /*
1051e40d
KN
433 * If we are listing more than just remote branches,
434 * then remote branches will have a "remotes/" prefix.
435 * We need to account for this in the width.
35257aa0 436 */
1511b22d 437 if (filter->kind != FILTER_REFS_REMOTES)
1051e40d 438 remote_prefix = "remotes/";
8376a704 439
1511b22d 440 memset(&array, 0, sizeof(array));
8376a704 441
1763334c 442 filter_refs(&array, filter, filter->kind);
c31820c2 443
1511b22d
KN
444 if (filter->verbose)
445 maxwidth = calc_maxwidth(&array, strlen(remote_prefix));
bfcc9214 446
4a68e36d
JK
447 if (!format->format)
448 format->format = to_free = build_format(filter, maxwidth, remote_prefix);
11b087ad 449 format->use_color = branch_use_color;
2eda0102
JK
450
451 if (verify_ref_format(format))
452 die(_("unable to parse format string"));
949af068 453
aedcb7dc 454 ref_array_sort(sorting, &array);
1603ade8 455
949af068 456 for (i = 0; i < array.nr; i++) {
844c3f0b
ZH
457 strbuf_reset(&err);
458 strbuf_reset(&out);
3019eca9
OT
459 if (format_ref_array_item(array.items[i], format, &out, &err))
460 die("%s", err.buf);
949af068
KN
461 if (column_active(colopts)) {
462 assert(!filter->verbose && "--column and --verbose are incompatible");
463 /* format to a string_list to let print_columns() do its job */
d72d4f92 464 string_list_append(output, out.buf);
949af068
KN
465 } else {
466 fwrite(out.buf, 1, out.len, stdout);
467 putchar('\n');
468 }
949af068 469 }
0e9716e6 470
844c3f0b
ZH
471 strbuf_release(&err);
472 strbuf_release(&out);
1511b22d 473 ref_array_clear(&array);
3d9e4ce3 474 free(to_free);
c31820c2
LH
475}
476
0ecb1fc7
DU
477static void print_current_branch_name(void)
478{
479 int flags;
480 const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, &flags);
481 const char *shortname;
482 if (!refname)
483 die(_("could not resolve HEAD"));
484 else if (!(flags & REF_ISSYMREF))
485 return;
486 else if (skip_prefix(refname, "refs/heads/", &shortname))
487 puts(shortname);
488 else
489 die(_("HEAD (%s) points outside of refs/heads/"), refname);
490}
491
14ace5b7
NTND
492static void reject_rebase_or_bisect_branch(const char *target)
493{
03f2465b 494 struct worktree **worktrees = get_worktrees();
14ace5b7
NTND
495 int i;
496
497 for (i = 0; worktrees[i]; i++) {
498 struct worktree *wt = worktrees[i];
499
500 if (!wt->is_detached)
501 continue;
502
503 if (is_worktree_being_rebased(wt, target))
504 die(_("Branch %s is being rebased at %s"),
505 target, wt->path);
506
507 if (is_worktree_being_bisected(wt, target))
508 die(_("Branch %s is being bisected at %s"),
509 target, wt->path);
510 }
511
512 free_worktrees(worktrees);
513}
514
52d59cc6 515static void copy_or_rename_branch(const char *oldname, const char *newname, int copy, int force)
c976d415 516{
da3f78a2 517 struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
da3f78a2 518 struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
255073ca
KS
519 const char *interpreted_oldname = NULL;
520 const char *interpreted_newname = NULL;
cbdffe40 521 int recovery = 0;
c976d415 522
52d59cc6
SD
523 if (!oldname) {
524 if (copy)
525 die(_("cannot copy the current branch while not on any."));
526 else
527 die(_("cannot rename the current branch while not on any."));
528 }
c847f537 529
cbdffe40
JH
530 if (strbuf_check_branch_ref(&oldref, oldname)) {
531 /*
532 * Bad name --- this could be an attempt to rename a
533 * ref that we used to allow to be created by accident.
534 */
c6893323 535 if (ref_exists(oldref.buf))
cbdffe40
JH
536 recovery = 1;
537 else
49df4b02 538 die(_("Invalid branch name: '%s'"), oldname);
cbdffe40 539 }
c976d415 540
3f59481e
JN
541 /*
542 * A command like "git branch -M currentbranch currentbranch" cannot
543 * cause the worktree to become inconsistent with HEAD, so allow it.
544 */
bc1c9c0e
JH
545 if (!strcmp(oldname, newname))
546 validate_branchname(newname, &newref);
547 else
548 validate_new_branchname(newname, &newref, force);
c976d415 549
14ace5b7
NTND
550 reject_rebase_or_bisect_branch(oldref.buf);
551
255073ca
KS
552 if (!skip_prefix(oldref.buf, "refs/heads/", &interpreted_oldname) ||
553 !skip_prefix(newref.buf, "refs/heads/", &interpreted_newname)) {
033abf97 554 BUG("expected prefix missing for refs");
255073ca
KS
555 }
556
52d59cc6
SD
557 if (copy)
558 strbuf_addf(&logmsg, "Branch: copied %s to %s",
559 oldref.buf, newref.buf);
560 else
561 strbuf_addf(&logmsg, "Branch: renamed %s to %s",
562 oldref.buf, newref.buf);
678d0f4c 563
cfaff3aa
JS
564 if (!copy &&
565 (!head || strcmp(oldname, head) || !is_null_oid(&head_oid)) &&
566 rename_ref(oldref.buf, newref.buf, logmsg.buf))
49df4b02 567 die(_("Branch rename failed"));
52d59cc6
SD
568 if (copy && copy_existing_ref(oldref.buf, newref.buf, logmsg.buf))
569 die(_("Branch copy failed"));
c976d415 570
52d59cc6
SD
571 if (recovery) {
572 if (copy)
a48ebe97 573 warning(_("Created a copy of a misnamed branch '%s'"),
255073ca 574 interpreted_oldname);
52d59cc6
SD
575 else
576 warning(_("Renamed a misnamed branch '%s' away"),
255073ca 577 interpreted_oldname);
52d59cc6 578 }
cbdffe40 579
e5435ff1
JH
580 if (!copy &&
581 replace_each_worktree_head_symref(oldref.buf, newref.buf, logmsg.buf))
49df4b02 582 die(_("Branch renamed to %s, but HEAD is not updated!"), newname);
19eba151 583
39ee4c6c
KM
584 strbuf_release(&logmsg);
585
255073ca 586 strbuf_addf(&oldsection, "branch.%s", interpreted_oldname);
da3f78a2 587 strbuf_release(&oldref);
255073ca 588 strbuf_addf(&newsection, "branch.%s", interpreted_newname);
da3f78a2 589 strbuf_release(&newref);
52d59cc6 590 if (!copy && git_config_rename_section(oldsection.buf, newsection.buf) < 0)
49df4b02 591 die(_("Branch is renamed, but update of config-file failed"));
52d59cc6
SD
592 if (copy && strcmp(oldname, newname) && git_config_copy_section(oldsection.buf, newsection.buf) < 0)
593 die(_("Branch is copied, but update of config-file failed"));
da3f78a2
MV
594 strbuf_release(&oldsection);
595 strbuf_release(&newsection);
c976d415
LH
596}
597
c10388c7 598static GIT_PATH_FUNC(edit_description, "EDIT_DESCRIPTION")
b7200e83
JH
599
600static int edit_branch_description(const char *branch_name)
601{
b7200e83
JH
602 struct strbuf buf = STRBUF_INIT;
603 struct strbuf name = STRBUF_INIT;
604
605 read_branch_desc(&buf, branch_name);
606 if (!buf.len || buf.buf[buf.len-1] != '\n')
607 strbuf_addch(&buf, '\n');
eff80a9f 608 strbuf_commented_addf(&buf,
b18237f4
VA
609 _("Please edit the description for the branch\n"
610 " %s\n"
611 "Lines starting with '%c' will be stripped.\n"),
eff80a9f 612 branch_name, comment_line_char);
c10388c7 613 write_file_buf(edit_description(), buf.buf, buf.len);
b7200e83 614 strbuf_reset(&buf);
c10388c7 615 if (launch_editor(edit_description(), &buf, NULL)) {
b7200e83
JH
616 strbuf_release(&buf);
617 return -1;
618 }
63af4a84 619 strbuf_stripspace(&buf, 1);
b7200e83
JH
620
621 strbuf_addf(&name, "branch.%s.description", branch_name);
3d180648 622 git_config_set(name.buf, buf.len ? buf.buf : NULL);
b7200e83
JH
623 strbuf_release(&name);
624 strbuf_release(&buf);
625
bd25f890 626 return 0;
b7200e83
JH
627}
628
c31820c2
LH
629int cmd_branch(int argc, const char **argv, const char *prefix)
630{
6e0a2ca0
GC
631 /* possible actions */
632 int delete = 0, rename = 0, copy = 0, list = 0,
633 unset_upstream = 0, show_current = 0, edit_description = 0;
6183d826 634 const char *new_upstream = NULL;
6e0a2ca0
GC
635 int noncreate_actions = 0;
636 /* possible options */
961b130d
GC
637 int reflog = 0, quiet = 0, icase = 0, force = 0,
638 recurse_submodules_explicit = 0;
9ed36cfa 639 enum branch_track track;
1511b22d 640 struct ref_filter filter;
98e7ab6d
JH
641 static struct ref_sorting *sorting;
642 struct string_list sorting_options = STRING_LIST_INIT_DUP;
4a68e36d 643 struct ref_format format = REF_FORMAT_INIT;
a8dfd5ea
PH
644
645 struct option options[] = {
24a85214 646 OPT_GROUP(N_("Generic options")),
1511b22d 647 OPT__VERBOSE(&filter.verbose,
24a85214
NTND
648 N_("show hash and subject, give twice for upstream branch")),
649 OPT__QUIET(&quiet, N_("suppress informational messages")),
6327f0ef 650 OPT_CALLBACK_F('t', "track", &track, "(direct|inherit)",
d3115660 651 N_("set branch tracking configuration"),
15f00281 652 PARSE_OPT_OPTARG,
d3115660 653 parse_opt_tracking_mode),
3e4a67b4
NTND
654 OPT_SET_INT_F(0, "set-upstream", &track, N_("do not use"),
655 BRANCH_TRACK_OVERRIDE, PARSE_OPT_HIDDEN),
ab86885a 656 OPT_STRING('u', "set-upstream-to", &new_upstream, N_("upstream"), N_("change the upstream info")),
11de8dd7 657 OPT_BOOL(0, "unset-upstream", &unset_upstream, N_("unset the upstream info")),
24a85214 658 OPT__COLOR(&branch_use_color, N_("use colored output")),
1511b22d
KN
659 OPT_SET_INT('r', "remotes", &filter.kind, N_("act on remote-tracking branches"),
660 FILTER_REFS_REMOTES),
661 OPT_CONTAINS(&filter.with_commit, N_("print only branches that contain the commit")),
ac3f5a34 662 OPT_NO_CONTAINS(&filter.no_commit, N_("print only branches that don't contain the commit")),
1511b22d 663 OPT_WITH(&filter.with_commit, N_("print only branches that contain the commit")),
ac3f5a34 664 OPT_WITHOUT(&filter.no_commit, N_("print only branches that don't contain the commit")),
1511b22d 665 OPT__ABBREV(&filter.abbrev),
a8dfd5ea 666
24a85214 667 OPT_GROUP(N_("Specific git-branch actions:")),
1511b22d
KN
668 OPT_SET_INT('a', "all", &filter.kind, N_("list both remote-tracking and local branches"),
669 FILTER_REFS_REMOTES | FILTER_REFS_BRANCHES),
24a85214
NTND
670 OPT_BIT('d', "delete", &delete, N_("delete fully merged branch"), 1),
671 OPT_BIT('D', NULL, &delete, N_("delete branch (even if not merged)"), 2),
672 OPT_BIT('m', "move", &rename, N_("move/rename a branch and its reflog"), 1),
673 OPT_BIT('M', NULL, &rename, N_("move/rename a branch, even if target exists"), 2),
52d59cc6
SD
674 OPT_BIT('c', "copy", &copy, N_("copy a branch and its reflog"), 1),
675 OPT_BIT('C', NULL, &copy, N_("copy a branch, even if target exists"), 2),
a15d5981 676 OPT_BOOL('l', "list", &list, N_("list branch names")),
0ecb1fc7 677 OPT_BOOL(0, "show-current", &show_current, N_("show current branch name")),
055930bc 678 OPT_BOOL(0, "create-reflog", &reflog, N_("create the branch's reflog")),
d5d09d47
SB
679 OPT_BOOL(0, "edit-description", &edit_description,
680 N_("edit the description for the branch")),
c01b56a3 681 OPT__FORCE(&force, N_("force creation, move/rename, deletion"), PARSE_OPT_NOCOMPLETE),
1511b22d
KN
682 OPT_MERGED(&filter, N_("print only branches that are merged")),
683 OPT_NO_MERGED(&filter, N_("print only branches that are not merged")),
24a85214 684 OPT_COLUMN(0, "column", &colopts, N_("list branches in columns")),
98e7ab6d 685 OPT_REF_SORT(&sorting_options),
203c8533
DL
686 OPT_CALLBACK(0, "points-at", &filter.points_at, N_("object"),
687 N_("print only branches of the object"), parse_opt_object_name),
3bb16a8b 688 OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
961b130d 689 OPT_BOOL(0, "recurse-submodules", &recurse_submodules_explicit, N_("recurse through submodules")),
4a68e36d 690 OPT_STRING( 0 , "format", &format.format, N_("format"), N_("format to use for the output")),
a8dfd5ea
PH
691 OPT_END(),
692 };
c31820c2 693
56b43607
KN
694 setup_ref_filter_porcelain_msg();
695
1511b22d
KN
696 memset(&filter, 0, sizeof(filter));
697 filter.kind = FILTER_REFS_BRANCHES;
698 filter.abbrev = -1;
699
1dacfbcf
NTND
700 if (argc == 2 && !strcmp(argv[1], "-h"))
701 usage_with_options(builtin_branch_usage, options);
702
98e7ab6d 703 git_config(git_branch_config, &sorting_options);
6b2f2d98 704
9ed36cfa 705 track = git_branch_track;
c976d415 706
0f2dc722 707 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
c31820c2 708 if (!head)
49df4b02 709 die(_("Failed to resolve HEAD as a valid ref."));
e3f1da98 710 if (!strcmp(head, "HEAD"))
1511b22d 711 filter.detached = 1;
e3f1da98
RS
712 else if (!skip_prefix(head, "refs/heads/", &head))
713 die(_("HEAD not found below refs/heads!"));
ebe31ef2 714
37782920
SB
715 argc = parse_options(argc, argv, prefix, options, builtin_branch_usage,
716 0);
cddd127b 717
0ecb1fc7
DU
718 if (!delete && !rename && !copy && !edit_description && !new_upstream &&
719 !show_current && !unset_upstream && argc == 0)
cddd127b
MG
720 list = 1;
721
21bf9339
AL
722 if (filter.with_commit || filter.no_commit ||
723 filter.reachable_from || filter.unreachable_from || filter.points_at.nr)
d0403508
JK
724 list = 1;
725
6e0a2ca0
GC
726 noncreate_actions = !!delete + !!rename + !!copy + !!new_upstream +
727 !!show_current + !!list + !!edit_description +
728 !!unset_upstream;
729 if (noncreate_actions > 1)
049716b3 730 usage_with_options(builtin_branch_usage, options);
c31820c2 731
961b130d
GC
732 if (recurse_submodules_explicit) {
733 if (!submodule_propagate_branches)
734 die(_("branch with --recurse-submodules can only be used if submodule.propagateBranches is enabled"));
735 if (noncreate_actions)
736 die(_("--recurse-submodules can only be used to create branches"));
737 }
738
739 recurse_submodules =
740 (recurse_submodules || recurse_submodules_explicit) &&
741 submodule_propagate_branches;
742
1511b22d
KN
743 if (filter.abbrev == -1)
744 filter.abbrev = DEFAULT_ABBREV;
3bb16a8b
NTND
745 filter.ignore_case = icase;
746
ebe31ef2 747 finalize_colopts(&colopts, -1);
1511b22d 748 if (filter.verbose) {
ebe31ef2 749 if (explicitly_enable_column(colopts))
12909b6b 750 die(_("options '%s' and '%s' cannot be used together"), "--column", "--verbose");
ebe31ef2
NTND
751 colopts = 0;
752 }
b792c067 753
356e91f2
MG
754 if (force) {
755 delete *= 2;
756 rename *= 2;
52d59cc6 757 copy *= 2;
356e91f2
MG
758 }
759
d74b541e 760 if (list)
0ae19de7 761 setup_auto_pager("branch", 1);
d74b541e 762
640d0401
NTND
763 if (delete) {
764 if (!argc)
765 die(_("branch name required"));
1511b22d 766 return delete_branches(argc, argv, delete > 1, filter.kind, quiet);
0ecb1fc7
DU
767 } else if (show_current) {
768 print_current_branch_name();
769 return 0;
640d0401 770 } else if (list) {
ffdd02a5 771 /* git branch --list also shows HEAD when it is detached */
1511b22d
KN
772 if ((filter.kind & FILTER_REFS_BRANCHES) && filter.detached)
773 filter.kind |= FILTER_REFS_DETACHED_HEAD;
774 filter.name_patterns = argv;
3bb16a8b
NTND
775 /*
776 * If no sorting parameter is given then we default to sorting
777 * by 'refname'. This would give us an alphabetically sorted
778 * array with the 'HEAD' ref at the beginning followed by
30aa96cd 779 * local branches 'refs/heads/...' and finally remote-tracking
3bb16a8b
NTND
780 * branches 'refs/remotes/...'.
781 */
98e7ab6d 782 sorting = ref_sorting_options(&sorting_options);
7c269a7b 783 ref_sorting_set_sort_flags_all(sorting, REF_SORTING_ICASE, icase);
2708ce62
ÆAB
784 ref_sorting_set_sort_flags_all(
785 sorting, REF_SORTING_DETACHED_HEAD_FIRST, 1);
d72d4f92 786 print_ref_list(&filter, sorting, &format, &output);
ebe31ef2
NTND
787 print_columns(&output, colopts, NULL);
788 string_list_clear(&output, 0);
d72d4f92 789 ref_sorting_release(sorting);
ca417990 790 return 0;
2e3c894f 791 } else if (edit_description) {
b7200e83 792 const char *branch_name;
c2d17ba3
JH
793 struct strbuf branch_ref = STRBUF_INIT;
794
75135b23 795 if (!argc) {
1511b22d 796 if (filter.detached)
045e3884 797 die(_("Cannot give description to detached HEAD"));
b7200e83 798 branch_name = head;
75135b23 799 } else if (argc == 1)
b7200e83
JH
800 branch_name = argv[0];
801 else
43722c4d 802 die(_("cannot edit description of more than one branch"));
c2d17ba3
JH
803
804 strbuf_addf(&branch_ref, "refs/heads/%s", branch_name);
805 if (!ref_exists(branch_ref.buf)) {
806 strbuf_release(&branch_ref);
807
808 if (!argc)
045e3884 809 return error(_("No commit on branch '%s' yet."),
c2d17ba3
JH
810 branch_name);
811 else
045e3884
NTND
812 return error(_("No branch named '%s'."),
813 branch_name);
c2d17ba3
JH
814 }
815 strbuf_release(&branch_ref);
816
b7200e83
JH
817 if (edit_branch_description(branch_name))
818 return 1;
52d59cc6
SD
819 } else if (copy) {
820 if (!argc)
821 die(_("branch name required"));
822 else if (argc == 1)
823 copy_or_rename_branch(head, argv[0], 1, copy > 1);
824 else if (argc == 2)
825 copy_or_rename_branch(argv[0], argv[1], 1, copy > 1);
826 else
827 die(_("too many branches for a copy operation"));
a4043aea 828 } else if (rename) {
d1520c4b
JM
829 if (!argc)
830 die(_("branch name required"));
831 else if (argc == 1)
52d59cc6 832 copy_or_rename_branch(head, argv[0], 0, rename > 1);
3706ed29 833 else if (argc == 2)
52d59cc6 834 copy_or_rename_branch(argv[0], argv[1], 0, rename > 1);
3706ed29 835 else
f7776235 836 die(_("too many arguments for a rename operation"));
6183d826
CMN
837 } else if (new_upstream) {
838 struct branch *branch = branch_get(argv[0]);
839
8efb8899 840 if (argc > 1)
f7776235 841 die(_("too many arguments to set new upstream"));
8efb8899
NTND
842
843 if (!branch) {
844 if (!argc || !strcmp(argv[0], "HEAD"))
845 die(_("could not set upstream of HEAD to %s when "
846 "it does not point to any branch."),
847 new_upstream);
848 die(_("no such branch '%s'"), argv[0]);
849 }
850
6183d826
CMN
851 if (!ref_exists(branch->refname))
852 die(_("branch '%s' does not exist"), branch->name);
853
e89f151d
GC
854 dwim_and_setup_tracking(the_repository, branch->name,
855 new_upstream, BRANCH_TRACK_OVERRIDE,
856 quiet);
b84869ef
CMN
857 } else if (unset_upstream) {
858 struct branch *branch = branch_get(argv[0]);
859 struct strbuf buf = STRBUF_INIT;
860
8efb8899 861 if (argc > 1)
f7776235 862 die(_("too many arguments to unset upstream"));
8efb8899
NTND
863
864 if (!branch) {
865 if (!argc || !strcmp(argv[0], "HEAD"))
866 die(_("could not unset upstream of HEAD when "
867 "it does not point to any branch."));
868 die(_("no such branch '%s'"), argv[0]);
869 }
870
54d07f2e 871 if (!branch_has_merge_config(branch))
b84869ef 872 die(_("Branch '%s' has no upstream information"), branch->name);
b84869ef
CMN
873
874 strbuf_addf(&buf, "branch.%s.remote", branch->name);
504ee129 875 git_config_set_multivar(buf.buf, NULL, NULL, CONFIG_FLAGS_MULTI_REPLACE);
b84869ef
CMN
876 strbuf_reset(&buf);
877 strbuf_addf(&buf, "branch.%s.merge", branch->name);
504ee129 878 git_config_set_multivar(buf.buf, NULL, NULL, CONFIG_FLAGS_MULTI_REPLACE);
b84869ef 879 strbuf_release(&buf);
6e0a2ca0 880 } else if (!noncreate_actions && argc > 0 && argc <= 2) {
961b130d
GC
881 const char *branch_name = argv[0];
882 const char *start_name = argc == 2 ? argv[1] : head;
883
1511b22d 884 if (filter.kind != FILTER_REFS_BRANCHES)
1fde99cf
PO
885 die(_("The -a, and -r, options to 'git branch' do not take a branch name.\n"
886 "Did you mean to use: -a|-r --list <pattern>?"));
b347d06b
CMN
887
888 if (track == BRANCH_TRACK_OVERRIDE)
52668846 889 die(_("the '--set-upstream' option is no longer supported. Please use '--track' or '--set-upstream-to' instead."));
b347d06b 890
961b130d
GC
891 if (recurse_submodules) {
892 create_branches_recursively(the_repository, branch_name,
893 start_name, NULL, force,
894 reflog, quiet, track, 0);
895 return 0;
896 }
897 create_branch(the_repository, branch_name, start_name, force, 0,
898 reflog, quiet, track, 0);
6e8f993a 899 } else
a8dfd5ea 900 usage_with_options(builtin_branch_usage, options);
c31820c2
LH
901
902 return 0;
903}