Re-fix check-ref-format documentation mark-up
[git/jnareb-git/bp-gitweb.git] / builtin-remote.c
blobc4945b870882834fdaa75fd3d65f664570f6a5da
1 #include "cache.h"
2 #include "parse-options.h"
3 #include "transport.h"
4 #include "remote.h"
5 #include "string-list.h"
6 #include "strbuf.h"
7 #include "run-command.h"
8 #include "refs.h"
10 static const char * const builtin_remote_usage[] = {
11 "git remote [-v | --verbose]",
12 "git remote add [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url>",
13 "git remote rename <old> <new>",
14 "git remote rm <name>",
15 "git remote set-head <name> (-a | -d | <branch>)",
16 "git remote [-v | --verbose] show [-n] <name>",
17 "git remote prune [-n | --dry-run] <name>",
18 "git remote [-v | --verbose] update [-p | --prune] [group | remote]",
19 NULL
22 static const char * const builtin_remote_add_usage[] = {
23 "git remote add [<options>] <name> <url>",
24 NULL
27 static const char * const builtin_remote_rename_usage[] = {
28 "git remote rename <old> <new>",
29 NULL
32 static const char * const builtin_remote_rm_usage[] = {
33 "git remote rm <name>",
34 NULL
37 static const char * const builtin_remote_sethead_usage[] = {
38 "git remote set-head <name> (-a | -d | <branch>])",
39 NULL
42 static const char * const builtin_remote_show_usage[] = {
43 "git remote show [<options>] <name>",
44 NULL
47 static const char * const builtin_remote_prune_usage[] = {
48 "git remote prune [<options>] <name>",
49 NULL
52 static const char * const builtin_remote_update_usage[] = {
53 "git remote update [<options>] [<group> | <remote>]...",
54 NULL
57 #define GET_REF_STATES (1<<0)
58 #define GET_HEAD_NAMES (1<<1)
59 #define GET_PUSH_REF_STATES (1<<2)
61 static int verbose;
63 static int show_all(void);
64 static int prune_remote(const char *remote, int dry_run);
66 static inline int postfixcmp(const char *string, const char *postfix)
68 int len1 = strlen(string), len2 = strlen(postfix);
69 if (len1 < len2)
70 return 1;
71 return strcmp(string + len1 - len2, postfix);
74 static int opt_parse_track(const struct option *opt, const char *arg, int not)
76 struct string_list *list = opt->value;
77 if (not)
78 string_list_clear(list, 0);
79 else
80 string_list_append(arg, list);
81 return 0;
84 static int fetch_remote(const char *name)
86 const char *argv[] = { "fetch", name, NULL, NULL };
87 if (verbose) {
88 argv[1] = "-v";
89 argv[2] = name;
91 printf("Updating %s\n", name);
92 if (run_command_v_opt(argv, RUN_GIT_CMD))
93 return error("Could not fetch %s", name);
94 return 0;
97 static int add(int argc, const char **argv)
99 int fetch = 0, mirror = 0;
100 struct string_list track = { NULL, 0, 0 };
101 const char *master = NULL;
102 struct remote *remote;
103 struct strbuf buf = STRBUF_INIT, buf2 = STRBUF_INIT;
104 const char *name, *url;
105 int i;
107 struct option options[] = {
108 OPT_BOOLEAN('f', "fetch", &fetch, "fetch the remote branches"),
109 OPT_CALLBACK('t', "track", &track, "branch",
110 "branch(es) to track", opt_parse_track),
111 OPT_STRING('m', "master", &master, "branch", "master branch"),
112 OPT_BOOLEAN(0, "mirror", &mirror, "no separate remotes"),
113 OPT_END()
116 argc = parse_options(argc, argv, NULL, options, builtin_remote_add_usage,
119 if (argc < 2)
120 usage_with_options(builtin_remote_add_usage, options);
122 name = argv[0];
123 url = argv[1];
125 remote = remote_get(name);
126 if (remote && (remote->url_nr > 1 || strcmp(name, remote->url[0]) ||
127 remote->fetch_refspec_nr))
128 die("remote %s already exists.", name);
130 strbuf_addf(&buf2, "refs/heads/test:refs/remotes/%s/test", name);
131 if (!valid_fetch_refspec(buf2.buf))
132 die("'%s' is not a valid remote name", name);
134 strbuf_addf(&buf, "remote.%s.url", name);
135 if (git_config_set(buf.buf, url))
136 return 1;
138 strbuf_reset(&buf);
139 strbuf_addf(&buf, "remote.%s.fetch", name);
141 if (track.nr == 0)
142 string_list_append("*", &track);
143 for (i = 0; i < track.nr; i++) {
144 struct string_list_item *item = track.items + i;
146 strbuf_reset(&buf2);
147 strbuf_addch(&buf2, '+');
148 if (mirror)
149 strbuf_addf(&buf2, "refs/%s:refs/%s",
150 item->string, item->string);
151 else
152 strbuf_addf(&buf2, "refs/heads/%s:refs/remotes/%s/%s",
153 item->string, name, item->string);
154 if (git_config_set_multivar(buf.buf, buf2.buf, "^$", 0))
155 return 1;
158 if (mirror) {
159 strbuf_reset(&buf);
160 strbuf_addf(&buf, "remote.%s.mirror", name);
161 if (git_config_set(buf.buf, "true"))
162 return 1;
165 if (fetch && fetch_remote(name))
166 return 1;
168 if (master) {
169 strbuf_reset(&buf);
170 strbuf_addf(&buf, "refs/remotes/%s/HEAD", name);
172 strbuf_reset(&buf2);
173 strbuf_addf(&buf2, "refs/remotes/%s/%s", name, master);
175 if (create_symref(buf.buf, buf2.buf, "remote add"))
176 return error("Could not setup master '%s'", master);
179 strbuf_release(&buf);
180 strbuf_release(&buf2);
181 string_list_clear(&track, 0);
183 return 0;
186 struct branch_info {
187 char *remote_name;
188 struct string_list merge;
189 int rebase;
192 static struct string_list branch_list;
194 static const char *abbrev_ref(const char *name, const char *prefix)
196 const char *abbrev = skip_prefix(name, prefix);
197 if (abbrev)
198 return abbrev;
199 return name;
201 #define abbrev_branch(name) abbrev_ref((name), "refs/heads/")
203 static int config_read_branches(const char *key, const char *value, void *cb)
205 if (!prefixcmp(key, "branch.")) {
206 const char *orig_key = key;
207 char *name;
208 struct string_list_item *item;
209 struct branch_info *info;
210 enum { REMOTE, MERGE, REBASE } type;
212 key += 7;
213 if (!postfixcmp(key, ".remote")) {
214 name = xstrndup(key, strlen(key) - 7);
215 type = REMOTE;
216 } else if (!postfixcmp(key, ".merge")) {
217 name = xstrndup(key, strlen(key) - 6);
218 type = MERGE;
219 } else if (!postfixcmp(key, ".rebase")) {
220 name = xstrndup(key, strlen(key) - 7);
221 type = REBASE;
222 } else
223 return 0;
225 item = string_list_insert(name, &branch_list);
227 if (!item->util)
228 item->util = xcalloc(sizeof(struct branch_info), 1);
229 info = item->util;
230 if (type == REMOTE) {
231 if (info->remote_name)
232 warning("more than one %s", orig_key);
233 info->remote_name = xstrdup(value);
234 } else if (type == MERGE) {
235 char *space = strchr(value, ' ');
236 value = abbrev_branch(value);
237 while (space) {
238 char *merge;
239 merge = xstrndup(value, space - value);
240 string_list_append(merge, &info->merge);
241 value = abbrev_branch(space + 1);
242 space = strchr(value, ' ');
244 string_list_append(xstrdup(value), &info->merge);
245 } else
246 info->rebase = git_config_bool(orig_key, value);
248 return 0;
251 static void read_branches(void)
253 if (branch_list.nr)
254 return;
255 git_config(config_read_branches, NULL);
258 struct ref_states {
259 struct remote *remote;
260 struct string_list new, stale, tracked, heads, push;
261 int queried;
264 static int get_ref_states(const struct ref *remote_refs, struct ref_states *states)
266 struct ref *fetch_map = NULL, **tail = &fetch_map;
267 struct ref *ref, *stale_refs;
268 int i;
270 for (i = 0; i < states->remote->fetch_refspec_nr; i++)
271 if (get_fetch_map(remote_refs, states->remote->fetch + i, &tail, 1))
272 die("Could not get fetch map for refspec %s",
273 states->remote->fetch_refspec[i]);
275 states->new.strdup_strings = 1;
276 states->tracked.strdup_strings = 1;
277 states->stale.strdup_strings = 1;
278 for (ref = fetch_map; ref; ref = ref->next) {
279 unsigned char sha1[20];
280 if (!ref->peer_ref || read_ref(ref->peer_ref->name, sha1))
281 string_list_append(abbrev_branch(ref->name), &states->new);
282 else
283 string_list_append(abbrev_branch(ref->name), &states->tracked);
285 stale_refs = get_stale_heads(states->remote, fetch_map);
286 for (ref = stale_refs; ref; ref = ref->next) {
287 struct string_list_item *item =
288 string_list_append(abbrev_branch(ref->name), &states->stale);
289 item->util = xstrdup(ref->name);
291 free_refs(stale_refs);
292 free_refs(fetch_map);
294 sort_string_list(&states->new);
295 sort_string_list(&states->tracked);
296 sort_string_list(&states->stale);
298 return 0;
301 struct push_info {
302 char *dest;
303 int forced;
304 enum {
305 PUSH_STATUS_CREATE = 0,
306 PUSH_STATUS_DELETE,
307 PUSH_STATUS_UPTODATE,
308 PUSH_STATUS_FASTFORWARD,
309 PUSH_STATUS_OUTOFDATE,
310 PUSH_STATUS_NOTQUERIED,
311 } status;
314 static int get_push_ref_states(const struct ref *remote_refs,
315 struct ref_states *states)
317 struct remote *remote = states->remote;
318 struct ref *ref, *local_refs, *push_map;
319 if (remote->mirror)
320 return 0;
322 local_refs = get_local_heads();
323 push_map = copy_ref_list(remote_refs);
325 match_refs(local_refs, &push_map, remote->push_refspec_nr,
326 remote->push_refspec, MATCH_REFS_NONE);
328 states->push.strdup_strings = 1;
329 for (ref = push_map; ref; ref = ref->next) {
330 struct string_list_item *item;
331 struct push_info *info;
333 if (!ref->peer_ref)
334 continue;
335 hashcpy(ref->new_sha1, ref->peer_ref->new_sha1);
337 item = string_list_append(abbrev_branch(ref->peer_ref->name),
338 &states->push);
339 item->util = xcalloc(sizeof(struct push_info), 1);
340 info = item->util;
341 info->forced = ref->force;
342 info->dest = xstrdup(abbrev_branch(ref->name));
344 if (is_null_sha1(ref->new_sha1)) {
345 info->status = PUSH_STATUS_DELETE;
346 } else if (!hashcmp(ref->old_sha1, ref->new_sha1))
347 info->status = PUSH_STATUS_UPTODATE;
348 else if (is_null_sha1(ref->old_sha1))
349 info->status = PUSH_STATUS_CREATE;
350 else if (has_sha1_file(ref->old_sha1) &&
351 ref_newer(ref->new_sha1, ref->old_sha1))
352 info->status = PUSH_STATUS_FASTFORWARD;
353 else
354 info->status = PUSH_STATUS_OUTOFDATE;
356 free_refs(local_refs);
357 free_refs(push_map);
358 return 0;
361 static int get_push_ref_states_noquery(struct ref_states *states)
363 int i;
364 struct remote *remote = states->remote;
365 struct string_list_item *item;
366 struct push_info *info;
368 if (remote->mirror)
369 return 0;
371 states->push.strdup_strings = 1;
372 if (!remote->push_refspec_nr) {
373 item = string_list_append("(matching)", &states->push);
374 info = item->util = xcalloc(sizeof(struct push_info), 1);
375 info->status = PUSH_STATUS_NOTQUERIED;
376 info->dest = xstrdup(item->string);
378 for (i = 0; i < remote->push_refspec_nr; i++) {
379 struct refspec *spec = remote->push + i;
380 if (spec->matching)
381 item = string_list_append("(matching)", &states->push);
382 else if (strlen(spec->src))
383 item = string_list_append(spec->src, &states->push);
384 else
385 item = string_list_append("(delete)", &states->push);
387 info = item->util = xcalloc(sizeof(struct push_info), 1);
388 info->forced = spec->force;
389 info->status = PUSH_STATUS_NOTQUERIED;
390 info->dest = xstrdup(spec->dst ? spec->dst : item->string);
392 return 0;
395 static int get_head_names(const struct ref *remote_refs, struct ref_states *states)
397 struct ref *ref, *matches;
398 struct ref *fetch_map = NULL, **fetch_map_tail = &fetch_map;
399 struct refspec refspec;
401 refspec.force = 0;
402 refspec.pattern = 1;
403 refspec.src = refspec.dst = "refs/heads/*";
404 states->heads.strdup_strings = 1;
405 get_fetch_map(remote_refs, &refspec, &fetch_map_tail, 0);
406 matches = guess_remote_head(find_ref_by_name(remote_refs, "HEAD"),
407 fetch_map, 1);
408 for (ref = matches; ref; ref = ref->next)
409 string_list_append(abbrev_branch(ref->name), &states->heads);
411 free_refs(fetch_map);
412 free_refs(matches);
414 return 0;
417 struct known_remote {
418 struct known_remote *next;
419 struct remote *remote;
422 struct known_remotes {
423 struct remote *to_delete;
424 struct known_remote *list;
427 static int add_known_remote(struct remote *remote, void *cb_data)
429 struct known_remotes *all = cb_data;
430 struct known_remote *r;
432 if (!strcmp(all->to_delete->name, remote->name))
433 return 0;
435 r = xmalloc(sizeof(*r));
436 r->remote = remote;
437 r->next = all->list;
438 all->list = r;
439 return 0;
442 struct branches_for_remote {
443 struct remote *remote;
444 struct string_list *branches, *skipped;
445 struct known_remotes *keep;
448 static int add_branch_for_removal(const char *refname,
449 const unsigned char *sha1, int flags, void *cb_data)
451 struct branches_for_remote *branches = cb_data;
452 struct refspec refspec;
453 struct string_list_item *item;
454 struct known_remote *kr;
456 memset(&refspec, 0, sizeof(refspec));
457 refspec.dst = (char *)refname;
458 if (remote_find_tracking(branches->remote, &refspec))
459 return 0;
461 /* don't delete a branch if another remote also uses it */
462 for (kr = branches->keep->list; kr; kr = kr->next) {
463 memset(&refspec, 0, sizeof(refspec));
464 refspec.dst = (char *)refname;
465 if (!remote_find_tracking(kr->remote, &refspec))
466 return 0;
469 /* don't delete non-remote refs */
470 if (prefixcmp(refname, "refs/remotes")) {
471 /* advise user how to delete local branches */
472 if (!prefixcmp(refname, "refs/heads/"))
473 string_list_append(abbrev_branch(refname),
474 branches->skipped);
475 /* silently skip over other non-remote refs */
476 return 0;
479 /* make sure that symrefs are deleted */
480 if (flags & REF_ISSYMREF)
481 return unlink(git_path("%s", refname));
483 item = string_list_append(refname, branches->branches);
484 item->util = xmalloc(20);
485 hashcpy(item->util, sha1);
487 return 0;
490 struct rename_info {
491 const char *old;
492 const char *new;
493 struct string_list *remote_branches;
496 static int read_remote_branches(const char *refname,
497 const unsigned char *sha1, int flags, void *cb_data)
499 struct rename_info *rename = cb_data;
500 struct strbuf buf = STRBUF_INIT;
501 struct string_list_item *item;
502 int flag;
503 unsigned char orig_sha1[20];
504 const char *symref;
506 strbuf_addf(&buf, "refs/remotes/%s", rename->old);
507 if (!prefixcmp(refname, buf.buf)) {
508 item = string_list_append(xstrdup(refname), rename->remote_branches);
509 symref = resolve_ref(refname, orig_sha1, 1, &flag);
510 if (flag & REF_ISSYMREF)
511 item->util = xstrdup(symref);
512 else
513 item->util = NULL;
516 return 0;
519 static int migrate_file(struct remote *remote)
521 struct strbuf buf = STRBUF_INIT;
522 int i;
523 char *path = NULL;
525 strbuf_addf(&buf, "remote.%s.url", remote->name);
526 for (i = 0; i < remote->url_nr; i++)
527 if (git_config_set_multivar(buf.buf, remote->url[i], "^$", 0))
528 return error("Could not append '%s' to '%s'",
529 remote->url[i], buf.buf);
530 strbuf_reset(&buf);
531 strbuf_addf(&buf, "remote.%s.push", remote->name);
532 for (i = 0; i < remote->push_refspec_nr; i++)
533 if (git_config_set_multivar(buf.buf, remote->push_refspec[i], "^$", 0))
534 return error("Could not append '%s' to '%s'",
535 remote->push_refspec[i], buf.buf);
536 strbuf_reset(&buf);
537 strbuf_addf(&buf, "remote.%s.fetch", remote->name);
538 for (i = 0; i < remote->fetch_refspec_nr; i++)
539 if (git_config_set_multivar(buf.buf, remote->fetch_refspec[i], "^$", 0))
540 return error("Could not append '%s' to '%s'",
541 remote->fetch_refspec[i], buf.buf);
542 if (remote->origin == REMOTE_REMOTES)
543 path = git_path("remotes/%s", remote->name);
544 else if (remote->origin == REMOTE_BRANCHES)
545 path = git_path("branches/%s", remote->name);
546 if (path)
547 unlink_or_warn(path);
548 return 0;
551 static int mv(int argc, const char **argv)
553 struct option options[] = {
554 OPT_END()
556 struct remote *oldremote, *newremote;
557 struct strbuf buf = STRBUF_INIT, buf2 = STRBUF_INIT, buf3 = STRBUF_INIT;
558 struct string_list remote_branches = { NULL, 0, 0, 0 };
559 struct rename_info rename;
560 int i;
562 if (argc != 3)
563 usage_with_options(builtin_remote_rename_usage, options);
565 rename.old = argv[1];
566 rename.new = argv[2];
567 rename.remote_branches = &remote_branches;
569 oldremote = remote_get(rename.old);
570 if (!oldremote)
571 die("No such remote: %s", rename.old);
573 if (!strcmp(rename.old, rename.new) && oldremote->origin != REMOTE_CONFIG)
574 return migrate_file(oldremote);
576 newremote = remote_get(rename.new);
577 if (newremote && (newremote->url_nr > 1 || newremote->fetch_refspec_nr))
578 die("remote %s already exists.", rename.new);
580 strbuf_addf(&buf, "refs/heads/test:refs/remotes/%s/test", rename.new);
581 if (!valid_fetch_refspec(buf.buf))
582 die("'%s' is not a valid remote name", rename.new);
584 strbuf_reset(&buf);
585 strbuf_addf(&buf, "remote.%s", rename.old);
586 strbuf_addf(&buf2, "remote.%s", rename.new);
587 if (git_config_rename_section(buf.buf, buf2.buf) < 1)
588 return error("Could not rename config section '%s' to '%s'",
589 buf.buf, buf2.buf);
591 strbuf_reset(&buf);
592 strbuf_addf(&buf, "remote.%s.fetch", rename.new);
593 if (git_config_set_multivar(buf.buf, NULL, NULL, 1))
594 return error("Could not remove config section '%s'", buf.buf);
595 for (i = 0; i < oldremote->fetch_refspec_nr; i++) {
596 char *ptr;
598 strbuf_reset(&buf2);
599 strbuf_addstr(&buf2, oldremote->fetch_refspec[i]);
600 ptr = strstr(buf2.buf, rename.old);
601 if (ptr)
602 strbuf_splice(&buf2, ptr-buf2.buf, strlen(rename.old),
603 rename.new, strlen(rename.new));
604 if (git_config_set_multivar(buf.buf, buf2.buf, "^$", 0))
605 return error("Could not append '%s'", buf.buf);
608 read_branches();
609 for (i = 0; i < branch_list.nr; i++) {
610 struct string_list_item *item = branch_list.items + i;
611 struct branch_info *info = item->util;
612 if (info->remote_name && !strcmp(info->remote_name, rename.old)) {
613 strbuf_reset(&buf);
614 strbuf_addf(&buf, "branch.%s.remote", item->string);
615 if (git_config_set(buf.buf, rename.new)) {
616 return error("Could not set '%s'", buf.buf);
622 * First remove symrefs, then rename the rest, finally create
623 * the new symrefs.
625 for_each_ref(read_remote_branches, &rename);
626 for (i = 0; i < remote_branches.nr; i++) {
627 struct string_list_item *item = remote_branches.items + i;
628 int flag = 0;
629 unsigned char sha1[20];
631 resolve_ref(item->string, sha1, 1, &flag);
632 if (!(flag & REF_ISSYMREF))
633 continue;
634 if (delete_ref(item->string, NULL, REF_NODEREF))
635 die("deleting '%s' failed", item->string);
637 for (i = 0; i < remote_branches.nr; i++) {
638 struct string_list_item *item = remote_branches.items + i;
640 if (item->util)
641 continue;
642 strbuf_reset(&buf);
643 strbuf_addstr(&buf, item->string);
644 strbuf_splice(&buf, strlen("refs/remotes/"), strlen(rename.old),
645 rename.new, strlen(rename.new));
646 strbuf_reset(&buf2);
647 strbuf_addf(&buf2, "remote: renamed %s to %s",
648 item->string, buf.buf);
649 if (rename_ref(item->string, buf.buf, buf2.buf))
650 die("renaming '%s' failed", item->string);
652 for (i = 0; i < remote_branches.nr; i++) {
653 struct string_list_item *item = remote_branches.items + i;
655 if (!item->util)
656 continue;
657 strbuf_reset(&buf);
658 strbuf_addstr(&buf, item->string);
659 strbuf_splice(&buf, strlen("refs/remotes/"), strlen(rename.old),
660 rename.new, strlen(rename.new));
661 strbuf_reset(&buf2);
662 strbuf_addstr(&buf2, item->util);
663 strbuf_splice(&buf2, strlen("refs/remotes/"), strlen(rename.old),
664 rename.new, strlen(rename.new));
665 strbuf_reset(&buf3);
666 strbuf_addf(&buf3, "remote: renamed %s to %s",
667 item->string, buf.buf);
668 if (create_symref(buf.buf, buf2.buf, buf3.buf))
669 die("creating '%s' failed", buf.buf);
671 return 0;
674 static int remove_branches(struct string_list *branches)
676 int i, result = 0;
677 for (i = 0; i < branches->nr; i++) {
678 struct string_list_item *item = branches->items + i;
679 const char *refname = item->string;
680 unsigned char *sha1 = item->util;
682 if (delete_ref(refname, sha1, 0))
683 result |= error("Could not remove branch %s", refname);
685 return result;
688 static int rm(int argc, const char **argv)
690 struct option options[] = {
691 OPT_END()
693 struct remote *remote;
694 struct strbuf buf = STRBUF_INIT;
695 struct known_remotes known_remotes = { NULL, NULL };
696 struct string_list branches = { NULL, 0, 0, 1 };
697 struct string_list skipped = { NULL, 0, 0, 1 };
698 struct branches_for_remote cb_data = {
699 NULL, &branches, &skipped, &known_remotes
701 int i, result;
703 if (argc != 2)
704 usage_with_options(builtin_remote_rm_usage, options);
706 remote = remote_get(argv[1]);
707 if (!remote)
708 die("No such remote: %s", argv[1]);
710 known_remotes.to_delete = remote;
711 for_each_remote(add_known_remote, &known_remotes);
713 strbuf_addf(&buf, "remote.%s", remote->name);
714 if (git_config_rename_section(buf.buf, NULL) < 1)
715 return error("Could not remove config section '%s'", buf.buf);
717 read_branches();
718 for (i = 0; i < branch_list.nr; i++) {
719 struct string_list_item *item = branch_list.items + i;
720 struct branch_info *info = item->util;
721 if (info->remote_name && !strcmp(info->remote_name, remote->name)) {
722 const char *keys[] = { "remote", "merge", NULL }, **k;
723 for (k = keys; *k; k++) {
724 strbuf_reset(&buf);
725 strbuf_addf(&buf, "branch.%s.%s",
726 item->string, *k);
727 if (git_config_set(buf.buf, NULL)) {
728 strbuf_release(&buf);
729 return -1;
736 * We cannot just pass a function to for_each_ref() which deletes
737 * the branches one by one, since for_each_ref() relies on cached
738 * refs, which are invalidated when deleting a branch.
740 cb_data.remote = remote;
741 result = for_each_ref(add_branch_for_removal, &cb_data);
742 strbuf_release(&buf);
744 if (!result)
745 result = remove_branches(&branches);
746 string_list_clear(&branches, 1);
748 if (skipped.nr) {
749 fprintf(stderr, skipped.nr == 1 ?
750 "Note: A non-remote branch was not removed; "
751 "to delete it, use:\n" :
752 "Note: Non-remote branches were not removed; "
753 "to delete them, use:\n");
754 for (i = 0; i < skipped.nr; i++)
755 fprintf(stderr, " git branch -d %s\n",
756 skipped.items[i].string);
758 string_list_clear(&skipped, 0);
760 return result;
763 static void clear_push_info(void *util, const char *string)
765 struct push_info *info = util;
766 free(info->dest);
767 free(info);
770 static void free_remote_ref_states(struct ref_states *states)
772 string_list_clear(&states->new, 0);
773 string_list_clear(&states->stale, 1);
774 string_list_clear(&states->tracked, 0);
775 string_list_clear(&states->heads, 0);
776 string_list_clear_func(&states->push, clear_push_info);
779 static int append_ref_to_tracked_list(const char *refname,
780 const unsigned char *sha1, int flags, void *cb_data)
782 struct ref_states *states = cb_data;
783 struct refspec refspec;
785 if (flags & REF_ISSYMREF)
786 return 0;
788 memset(&refspec, 0, sizeof(refspec));
789 refspec.dst = (char *)refname;
790 if (!remote_find_tracking(states->remote, &refspec))
791 string_list_append(abbrev_branch(refspec.src), &states->tracked);
793 return 0;
796 static int get_remote_ref_states(const char *name,
797 struct ref_states *states,
798 int query)
800 struct transport *transport;
801 const struct ref *remote_refs;
803 states->remote = remote_get(name);
804 if (!states->remote)
805 return error("No such remote: %s", name);
807 read_branches();
809 if (query) {
810 transport = transport_get(states->remote, states->remote->url_nr > 0 ?
811 states->remote->url[0] : NULL);
812 remote_refs = transport_get_remote_refs(transport);
813 transport_disconnect(transport);
815 states->queried = 1;
816 if (query & GET_REF_STATES)
817 get_ref_states(remote_refs, states);
818 if (query & GET_HEAD_NAMES)
819 get_head_names(remote_refs, states);
820 if (query & GET_PUSH_REF_STATES)
821 get_push_ref_states(remote_refs, states);
822 } else {
823 for_each_ref(append_ref_to_tracked_list, states);
824 sort_string_list(&states->tracked);
825 get_push_ref_states_noquery(states);
828 return 0;
831 struct show_info {
832 struct string_list *list;
833 struct ref_states *states;
834 int width, width2;
835 int any_rebase;
838 static int add_remote_to_show_info(struct string_list_item *item, void *cb_data)
840 struct show_info *info = cb_data;
841 int n = strlen(item->string);
842 if (n > info->width)
843 info->width = n;
844 string_list_insert(item->string, info->list);
845 return 0;
848 static int show_remote_info_item(struct string_list_item *item, void *cb_data)
850 struct show_info *info = cb_data;
851 struct ref_states *states = info->states;
852 const char *name = item->string;
854 if (states->queried) {
855 const char *fmt = "%s";
856 const char *arg = "";
857 if (string_list_has_string(&states->new, name)) {
858 fmt = " new (next fetch will store in remotes/%s)";
859 arg = states->remote->name;
860 } else if (string_list_has_string(&states->tracked, name))
861 arg = " tracked";
862 else if (string_list_has_string(&states->stale, name))
863 arg = " stale (use 'git remote prune' to remove)";
864 else
865 arg = " ???";
866 printf(" %-*s", info->width, name);
867 printf(fmt, arg);
868 printf("\n");
869 } else
870 printf(" %s\n", name);
872 return 0;
875 static int add_local_to_show_info(struct string_list_item *branch_item, void *cb_data)
877 struct show_info *show_info = cb_data;
878 struct ref_states *states = show_info->states;
879 struct branch_info *branch_info = branch_item->util;
880 struct string_list_item *item;
881 int n;
883 if (!branch_info->merge.nr || !branch_info->remote_name ||
884 strcmp(states->remote->name, branch_info->remote_name))
885 return 0;
886 if ((n = strlen(branch_item->string)) > show_info->width)
887 show_info->width = n;
888 if (branch_info->rebase)
889 show_info->any_rebase = 1;
891 item = string_list_insert(branch_item->string, show_info->list);
892 item->util = branch_info;
894 return 0;
897 static int show_local_info_item(struct string_list_item *item, void *cb_data)
899 struct show_info *show_info = cb_data;
900 struct branch_info *branch_info = item->util;
901 struct string_list *merge = &branch_info->merge;
902 const char *also;
903 int i;
905 if (branch_info->rebase && branch_info->merge.nr > 1) {
906 error("invalid branch.%s.merge; cannot rebase onto > 1 branch",
907 item->string);
908 return 0;
911 printf(" %-*s ", show_info->width, item->string);
912 if (branch_info->rebase) {
913 printf("rebases onto remote %s\n", merge->items[0].string);
914 return 0;
915 } else if (show_info->any_rebase) {
916 printf(" merges with remote %s\n", merge->items[0].string);
917 also = " and with remote";
918 } else {
919 printf("merges with remote %s\n", merge->items[0].string);
920 also = " and with remote";
922 for (i = 1; i < merge->nr; i++)
923 printf(" %-*s %s %s\n", show_info->width, "", also,
924 merge->items[i].string);
926 return 0;
929 static int add_push_to_show_info(struct string_list_item *push_item, void *cb_data)
931 struct show_info *show_info = cb_data;
932 struct push_info *push_info = push_item->util;
933 struct string_list_item *item;
934 int n;
935 if ((n = strlen(push_item->string)) > show_info->width)
936 show_info->width = n;
937 if ((n = strlen(push_info->dest)) > show_info->width2)
938 show_info->width2 = n;
939 item = string_list_append(push_item->string, show_info->list);
940 item->util = push_item->util;
941 return 0;
945 * Sorting comparison for a string list that has push_info
946 * structs in its util field
948 static int cmp_string_with_push(const void *va, const void *vb)
950 const struct string_list_item *a = va;
951 const struct string_list_item *b = vb;
952 const struct push_info *a_push = a->util;
953 const struct push_info *b_push = b->util;
954 int cmp = strcmp(a->string, b->string);
955 return cmp ? cmp : strcmp(a_push->dest, b_push->dest);
958 static int show_push_info_item(struct string_list_item *item, void *cb_data)
960 struct show_info *show_info = cb_data;
961 struct push_info *push_info = item->util;
962 char *src = item->string, *status = NULL;
964 switch (push_info->status) {
965 case PUSH_STATUS_CREATE:
966 status = "create";
967 break;
968 case PUSH_STATUS_DELETE:
969 status = "delete";
970 src = "(none)";
971 break;
972 case PUSH_STATUS_UPTODATE:
973 status = "up to date";
974 break;
975 case PUSH_STATUS_FASTFORWARD:
976 status = "fast-forwardable";
977 break;
978 case PUSH_STATUS_OUTOFDATE:
979 status = "local out of date";
980 break;
981 case PUSH_STATUS_NOTQUERIED:
982 break;
984 if (status)
985 printf(" %-*s %s to %-*s (%s)\n", show_info->width, src,
986 push_info->forced ? "forces" : "pushes",
987 show_info->width2, push_info->dest, status);
988 else
989 printf(" %-*s %s to %s\n", show_info->width, src,
990 push_info->forced ? "forces" : "pushes",
991 push_info->dest);
992 return 0;
995 static int show(int argc, const char **argv)
997 int no_query = 0, result = 0, query_flag = 0;
998 struct option options[] = {
999 OPT_BOOLEAN('n', NULL, &no_query, "do not query remotes"),
1000 OPT_END()
1002 struct ref_states states;
1003 struct string_list info_list = { NULL, 0, 0, 0 };
1004 struct show_info info;
1006 argc = parse_options(argc, argv, NULL, options, builtin_remote_show_usage,
1009 if (argc < 1)
1010 return show_all();
1012 if (!no_query)
1013 query_flag = (GET_REF_STATES | GET_HEAD_NAMES | GET_PUSH_REF_STATES);
1015 memset(&states, 0, sizeof(states));
1016 memset(&info, 0, sizeof(info));
1017 info.states = &states;
1018 info.list = &info_list;
1019 for (; argc; argc--, argv++) {
1020 int i;
1021 const char **url;
1022 int url_nr;
1024 get_remote_ref_states(*argv, &states, query_flag);
1026 printf("* remote %s\n", *argv);
1027 printf(" Fetch URL: %s\n", states.remote->url_nr > 0 ?
1028 states.remote->url[0] : "(no URL)");
1029 if (states.remote->pushurl_nr) {
1030 url = states.remote->pushurl;
1031 url_nr = states.remote->pushurl_nr;
1032 } else {
1033 url = states.remote->url;
1034 url_nr = states.remote->url_nr;
1036 for (i=0; i < url_nr; i++)
1037 printf(" Push URL: %s\n", url[i]);
1038 if (!i)
1039 printf(" Push URL: %s\n", "(no URL)");
1040 if (no_query)
1041 printf(" HEAD branch: (not queried)\n");
1042 else if (!states.heads.nr)
1043 printf(" HEAD branch: (unknown)\n");
1044 else if (states.heads.nr == 1)
1045 printf(" HEAD branch: %s\n", states.heads.items[0].string);
1046 else {
1047 printf(" HEAD branch (remote HEAD is ambiguous,"
1048 " may be one of the following):\n");
1049 for (i = 0; i < states.heads.nr; i++)
1050 printf(" %s\n", states.heads.items[i].string);
1053 /* remote branch info */
1054 info.width = 0;
1055 for_each_string_list(add_remote_to_show_info, &states.new, &info);
1056 for_each_string_list(add_remote_to_show_info, &states.tracked, &info);
1057 for_each_string_list(add_remote_to_show_info, &states.stale, &info);
1058 if (info.list->nr)
1059 printf(" Remote branch%s:%s\n",
1060 info.list->nr > 1 ? "es" : "",
1061 no_query ? " (status not queried)" : "");
1062 for_each_string_list(show_remote_info_item, info.list, &info);
1063 string_list_clear(info.list, 0);
1065 /* git pull info */
1066 info.width = 0;
1067 info.any_rebase = 0;
1068 for_each_string_list(add_local_to_show_info, &branch_list, &info);
1069 if (info.list->nr)
1070 printf(" Local branch%s configured for 'git pull':\n",
1071 info.list->nr > 1 ? "es" : "");
1072 for_each_string_list(show_local_info_item, info.list, &info);
1073 string_list_clear(info.list, 0);
1075 /* git push info */
1076 if (states.remote->mirror)
1077 printf(" Local refs will be mirrored by 'git push'\n");
1079 info.width = info.width2 = 0;
1080 for_each_string_list(add_push_to_show_info, &states.push, &info);
1081 qsort(info.list->items, info.list->nr,
1082 sizeof(*info.list->items), cmp_string_with_push);
1083 if (info.list->nr)
1084 printf(" Local ref%s configured for 'git push'%s:\n",
1085 info.list->nr > 1 ? "s" : "",
1086 no_query ? " (status not queried)" : "");
1087 for_each_string_list(show_push_info_item, info.list, &info);
1088 string_list_clear(info.list, 0);
1090 free_remote_ref_states(&states);
1093 return result;
1096 static int set_head(int argc, const char **argv)
1098 int i, opt_a = 0, opt_d = 0, result = 0;
1099 struct strbuf buf = STRBUF_INIT, buf2 = STRBUF_INIT;
1100 char *head_name = NULL;
1102 struct option options[] = {
1103 OPT_BOOLEAN('a', "auto", &opt_a,
1104 "set refs/remotes/<name>/HEAD according to remote"),
1105 OPT_BOOLEAN('d', "delete", &opt_d,
1106 "delete refs/remotes/<name>/HEAD"),
1107 OPT_END()
1109 argc = parse_options(argc, argv, NULL, options, builtin_remote_sethead_usage,
1111 if (argc)
1112 strbuf_addf(&buf, "refs/remotes/%s/HEAD", argv[0]);
1114 if (!opt_a && !opt_d && argc == 2) {
1115 head_name = xstrdup(argv[1]);
1116 } else if (opt_a && !opt_d && argc == 1) {
1117 struct ref_states states;
1118 memset(&states, 0, sizeof(states));
1119 get_remote_ref_states(argv[0], &states, GET_HEAD_NAMES);
1120 if (!states.heads.nr)
1121 result |= error("Cannot determine remote HEAD");
1122 else if (states.heads.nr > 1) {
1123 result |= error("Multiple remote HEAD branches. "
1124 "Please choose one explicitly with:");
1125 for (i = 0; i < states.heads.nr; i++)
1126 fprintf(stderr, " git remote set-head %s %s\n",
1127 argv[0], states.heads.items[i].string);
1128 } else
1129 head_name = xstrdup(states.heads.items[0].string);
1130 free_remote_ref_states(&states);
1131 } else if (opt_d && !opt_a && argc == 1) {
1132 if (delete_ref(buf.buf, NULL, REF_NODEREF))
1133 result |= error("Could not delete %s", buf.buf);
1134 } else
1135 usage_with_options(builtin_remote_sethead_usage, options);
1137 if (head_name) {
1138 unsigned char sha1[20];
1139 strbuf_addf(&buf2, "refs/remotes/%s/%s", argv[0], head_name);
1140 /* make sure it's valid */
1141 if (!resolve_ref(buf2.buf, sha1, 1, NULL))
1142 result |= error("Not a valid ref: %s", buf2.buf);
1143 else if (create_symref(buf.buf, buf2.buf, "remote set-head"))
1144 result |= error("Could not setup %s", buf.buf);
1145 if (opt_a)
1146 printf("%s/HEAD set to %s\n", argv[0], head_name);
1147 free(head_name);
1150 strbuf_release(&buf);
1151 strbuf_release(&buf2);
1152 return result;
1155 static int prune(int argc, const char **argv)
1157 int dry_run = 0, result = 0;
1158 struct option options[] = {
1159 OPT__DRY_RUN(&dry_run),
1160 OPT_END()
1163 argc = parse_options(argc, argv, NULL, options, builtin_remote_prune_usage,
1166 if (argc < 1)
1167 usage_with_options(builtin_remote_prune_usage, options);
1169 for (; argc; argc--, argv++)
1170 result |= prune_remote(*argv, dry_run);
1172 return result;
1175 static int prune_remote(const char *remote, int dry_run)
1177 int result = 0, i;
1178 struct ref_states states;
1179 const char *dangling_msg = dry_run
1180 ? " %s will become dangling!\n"
1181 : " %s has become dangling!\n";
1183 memset(&states, 0, sizeof(states));
1184 get_remote_ref_states(remote, &states, GET_REF_STATES);
1186 if (states.stale.nr) {
1187 printf("Pruning %s\n", remote);
1188 printf("URL: %s\n",
1189 states.remote->url_nr
1190 ? states.remote->url[0]
1191 : "(no URL)");
1194 for (i = 0; i < states.stale.nr; i++) {
1195 const char *refname = states.stale.items[i].util;
1197 if (!dry_run)
1198 result |= delete_ref(refname, NULL, 0);
1200 printf(" * [%s] %s\n", dry_run ? "would prune" : "pruned",
1201 abbrev_ref(refname, "refs/remotes/"));
1202 warn_dangling_symref(stdout, dangling_msg, refname);
1205 free_remote_ref_states(&states);
1206 return result;
1209 static int get_remote_default(const char *key, const char *value, void *priv)
1211 if (strcmp(key, "remotes.default") == 0) {
1212 int *found = priv;
1213 *found = 1;
1215 return 0;
1218 static int update(int argc, const char **argv)
1220 int i, prune = 0;
1221 struct option options[] = {
1222 OPT_BOOLEAN('p', "prune", &prune,
1223 "prune remotes after fetching"),
1224 OPT_END()
1226 const char **fetch_argv;
1227 int fetch_argc = 0;
1228 int default_defined = 0;
1230 fetch_argv = xmalloc(sizeof(char *) * (argc+5));
1232 argc = parse_options(argc, argv, NULL, options, builtin_remote_update_usage,
1233 PARSE_OPT_KEEP_ARGV0);
1235 fetch_argv[fetch_argc++] = "fetch";
1237 if (prune)
1238 fetch_argv[fetch_argc++] = "--prune";
1239 if (verbose)
1240 fetch_argv[fetch_argc++] = "-v";
1241 fetch_argv[fetch_argc++] = "--multiple";
1242 if (argc < 2)
1243 fetch_argv[fetch_argc++] = "default";
1244 for (i = 1; i < argc; i++)
1245 fetch_argv[fetch_argc++] = argv[i];
1247 if (strcmp(fetch_argv[fetch_argc-1], "default") == 0) {
1248 git_config(get_remote_default, &default_defined);
1249 if (!default_defined)
1250 fetch_argv[fetch_argc-1] = "--all";
1253 fetch_argv[fetch_argc] = NULL;
1255 return run_command_v_opt(fetch_argv, RUN_GIT_CMD);
1258 static int get_one_entry(struct remote *remote, void *priv)
1260 struct string_list *list = priv;
1261 struct strbuf url_buf = STRBUF_INIT;
1262 const char **url;
1263 int i, url_nr;
1265 if (remote->url_nr > 0) {
1266 strbuf_addf(&url_buf, "%s (fetch)", remote->url[0]);
1267 string_list_append(remote->name, list)->util =
1268 strbuf_detach(&url_buf, NULL);
1269 } else
1270 string_list_append(remote->name, list)->util = NULL;
1271 if (remote->pushurl_nr) {
1272 url = remote->pushurl;
1273 url_nr = remote->pushurl_nr;
1274 } else {
1275 url = remote->url;
1276 url_nr = remote->url_nr;
1278 for (i = 0; i < url_nr; i++)
1280 strbuf_addf(&url_buf, "%s (push)", url[i]);
1281 string_list_append(remote->name, list)->util =
1282 strbuf_detach(&url_buf, NULL);
1285 return 0;
1288 static int show_all(void)
1290 struct string_list list = { NULL, 0, 0 };
1291 int result;
1293 list.strdup_strings = 1;
1294 result = for_each_remote(get_one_entry, &list);
1296 if (!result) {
1297 int i;
1299 sort_string_list(&list);
1300 for (i = 0; i < list.nr; i++) {
1301 struct string_list_item *item = list.items + i;
1302 if (verbose)
1303 printf("%s\t%s\n", item->string,
1304 item->util ? (const char *)item->util : "");
1305 else {
1306 if (i && !strcmp((item - 1)->string, item->string))
1307 continue;
1308 printf("%s\n", item->string);
1312 string_list_clear(&list, 1);
1313 return result;
1316 int cmd_remote(int argc, const char **argv, const char *prefix)
1318 struct option options[] = {
1319 OPT_BOOLEAN('v', "verbose", &verbose, "be verbose; must be placed before a subcommand"),
1320 OPT_END()
1322 int result;
1324 argc = parse_options(argc, argv, prefix, options, builtin_remote_usage,
1325 PARSE_OPT_STOP_AT_NON_OPTION);
1327 if (argc < 1)
1328 result = show_all();
1329 else if (!strcmp(argv[0], "add"))
1330 result = add(argc, argv);
1331 else if (!strcmp(argv[0], "rename"))
1332 result = mv(argc, argv);
1333 else if (!strcmp(argv[0], "rm"))
1334 result = rm(argc, argv);
1335 else if (!strcmp(argv[0], "set-head"))
1336 result = set_head(argc, argv);
1337 else if (!strcmp(argv[0], "show"))
1338 result = show(argc, argv);
1339 else if (!strcmp(argv[0], "prune"))
1340 result = prune(argc, argv);
1341 else if (!strcmp(argv[0], "update"))
1342 result = update(argc, argv);
1343 else {
1344 error("Unknown subcommand: %s", argv[0]);
1345 usage_with_options(builtin_remote_usage, options);
1348 return result ? 1 : 0;