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