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