3 #include "parse-options.h"
6 #include "string-list.h"
8 #include "run-command.h"
11 #include "object-store.h"
12 #include "argv-array.h"
13 #include "commit-reach.h"
15 static const char * const builtin_remote_usage[] = {
16 N_("git remote [-v | --verbose]"),
17 N_("git remote add [-t <branch>] [-m <master>] [-f] [--tags | --no-tags] [--mirror=<fetch|push>] <name> <url>"),
18 N_("git remote rename <old> <new>"),
19 N_("git remote remove <name>"),
20 N_("git remote set-head <name> (-a | --auto | -d | --delete | <branch>)"),
21 N_("git remote [-v | --verbose] show [-n] <name>"),
22 N_("git remote prune [-n | --dry-run] <name>"),
23 N_("git remote [-v | --verbose] update [-p | --prune] [(<group> | <remote>)...]"),
24 N_("git remote set-branches [--add] <name> <branch>..."),
25 N_("git remote get-url [--push] [--all] <name>"),
26 N_("git remote set-url [--push] <name> <newurl> [<oldurl>]"),
27 N_("git remote set-url --add <name> <newurl>"),
28 N_("git remote set-url --delete <name> <url>"),
32 static const char * const builtin_remote_add_usage[] = {
33 N_("git remote add [<options>] <name> <url>"),
37 static const char * const builtin_remote_rename_usage[] = {
38 N_("git remote rename <old> <new>"),
42 static const char * const builtin_remote_rm_usage[] = {
43 N_("git remote remove <name>"),
47 static const char * const builtin_remote_sethead_usage[] = {
48 N_("git remote set-head <name> (-a | --auto | -d | --delete | <branch>)"),
52 static const char * const builtin_remote_setbranches_usage[] = {
53 N_("git remote set-branches <name> <branch>..."),
54 N_("git remote set-branches --add <name> <branch>..."),
58 static const char * const builtin_remote_show_usage[] = {
59 N_("git remote show [<options>] <name>"),
63 static const char * const builtin_remote_prune_usage[] = {
64 N_("git remote prune [<options>] <name>"),
68 static const char * const builtin_remote_update_usage[] = {
69 N_("git remote update [<options>] [<group> | <remote>]..."),
73 static const char * const builtin_remote_geturl_usage[] = {
74 N_("git remote get-url [--push] [--all] <name>"),
78 static const char * const builtin_remote_seturl_usage[] = {
79 N_("git remote set-url [--push] <name> <newurl> [<oldurl>]"),
80 N_("git remote set-url --add <name> <newurl>"),
81 N_("git remote set-url --delete <name> <url>"),
85 #define GET_REF_STATES (1<<0)
86 #define GET_HEAD_NAMES (1<<1)
87 #define GET_PUSH_REF_STATES (1<<2)
91 static int fetch_remote(const char *name)
93 const char *argv[] = { "fetch", name, NULL, NULL };
98 printf_ln(_("Updating %s"), name);
99 if (run_command_v_opt(argv, RUN_GIT_CMD))
100 return error(_("Could not fetch %s"), name);
110 #define MIRROR_NONE 0
111 #define MIRROR_FETCH 1
112 #define MIRROR_PUSH 2
113 #define MIRROR_BOTH (MIRROR_FETCH|MIRROR_PUSH)
115 static void add_branch(const char *key, const char *branchname,
116 const char *remotename, int mirror, struct strbuf *tmp)
119 strbuf_addch(tmp, '+');
121 strbuf_addf(tmp, "refs/%s:refs/%s",
122 branchname, branchname);
124 strbuf_addf(tmp, "refs/heads/%s:refs/remotes/%s/%s",
125 branchname, remotename, branchname);
126 git_config_set_multivar(key, tmp->buf, "^$", 0);
129 static const char mirror_advice[] =
130 N_("--mirror is dangerous and deprecated; please\n"
131 "\t use --mirror=fetch or --mirror=push instead");
133 static int parse_mirror_opt(const struct option *opt, const char *arg, int not)
135 unsigned *mirror = opt->value;
137 *mirror = MIRROR_NONE;
139 warning("%s", _(mirror_advice));
140 *mirror = MIRROR_BOTH;
142 else if (!strcmp(arg, "fetch"))
143 *mirror = MIRROR_FETCH;
144 else if (!strcmp(arg, "push"))
145 *mirror = MIRROR_PUSH;
147 return error(_("unknown mirror argument: %s"), arg);
151 static int add(int argc, const char **argv)
153 int fetch = 0, fetch_tags = TAGS_DEFAULT;
154 unsigned mirror = MIRROR_NONE;
155 struct string_list track = STRING_LIST_INIT_NODUP;
156 const char *master = NULL;
157 struct remote *remote;
158 struct strbuf buf = STRBUF_INIT, buf2 = STRBUF_INIT;
159 const char *name, *url;
162 struct option options[] = {
163 OPT_BOOL('f', "fetch", &fetch, N_("fetch the remote branches")),
164 OPT_SET_INT(0, "tags", &fetch_tags,
165 N_("import all tags and associated objects when fetching"),
167 OPT_SET_INT(0, NULL, &fetch_tags,
168 N_("or do not fetch any tag at all (--no-tags)"), TAGS_UNSET),
169 OPT_STRING_LIST('t', "track", &track, N_("branch"),
170 N_("branch(es) to track")),
171 OPT_STRING('m', "master", &master, N_("branch"), N_("master branch")),
172 { OPTION_CALLBACK, 0, "mirror", &mirror, "(push|fetch)",
173 N_("set up remote as a mirror to push to or fetch from"),
174 PARSE_OPT_OPTARG | PARSE_OPT_COMP_ARG, parse_mirror_opt },
178 argc = parse_options(argc, argv, NULL, options, builtin_remote_add_usage,
182 usage_with_options(builtin_remote_add_usage, options);
184 if (mirror && master)
185 die(_("specifying a master branch makes no sense with --mirror"));
186 if (mirror && !(mirror & MIRROR_FETCH) && track.nr)
187 die(_("specifying branches to track makes sense only with fetch mirrors"));
192 remote = remote_get(name);
193 if (remote_is_configured(remote, 1))
194 die(_("remote %s already exists."), name);
196 strbuf_addf(&buf2, "refs/heads/test:refs/remotes/%s/test", name);
197 if (!valid_fetch_refspec(buf2.buf))
198 die(_("'%s' is not a valid remote name"), name);
200 strbuf_addf(&buf, "remote.%s.url", name);
201 git_config_set(buf.buf, url);
203 if (!mirror || mirror & MIRROR_FETCH) {
205 strbuf_addf(&buf, "remote.%s.fetch", name);
207 string_list_append(&track, "*");
208 for (i = 0; i < track.nr; i++) {
209 add_branch(buf.buf, track.items[i].string,
210 name, mirror, &buf2);
214 if (mirror & MIRROR_PUSH) {
216 strbuf_addf(&buf, "remote.%s.mirror", name);
217 git_config_set(buf.buf, "true");
220 if (fetch_tags != TAGS_DEFAULT) {
222 strbuf_addf(&buf, "remote.%s.tagopt", name);
223 git_config_set(buf.buf,
224 fetch_tags == TAGS_SET ? "--tags" : "--no-tags");
227 if (fetch && fetch_remote(name))
232 strbuf_addf(&buf, "refs/remotes/%s/HEAD", name);
235 strbuf_addf(&buf2, "refs/remotes/%s/%s", name, master);
237 if (create_symref(buf.buf, buf2.buf, "remote add"))
238 return error(_("Could not setup master '%s'"), master);
241 strbuf_release(&buf);
242 strbuf_release(&buf2);
243 string_list_clear(&track, 0);
250 struct string_list merge;
252 NO_REBASE, NORMAL_REBASE, INTERACTIVE_REBASE, REBASE_MERGES
256 static struct string_list branch_list = STRING_LIST_INIT_NODUP;
258 static const char *abbrev_ref(const char *name, const char *prefix)
260 skip_prefix(name, prefix, &name);
263 #define abbrev_branch(name) abbrev_ref((name), "refs/heads/")
265 static int config_read_branches(const char *key, const char *value, void *cb)
267 if (starts_with(key, "branch.")) {
268 const char *orig_key = key;
270 struct string_list_item *item;
271 struct branch_info *info;
272 enum { REMOTE, MERGE, REBASE } type;
276 if (strip_suffix(key, ".remote", &key_len)) {
277 name = xmemdupz(key, key_len);
279 } else if (strip_suffix(key, ".merge", &key_len)) {
280 name = xmemdupz(key, key_len);
282 } else if (strip_suffix(key, ".rebase", &key_len)) {
283 name = xmemdupz(key, key_len);
288 item = string_list_insert(&branch_list, name);
291 item->util = xcalloc(1, sizeof(struct branch_info));
293 if (type == REMOTE) {
294 if (info->remote_name)
295 warning(_("more than one %s"), orig_key);
296 info->remote_name = xstrdup(value);
297 } else if (type == MERGE) {
298 char *space = strchr(value, ' ');
299 value = abbrev_branch(value);
302 merge = xstrndup(value, space - value);
303 string_list_append(&info->merge, merge);
304 value = abbrev_branch(space + 1);
305 space = strchr(value, ' ');
307 string_list_append(&info->merge, xstrdup(value));
309 int v = git_parse_maybe_bool(value);
312 else if (!strcmp(value, "preserve"))
313 info->rebase = NORMAL_REBASE;
314 else if (!strcmp(value, "merges"))
315 info->rebase = REBASE_MERGES;
316 else if (!strcmp(value, "interactive"))
317 info->rebase = INTERACTIVE_REBASE;
323 static void read_branches(void)
327 git_config(config_read_branches, NULL);
331 struct remote *remote;
332 struct string_list new_refs, stale, tracked, heads, push;
336 static int get_ref_states(const struct ref *remote_refs, struct ref_states *states)
338 struct ref *fetch_map = NULL, **tail = &fetch_map;
339 struct ref *ref, *stale_refs;
342 for (i = 0; i < states->remote->fetch.nr; i++)
343 if (get_fetch_map(remote_refs, &states->remote->fetch.items[i], &tail, 1))
344 die(_("Could not get fetch map for refspec %s"),
345 states->remote->fetch.raw[i]);
347 states->new_refs.strdup_strings = 1;
348 states->tracked.strdup_strings = 1;
349 states->stale.strdup_strings = 1;
350 for (ref = fetch_map; ref; ref = ref->next) {
351 if (!ref->peer_ref || !ref_exists(ref->peer_ref->name))
352 string_list_append(&states->new_refs, abbrev_branch(ref->name));
354 string_list_append(&states->tracked, abbrev_branch(ref->name));
356 stale_refs = get_stale_heads(&states->remote->fetch, fetch_map);
357 for (ref = stale_refs; ref; ref = ref->next) {
358 struct string_list_item *item =
359 string_list_append(&states->stale, abbrev_branch(ref->name));
360 item->util = xstrdup(ref->name);
362 free_refs(stale_refs);
363 free_refs(fetch_map);
365 string_list_sort(&states->new_refs);
366 string_list_sort(&states->tracked);
367 string_list_sort(&states->stale);
376 PUSH_STATUS_CREATE = 0,
378 PUSH_STATUS_UPTODATE,
379 PUSH_STATUS_FASTFORWARD,
380 PUSH_STATUS_OUTOFDATE,
381 PUSH_STATUS_NOTQUERIED
385 static int get_push_ref_states(const struct ref *remote_refs,
386 struct ref_states *states)
388 struct remote *remote = states->remote;
389 struct ref *ref, *local_refs, *push_map;
393 local_refs = get_local_heads();
394 push_map = copy_ref_list(remote_refs);
396 match_push_refs(local_refs, &push_map, &remote->push, MATCH_REFS_NONE);
398 states->push.strdup_strings = 1;
399 for (ref = push_map; ref; ref = ref->next) {
400 struct string_list_item *item;
401 struct push_info *info;
405 oidcpy(&ref->new_oid, &ref->peer_ref->new_oid);
407 item = string_list_append(&states->push,
408 abbrev_branch(ref->peer_ref->name));
409 item->util = xcalloc(1, sizeof(struct push_info));
411 info->forced = ref->force;
412 info->dest = xstrdup(abbrev_branch(ref->name));
414 if (is_null_oid(&ref->new_oid)) {
415 info->status = PUSH_STATUS_DELETE;
416 } else if (oideq(&ref->old_oid, &ref->new_oid))
417 info->status = PUSH_STATUS_UPTODATE;
418 else if (is_null_oid(&ref->old_oid))
419 info->status = PUSH_STATUS_CREATE;
420 else if (has_object_file(&ref->old_oid) &&
421 ref_newer(&ref->new_oid, &ref->old_oid))
422 info->status = PUSH_STATUS_FASTFORWARD;
424 info->status = PUSH_STATUS_OUTOFDATE;
426 free_refs(local_refs);
431 static int get_push_ref_states_noquery(struct ref_states *states)
434 struct remote *remote = states->remote;
435 struct string_list_item *item;
436 struct push_info *info;
441 states->push.strdup_strings = 1;
442 if (!remote->push.nr) {
443 item = string_list_append(&states->push, _("(matching)"));
444 info = item->util = xcalloc(1, sizeof(struct push_info));
445 info->status = PUSH_STATUS_NOTQUERIED;
446 info->dest = xstrdup(item->string);
448 for (i = 0; i < remote->push.nr; i++) {
449 const struct refspec_item *spec = &remote->push.items[i];
451 item = string_list_append(&states->push, _("(matching)"));
452 else if (strlen(spec->src))
453 item = string_list_append(&states->push, spec->src);
455 item = string_list_append(&states->push, _("(delete)"));
457 info = item->util = xcalloc(1, sizeof(struct push_info));
458 info->forced = spec->force;
459 info->status = PUSH_STATUS_NOTQUERIED;
460 info->dest = xstrdup(spec->dst ? spec->dst : item->string);
465 static int get_head_names(const struct ref *remote_refs, struct ref_states *states)
467 struct ref *ref, *matches;
468 struct ref *fetch_map = NULL, **fetch_map_tail = &fetch_map;
469 struct refspec_item refspec;
473 refspec.src = refspec.dst = "refs/heads/*";
474 states->heads.strdup_strings = 1;
475 get_fetch_map(remote_refs, &refspec, &fetch_map_tail, 0);
476 matches = guess_remote_head(find_ref_by_name(remote_refs, "HEAD"),
478 for (ref = matches; ref; ref = ref->next)
479 string_list_append(&states->heads, abbrev_branch(ref->name));
481 free_refs(fetch_map);
487 struct known_remote {
488 struct known_remote *next;
489 struct remote *remote;
492 struct known_remotes {
493 struct remote *to_delete;
494 struct known_remote *list;
497 static int add_known_remote(struct remote *remote, void *cb_data)
499 struct known_remotes *all = cb_data;
500 struct known_remote *r;
502 if (!strcmp(all->to_delete->name, remote->name))
505 r = xmalloc(sizeof(*r));
512 struct branches_for_remote {
513 struct remote *remote;
514 struct string_list *branches, *skipped;
515 struct known_remotes *keep;
518 static int add_branch_for_removal(const char *refname,
519 const struct object_id *oid, int flags, void *cb_data)
521 struct branches_for_remote *branches = cb_data;
522 struct refspec_item refspec;
523 struct known_remote *kr;
525 memset(&refspec, 0, sizeof(refspec));
526 refspec.dst = (char *)refname;
527 if (remote_find_tracking(branches->remote, &refspec))
530 /* don't delete a branch if another remote also uses it */
531 for (kr = branches->keep->list; kr; kr = kr->next) {
532 memset(&refspec, 0, sizeof(refspec));
533 refspec.dst = (char *)refname;
534 if (!remote_find_tracking(kr->remote, &refspec))
538 /* don't delete non-remote-tracking refs */
539 if (!starts_with(refname, "refs/remotes/")) {
540 /* advise user how to delete local branches */
541 if (starts_with(refname, "refs/heads/"))
542 string_list_append(branches->skipped,
543 abbrev_branch(refname));
544 /* silently skip over other non-remote refs */
548 string_list_append(branches->branches, refname);
554 const char *old_name;
555 const char *new_name;
556 struct string_list *remote_branches;
559 static int read_remote_branches(const char *refname,
560 const struct object_id *oid, int flags, void *cb_data)
562 struct rename_info *rename = cb_data;
563 struct strbuf buf = STRBUF_INIT;
564 struct string_list_item *item;
568 strbuf_addf(&buf, "refs/remotes/%s/", rename->old_name);
569 if (starts_with(refname, buf.buf)) {
570 item = string_list_append(rename->remote_branches, refname);
571 symref = resolve_ref_unsafe(refname, RESOLVE_REF_READING,
573 if (symref && (flag & REF_ISSYMREF))
574 item->util = xstrdup(symref);
578 strbuf_release(&buf);
583 static int migrate_file(struct remote *remote)
585 struct strbuf buf = STRBUF_INIT;
588 strbuf_addf(&buf, "remote.%s.url", remote->name);
589 for (i = 0; i < remote->url_nr; i++)
590 git_config_set_multivar(buf.buf, remote->url[i], "^$", 0);
592 strbuf_addf(&buf, "remote.%s.push", remote->name);
593 for (i = 0; i < remote->push.raw_nr; i++)
594 git_config_set_multivar(buf.buf, remote->push.raw[i], "^$", 0);
596 strbuf_addf(&buf, "remote.%s.fetch", remote->name);
597 for (i = 0; i < remote->fetch.raw_nr; i++)
598 git_config_set_multivar(buf.buf, remote->fetch.raw[i], "^$", 0);
599 if (remote->origin == REMOTE_REMOTES)
600 unlink_or_warn(git_path("remotes/%s", remote->name));
601 else if (remote->origin == REMOTE_BRANCHES)
602 unlink_or_warn(git_path("branches/%s", remote->name));
603 strbuf_release(&buf);
608 static int mv(int argc, const char **argv)
610 struct option options[] = {
613 struct remote *oldremote, *newremote;
614 struct strbuf buf = STRBUF_INIT, buf2 = STRBUF_INIT, buf3 = STRBUF_INIT,
615 old_remote_context = STRBUF_INIT;
616 struct string_list remote_branches = STRING_LIST_INIT_DUP;
617 struct rename_info rename;
618 int i, refspec_updated = 0;
621 usage_with_options(builtin_remote_rename_usage, options);
623 rename.old_name = argv[1];
624 rename.new_name = argv[2];
625 rename.remote_branches = &remote_branches;
627 oldremote = remote_get(rename.old_name);
628 if (!remote_is_configured(oldremote, 1))
629 die(_("No such remote: '%s'"), rename.old_name);
631 if (!strcmp(rename.old_name, rename.new_name) && oldremote->origin != REMOTE_CONFIG)
632 return migrate_file(oldremote);
634 newremote = remote_get(rename.new_name);
635 if (remote_is_configured(newremote, 1))
636 die(_("remote %s already exists."), rename.new_name);
638 strbuf_addf(&buf, "refs/heads/test:refs/remotes/%s/test", rename.new_name);
639 if (!valid_fetch_refspec(buf.buf))
640 die(_("'%s' is not a valid remote name"), rename.new_name);
643 strbuf_addf(&buf, "remote.%s", rename.old_name);
644 strbuf_addf(&buf2, "remote.%s", rename.new_name);
645 if (git_config_rename_section(buf.buf, buf2.buf) < 1)
646 return error(_("Could not rename config section '%s' to '%s'"),
650 strbuf_addf(&buf, "remote.%s.fetch", rename.new_name);
651 git_config_set_multivar(buf.buf, NULL, NULL, 1);
652 strbuf_addf(&old_remote_context, ":refs/remotes/%s/", rename.old_name);
653 for (i = 0; i < oldremote->fetch.raw_nr; i++) {
657 strbuf_addstr(&buf2, oldremote->fetch.raw[i]);
658 ptr = strstr(buf2.buf, old_remote_context.buf);
662 ptr-buf2.buf + strlen(":refs/remotes/"),
663 strlen(rename.old_name), rename.new_name,
664 strlen(rename.new_name));
666 warning(_("Not updating non-default fetch refspec\n"
668 "\tPlease update the configuration manually if necessary."),
671 git_config_set_multivar(buf.buf, buf2.buf, "^$", 0);
675 for (i = 0; i < branch_list.nr; i++) {
676 struct string_list_item *item = branch_list.items + i;
677 struct branch_info *info = item->util;
678 if (info->remote_name && !strcmp(info->remote_name, rename.old_name)) {
680 strbuf_addf(&buf, "branch.%s.remote", item->string);
681 git_config_set(buf.buf, rename.new_name);
685 if (!refspec_updated)
689 * First remove symrefs, then rename the rest, finally create
692 for_each_ref(read_remote_branches, &rename);
693 for (i = 0; i < remote_branches.nr; i++) {
694 struct string_list_item *item = remote_branches.items + i;
696 struct object_id oid;
698 read_ref_full(item->string, RESOLVE_REF_READING, &oid, &flag);
699 if (!(flag & REF_ISSYMREF))
701 if (delete_ref(NULL, item->string, NULL, REF_NO_DEREF))
702 die(_("deleting '%s' failed"), item->string);
704 for (i = 0; i < remote_branches.nr; i++) {
705 struct string_list_item *item = remote_branches.items + i;
710 strbuf_addstr(&buf, item->string);
711 strbuf_splice(&buf, strlen("refs/remotes/"), strlen(rename.old_name),
712 rename.new_name, strlen(rename.new_name));
714 strbuf_addf(&buf2, "remote: renamed %s to %s",
715 item->string, buf.buf);
716 if (rename_ref(item->string, buf.buf, buf2.buf))
717 die(_("renaming '%s' failed"), item->string);
719 for (i = 0; i < remote_branches.nr; i++) {
720 struct string_list_item *item = remote_branches.items + i;
725 strbuf_addstr(&buf, item->string);
726 strbuf_splice(&buf, strlen("refs/remotes/"), strlen(rename.old_name),
727 rename.new_name, strlen(rename.new_name));
729 strbuf_addstr(&buf2, item->util);
730 strbuf_splice(&buf2, strlen("refs/remotes/"), strlen(rename.old_name),
731 rename.new_name, strlen(rename.new_name));
733 strbuf_addf(&buf3, "remote: renamed %s to %s",
734 item->string, buf.buf);
735 if (create_symref(buf.buf, buf2.buf, buf3.buf))
736 die(_("creating '%s' failed"), buf.buf);
738 string_list_clear(&remote_branches, 1);
742 static int rm(int argc, const char **argv)
744 struct option options[] = {
747 struct remote *remote;
748 struct strbuf buf = STRBUF_INIT;
749 struct known_remotes known_remotes = { NULL, NULL };
750 struct string_list branches = STRING_LIST_INIT_DUP;
751 struct string_list skipped = STRING_LIST_INIT_DUP;
752 struct branches_for_remote cb_data;
755 memset(&cb_data, 0, sizeof(cb_data));
756 cb_data.branches = &branches;
757 cb_data.skipped = &skipped;
758 cb_data.keep = &known_remotes;
761 usage_with_options(builtin_remote_rm_usage, options);
763 remote = remote_get(argv[1]);
764 if (!remote_is_configured(remote, 1))
765 die(_("No such remote: '%s'"), argv[1]);
767 known_remotes.to_delete = remote;
768 for_each_remote(add_known_remote, &known_remotes);
771 for (i = 0; i < branch_list.nr; i++) {
772 struct string_list_item *item = branch_list.items + i;
773 struct branch_info *info = item->util;
774 if (info->remote_name && !strcmp(info->remote_name, remote->name)) {
775 const char *keys[] = { "remote", "merge", NULL }, **k;
776 for (k = keys; *k; k++) {
778 strbuf_addf(&buf, "branch.%s.%s",
780 result = git_config_set_gently(buf.buf, NULL);
781 if (result && result != CONFIG_NOTHING_SET)
782 die(_("could not unset '%s'"), buf.buf);
788 * We cannot just pass a function to for_each_ref() which deletes
789 * the branches one by one, since for_each_ref() relies on cached
790 * refs, which are invalidated when deleting a branch.
792 cb_data.remote = remote;
793 result = for_each_ref(add_branch_for_removal, &cb_data);
794 strbuf_release(&buf);
797 result = delete_refs("remote: remove", &branches, REF_NO_DEREF);
798 string_list_clear(&branches, 0);
802 Q_("Note: A branch outside the refs/remotes/ hierarchy was not removed;\n"
803 "to delete it, use:",
804 "Note: Some branches outside the refs/remotes/ hierarchy were not removed;\n"
805 "to delete them, use:",
807 for (i = 0; i < skipped.nr; i++)
808 fprintf(stderr, " git branch -d %s\n",
809 skipped.items[i].string);
811 string_list_clear(&skipped, 0);
814 strbuf_addf(&buf, "remote.%s", remote->name);
815 if (git_config_rename_section(buf.buf, NULL) < 1)
816 return error(_("Could not remove config section '%s'"), buf.buf);
822 static void clear_push_info(void *util, const char *string)
824 struct push_info *info = util;
829 static void free_remote_ref_states(struct ref_states *states)
831 string_list_clear(&states->new_refs, 0);
832 string_list_clear(&states->stale, 1);
833 string_list_clear(&states->tracked, 0);
834 string_list_clear(&states->heads, 0);
835 string_list_clear_func(&states->push, clear_push_info);
838 static int append_ref_to_tracked_list(const char *refname,
839 const struct object_id *oid, int flags, void *cb_data)
841 struct ref_states *states = cb_data;
842 struct refspec_item refspec;
844 if (flags & REF_ISSYMREF)
847 memset(&refspec, 0, sizeof(refspec));
848 refspec.dst = (char *)refname;
849 if (!remote_find_tracking(states->remote, &refspec))
850 string_list_append(&states->tracked, abbrev_branch(refspec.src));
855 static int get_remote_ref_states(const char *name,
856 struct ref_states *states,
859 struct transport *transport;
860 const struct ref *remote_refs;
862 states->remote = remote_get(name);
864 return error(_("No such remote: '%s'"), name);
869 transport = transport_get(states->remote, states->remote->url_nr > 0 ?
870 states->remote->url[0] : NULL);
871 remote_refs = transport_get_remote_refs(transport, NULL);
872 transport_disconnect(transport);
875 if (query & GET_REF_STATES)
876 get_ref_states(remote_refs, states);
877 if (query & GET_HEAD_NAMES)
878 get_head_names(remote_refs, states);
879 if (query & GET_PUSH_REF_STATES)
880 get_push_ref_states(remote_refs, states);
882 for_each_ref(append_ref_to_tracked_list, states);
883 string_list_sort(&states->tracked);
884 get_push_ref_states_noquery(states);
891 struct string_list *list;
892 struct ref_states *states;
897 static int add_remote_to_show_info(struct string_list_item *item, void *cb_data)
899 struct show_info *info = cb_data;
900 int n = strlen(item->string);
903 string_list_insert(info->list, item->string);
907 static int show_remote_info_item(struct string_list_item *item, void *cb_data)
909 struct show_info *info = cb_data;
910 struct ref_states *states = info->states;
911 const char *name = item->string;
913 if (states->queried) {
914 const char *fmt = "%s";
915 const char *arg = "";
916 if (string_list_has_string(&states->new_refs, name)) {
917 fmt = _(" new (next fetch will store in remotes/%s)");
918 arg = states->remote->name;
919 } else if (string_list_has_string(&states->tracked, name))
921 else if (string_list_has_string(&states->stale, name))
922 arg = _(" stale (use 'git remote prune' to remove)");
925 printf(" %-*s", info->width, name);
929 printf(" %s\n", name);
934 static int add_local_to_show_info(struct string_list_item *branch_item, void *cb_data)
936 struct show_info *show_info = cb_data;
937 struct ref_states *states = show_info->states;
938 struct branch_info *branch_info = branch_item->util;
939 struct string_list_item *item;
942 if (!branch_info->merge.nr || !branch_info->remote_name ||
943 strcmp(states->remote->name, branch_info->remote_name))
945 if ((n = strlen(branch_item->string)) > show_info->width)
946 show_info->width = n;
947 if (branch_info->rebase)
948 show_info->any_rebase = 1;
950 item = string_list_insert(show_info->list, branch_item->string);
951 item->util = branch_info;
956 static int show_local_info_item(struct string_list_item *item, void *cb_data)
958 struct show_info *show_info = cb_data;
959 struct branch_info *branch_info = item->util;
960 struct string_list *merge = &branch_info->merge;
961 int width = show_info->width + 4;
964 if (branch_info->rebase && branch_info->merge.nr > 1) {
965 error(_("invalid branch.%s.merge; cannot rebase onto > 1 branch"),
970 printf(" %-*s ", show_info->width, item->string);
971 if (branch_info->rebase) {
973 if (branch_info->rebase == INTERACTIVE_REBASE)
974 msg = _("rebases interactively onto remote %s");
975 else if (branch_info->rebase == REBASE_MERGES)
976 msg = _("rebases interactively (with merges) onto "
979 msg = _("rebases onto remote %s");
980 printf_ln(msg, merge->items[0].string);
982 } else if (show_info->any_rebase) {
983 printf_ln(_(" merges with remote %s"), merge->items[0].string);
986 printf_ln(_("merges with remote %s"), merge->items[0].string);
988 for (i = 1; i < merge->nr; i++)
989 printf(_("%-*s and with remote %s\n"), width, "",
990 merge->items[i].string);
995 static int add_push_to_show_info(struct string_list_item *push_item, void *cb_data)
997 struct show_info *show_info = cb_data;
998 struct push_info *push_info = push_item->util;
999 struct string_list_item *item;
1001 if ((n = strlen(push_item->string)) > show_info->width)
1002 show_info->width = n;
1003 if ((n = strlen(push_info->dest)) > show_info->width2)
1004 show_info->width2 = n;
1005 item = string_list_append(show_info->list, push_item->string);
1006 item->util = push_item->util;
1011 * Sorting comparison for a string list that has push_info
1012 * structs in its util field
1014 static int cmp_string_with_push(const void *va, const void *vb)
1016 const struct string_list_item *a = va;
1017 const struct string_list_item *b = vb;
1018 const struct push_info *a_push = a->util;
1019 const struct push_info *b_push = b->util;
1020 int cmp = strcmp(a->string, b->string);
1021 return cmp ? cmp : strcmp(a_push->dest, b_push->dest);
1024 static int show_push_info_item(struct string_list_item *item, void *cb_data)
1026 struct show_info *show_info = cb_data;
1027 struct push_info *push_info = item->util;
1028 const char *src = item->string, *status = NULL;
1030 switch (push_info->status) {
1031 case PUSH_STATUS_CREATE:
1032 status = _("create");
1034 case PUSH_STATUS_DELETE:
1035 status = _("delete");
1038 case PUSH_STATUS_UPTODATE:
1039 status = _("up to date");
1041 case PUSH_STATUS_FASTFORWARD:
1042 status = _("fast-forwardable");
1044 case PUSH_STATUS_OUTOFDATE:
1045 status = _("local out of date");
1047 case PUSH_STATUS_NOTQUERIED:
1051 if (push_info->forced)
1052 printf_ln(_(" %-*s forces to %-*s (%s)"), show_info->width, src,
1053 show_info->width2, push_info->dest, status);
1055 printf_ln(_(" %-*s pushes to %-*s (%s)"), show_info->width, src,
1056 show_info->width2, push_info->dest, status);
1058 if (push_info->forced)
1059 printf_ln(_(" %-*s forces to %s"), show_info->width, src,
1062 printf_ln(_(" %-*s pushes to %s"), show_info->width, src,
1068 static int get_one_entry(struct remote *remote, void *priv)
1070 struct string_list *list = priv;
1071 struct strbuf url_buf = STRBUF_INIT;
1075 if (remote->url_nr > 0) {
1076 strbuf_addf(&url_buf, "%s (fetch)", remote->url[0]);
1077 string_list_append(list, remote->name)->util =
1078 strbuf_detach(&url_buf, NULL);
1080 string_list_append(list, remote->name)->util = NULL;
1081 if (remote->pushurl_nr) {
1082 url = remote->pushurl;
1083 url_nr = remote->pushurl_nr;
1086 url_nr = remote->url_nr;
1088 for (i = 0; i < url_nr; i++)
1090 strbuf_addf(&url_buf, "%s (push)", url[i]);
1091 string_list_append(list, remote->name)->util =
1092 strbuf_detach(&url_buf, NULL);
1098 static int show_all(void)
1100 struct string_list list = STRING_LIST_INIT_NODUP;
1103 list.strdup_strings = 1;
1104 result = for_each_remote(get_one_entry, &list);
1109 string_list_sort(&list);
1110 for (i = 0; i < list.nr; i++) {
1111 struct string_list_item *item = list.items + i;
1113 printf("%s\t%s\n", item->string,
1114 item->util ? (const char *)item->util : "");
1116 if (i && !strcmp((item - 1)->string, item->string))
1118 printf("%s\n", item->string);
1122 string_list_clear(&list, 1);
1126 static int show(int argc, const char **argv)
1128 int no_query = 0, result = 0, query_flag = 0;
1129 struct option options[] = {
1130 OPT_BOOL('n', NULL, &no_query, N_("do not query remotes")),
1133 struct ref_states states;
1134 struct string_list info_list = STRING_LIST_INIT_NODUP;
1135 struct show_info info;
1137 argc = parse_options(argc, argv, NULL, options, builtin_remote_show_usage,
1144 query_flag = (GET_REF_STATES | GET_HEAD_NAMES | GET_PUSH_REF_STATES);
1146 memset(&states, 0, sizeof(states));
1147 memset(&info, 0, sizeof(info));
1148 info.states = &states;
1149 info.list = &info_list;
1150 for (; argc; argc--, argv++) {
1155 get_remote_ref_states(*argv, &states, query_flag);
1157 printf_ln(_("* remote %s"), *argv);
1158 printf_ln(_(" Fetch URL: %s"), states.remote->url_nr > 0 ?
1159 states.remote->url[0] : _("(no URL)"));
1160 if (states.remote->pushurl_nr) {
1161 url = states.remote->pushurl;
1162 url_nr = states.remote->pushurl_nr;
1164 url = states.remote->url;
1165 url_nr = states.remote->url_nr;
1167 for (i = 0; i < url_nr; i++)
1169 * TRANSLATORS: the colon ':' should align
1170 * with the one in " Fetch URL: %s"
1173 printf_ln(_(" Push URL: %s"), url[i]);
1175 printf_ln(_(" Push URL: %s"), _("(no URL)"));
1177 printf_ln(_(" HEAD branch: %s"), _("(not queried)"));
1178 else if (!states.heads.nr)
1179 printf_ln(_(" HEAD branch: %s"), _("(unknown)"));
1180 else if (states.heads.nr == 1)
1181 printf_ln(_(" HEAD branch: %s"), states.heads.items[0].string);
1183 printf(_(" HEAD branch (remote HEAD is ambiguous,"
1184 " may be one of the following):\n"));
1185 for (i = 0; i < states.heads.nr; i++)
1186 printf(" %s\n", states.heads.items[i].string);
1189 /* remote branch info */
1191 for_each_string_list(&states.new_refs, add_remote_to_show_info, &info);
1192 for_each_string_list(&states.tracked, add_remote_to_show_info, &info);
1193 for_each_string_list(&states.stale, add_remote_to_show_info, &info);
1195 printf_ln(Q_(" Remote branch:%s",
1196 " Remote branches:%s",
1198 no_query ? _(" (status not queried)") : "");
1199 for_each_string_list(info.list, show_remote_info_item, &info);
1200 string_list_clear(info.list, 0);
1204 info.any_rebase = 0;
1205 for_each_string_list(&branch_list, add_local_to_show_info, &info);
1207 printf_ln(Q_(" Local branch configured for 'git pull':",
1208 " Local branches configured for 'git pull':",
1210 for_each_string_list(info.list, show_local_info_item, &info);
1211 string_list_clear(info.list, 0);
1214 if (states.remote->mirror)
1215 printf_ln(_(" Local refs will be mirrored by 'git push'"));
1217 info.width = info.width2 = 0;
1218 for_each_string_list(&states.push, add_push_to_show_info, &info);
1219 QSORT(info.list->items, info.list->nr, cmp_string_with_push);
1221 printf_ln(Q_(" Local ref configured for 'git push'%s:",
1222 " Local refs configured for 'git push'%s:",
1224 no_query ? _(" (status not queried)") : "");
1225 for_each_string_list(info.list, show_push_info_item, &info);
1226 string_list_clear(info.list, 0);
1228 free_remote_ref_states(&states);
1234 static int set_head(int argc, const char **argv)
1236 int i, opt_a = 0, opt_d = 0, result = 0;
1237 struct strbuf buf = STRBUF_INIT, buf2 = STRBUF_INIT;
1238 char *head_name = NULL;
1240 struct option options[] = {
1241 OPT_BOOL('a', "auto", &opt_a,
1242 N_("set refs/remotes/<name>/HEAD according to remote")),
1243 OPT_BOOL('d', "delete", &opt_d,
1244 N_("delete refs/remotes/<name>/HEAD")),
1247 argc = parse_options(argc, argv, NULL, options, builtin_remote_sethead_usage,
1250 strbuf_addf(&buf, "refs/remotes/%s/HEAD", argv[0]);
1252 if (!opt_a && !opt_d && argc == 2) {
1253 head_name = xstrdup(argv[1]);
1254 } else if (opt_a && !opt_d && argc == 1) {
1255 struct ref_states states;
1256 memset(&states, 0, sizeof(states));
1257 get_remote_ref_states(argv[0], &states, GET_HEAD_NAMES);
1258 if (!states.heads.nr)
1259 result |= error(_("Cannot determine remote HEAD"));
1260 else if (states.heads.nr > 1) {
1261 result |= error(_("Multiple remote HEAD branches. "
1262 "Please choose one explicitly with:"));
1263 for (i = 0; i < states.heads.nr; i++)
1264 fprintf(stderr, " git remote set-head %s %s\n",
1265 argv[0], states.heads.items[i].string);
1267 head_name = xstrdup(states.heads.items[0].string);
1268 free_remote_ref_states(&states);
1269 } else if (opt_d && !opt_a && argc == 1) {
1270 if (delete_ref(NULL, buf.buf, NULL, REF_NO_DEREF))
1271 result |= error(_("Could not delete %s"), buf.buf);
1273 usage_with_options(builtin_remote_sethead_usage, options);
1276 strbuf_addf(&buf2, "refs/remotes/%s/%s", argv[0], head_name);
1277 /* make sure it's valid */
1278 if (!ref_exists(buf2.buf))
1279 result |= error(_("Not a valid ref: %s"), buf2.buf);
1280 else if (create_symref(buf.buf, buf2.buf, "remote set-head"))
1281 result |= error(_("Could not setup %s"), buf.buf);
1283 printf("%s/HEAD set to %s\n", argv[0], head_name);
1287 strbuf_release(&buf);
1288 strbuf_release(&buf2);
1292 static int prune_remote(const char *remote, int dry_run)
1295 struct ref_states states;
1296 struct string_list refs_to_prune = STRING_LIST_INIT_NODUP;
1297 struct string_list_item *item;
1298 const char *dangling_msg = dry_run
1299 ? _(" %s will become dangling!")
1300 : _(" %s has become dangling!");
1302 memset(&states, 0, sizeof(states));
1303 get_remote_ref_states(remote, &states, GET_REF_STATES);
1305 if (!states.stale.nr) {
1306 free_remote_ref_states(&states);
1310 printf_ln(_("Pruning %s"), remote);
1311 printf_ln(_("URL: %s"),
1312 states.remote->url_nr
1313 ? states.remote->url[0]
1316 for_each_string_list_item(item, &states.stale)
1317 string_list_append(&refs_to_prune, item->util);
1318 string_list_sort(&refs_to_prune);
1321 result |= delete_refs("remote: prune", &refs_to_prune, 0);
1323 for_each_string_list_item(item, &states.stale) {
1324 const char *refname = item->util;
1327 printf_ln(_(" * [would prune] %s"),
1328 abbrev_ref(refname, "refs/remotes/"));
1330 printf_ln(_(" * [pruned] %s"),
1331 abbrev_ref(refname, "refs/remotes/"));
1334 warn_dangling_symrefs(stdout, dangling_msg, &refs_to_prune);
1336 string_list_clear(&refs_to_prune, 0);
1337 free_remote_ref_states(&states);
1341 static int prune(int argc, const char **argv)
1343 int dry_run = 0, result = 0;
1344 struct option options[] = {
1345 OPT__DRY_RUN(&dry_run, N_("dry run")),
1349 argc = parse_options(argc, argv, NULL, options, builtin_remote_prune_usage,
1353 usage_with_options(builtin_remote_prune_usage, options);
1355 for (; argc; argc--, argv++)
1356 result |= prune_remote(*argv, dry_run);
1361 static int get_remote_default(const char *key, const char *value, void *priv)
1363 if (strcmp(key, "remotes.default") == 0) {
1370 static int update(int argc, const char **argv)
1373 struct option options[] = {
1374 OPT_BOOL('p', "prune", &prune,
1375 N_("prune remotes after fetching")),
1378 struct argv_array fetch_argv = ARGV_ARRAY_INIT;
1379 int default_defined = 0;
1382 argc = parse_options(argc, argv, NULL, options, builtin_remote_update_usage,
1383 PARSE_OPT_KEEP_ARGV0);
1385 argv_array_push(&fetch_argv, "fetch");
1388 argv_array_push(&fetch_argv, prune ? "--prune" : "--no-prune");
1390 argv_array_push(&fetch_argv, "-v");
1391 argv_array_push(&fetch_argv, "--multiple");
1393 argv_array_push(&fetch_argv, "default");
1394 for (i = 1; i < argc; i++)
1395 argv_array_push(&fetch_argv, argv[i]);
1397 if (strcmp(fetch_argv.argv[fetch_argv.argc-1], "default") == 0) {
1398 git_config(get_remote_default, &default_defined);
1399 if (!default_defined) {
1400 argv_array_pop(&fetch_argv);
1401 argv_array_push(&fetch_argv, "--all");
1405 retval = run_command_v_opt(fetch_argv.argv, RUN_GIT_CMD);
1406 argv_array_clear(&fetch_argv);
1410 static int remove_all_fetch_refspecs(const char *remote, const char *key)
1412 return git_config_set_multivar_gently(key, NULL, NULL, 1);
1415 static void add_branches(struct remote *remote, const char **branches,
1418 const char *remotename = remote->name;
1419 int mirror = remote->mirror;
1420 struct strbuf refspec = STRBUF_INIT;
1422 for (; *branches; branches++)
1423 add_branch(key, *branches, remotename, mirror, &refspec);
1425 strbuf_release(&refspec);
1428 static int set_remote_branches(const char *remotename, const char **branches,
1431 struct strbuf key = STRBUF_INIT;
1432 struct remote *remote;
1434 strbuf_addf(&key, "remote.%s.fetch", remotename);
1436 remote = remote_get(remotename);
1437 if (!remote_is_configured(remote, 1))
1438 die(_("No such remote '%s'"), remotename);
1440 if (!add_mode && remove_all_fetch_refspecs(remotename, key.buf)) {
1441 strbuf_release(&key);
1444 add_branches(remote, branches, key.buf);
1446 strbuf_release(&key);
1450 static int set_branches(int argc, const char **argv)
1453 struct option options[] = {
1454 OPT_BOOL('\0', "add", &add_mode, N_("add branch")),
1458 argc = parse_options(argc, argv, NULL, options,
1459 builtin_remote_setbranches_usage, 0);
1461 error(_("no remote specified"));
1462 usage_with_options(builtin_remote_setbranches_usage, options);
1466 return set_remote_branches(argv[0], argv + 1, add_mode);
1469 static int get_url(int argc, const char **argv)
1471 int i, push_mode = 0, all_mode = 0;
1472 const char *remotename = NULL;
1473 struct remote *remote;
1476 struct option options[] = {
1477 OPT_BOOL('\0', "push", &push_mode,
1478 N_("query push URLs rather than fetch URLs")),
1479 OPT_BOOL('\0', "all", &all_mode,
1480 N_("return all URLs")),
1483 argc = parse_options(argc, argv, NULL, options, builtin_remote_geturl_usage, 0);
1486 usage_with_options(builtin_remote_geturl_usage, options);
1488 remotename = argv[0];
1490 remote = remote_get(remotename);
1491 if (!remote_is_configured(remote, 1))
1492 die(_("No such remote '%s'"), remotename);
1496 url = remote->pushurl;
1497 url_nr = remote->pushurl_nr;
1499 /* else fetch mode */
1501 /* Use the fetch URL when no push URLs were found or requested. */
1504 url_nr = remote->url_nr;
1508 die(_("no URLs configured for remote '%s'"), remotename);
1511 for (i = 0; i < url_nr; i++)
1512 printf_ln("%s", url[i]);
1514 printf_ln("%s", *url);
1520 static int set_url(int argc, const char **argv)
1522 int i, push_mode = 0, add_mode = 0, delete_mode = 0;
1523 int matches = 0, negative_matches = 0;
1524 const char *remotename = NULL;
1525 const char *newurl = NULL;
1526 const char *oldurl = NULL;
1527 struct remote *remote;
1529 const char **urlset;
1531 struct strbuf name_buf = STRBUF_INIT;
1532 struct option options[] = {
1533 OPT_BOOL('\0', "push", &push_mode,
1534 N_("manipulate push URLs")),
1535 OPT_BOOL('\0', "add", &add_mode,
1537 OPT_BOOL('\0', "delete", &delete_mode,
1541 argc = parse_options(argc, argv, NULL, options, builtin_remote_seturl_usage,
1542 PARSE_OPT_KEEP_ARGV0);
1544 if (add_mode && delete_mode)
1545 die(_("--add --delete doesn't make sense"));
1547 if (argc < 3 || argc > 4 || ((add_mode || delete_mode) && argc != 3))
1548 usage_with_options(builtin_remote_seturl_usage, options);
1550 remotename = argv[1];
1558 remote = remote_get(remotename);
1559 if (!remote_is_configured(remote, 1))
1560 die(_("No such remote '%s'"), remotename);
1563 strbuf_addf(&name_buf, "remote.%s.pushurl", remotename);
1564 urlset = remote->pushurl;
1565 urlset_nr = remote->pushurl_nr;
1567 strbuf_addf(&name_buf, "remote.%s.url", remotename);
1568 urlset = remote->url;
1569 urlset_nr = remote->url_nr;
1572 /* Special cases that add new entry. */
1573 if ((!oldurl && !delete_mode) || add_mode) {
1575 git_config_set_multivar(name_buf.buf, newurl,
1578 git_config_set(name_buf.buf, newurl);
1582 /* Old URL specified. Demand that one matches. */
1583 if (regcomp(&old_regex, oldurl, REG_EXTENDED))
1584 die(_("Invalid old URL pattern: %s"), oldurl);
1586 for (i = 0; i < urlset_nr; i++)
1587 if (!regexec(&old_regex, urlset[i], 0, NULL, 0))
1591 if (!delete_mode && !matches)
1592 die(_("No such URL found: %s"), oldurl);
1593 if (delete_mode && !negative_matches && !push_mode)
1594 die(_("Will not delete all non-push URLs"));
1596 regfree(&old_regex);
1599 git_config_set_multivar(name_buf.buf, newurl, oldurl, 0);
1601 git_config_set_multivar(name_buf.buf, NULL, oldurl, 1);
1603 strbuf_release(&name_buf);
1607 int cmd_remote(int argc, const char **argv, const char *prefix)
1609 struct option options[] = {
1610 OPT__VERBOSE(&verbose, N_("be verbose; must be placed before a subcommand")),
1615 argc = parse_options(argc, argv, prefix, options, builtin_remote_usage,
1616 PARSE_OPT_STOP_AT_NON_OPTION);
1619 result = show_all();
1620 else if (!strcmp(argv[0], "add"))
1621 result = add(argc, argv);
1622 else if (!strcmp(argv[0], "rename"))
1623 result = mv(argc, argv);
1624 else if (!strcmp(argv[0], "rm") || !strcmp(argv[0], "remove"))
1625 result = rm(argc, argv);
1626 else if (!strcmp(argv[0], "set-head"))
1627 result = set_head(argc, argv);
1628 else if (!strcmp(argv[0], "set-branches"))
1629 result = set_branches(argc, argv);
1630 else if (!strcmp(argv[0], "get-url"))
1631 result = get_url(argc, argv);
1632 else if (!strcmp(argv[0], "set-url"))
1633 result = set_url(argc, argv);
1634 else if (!strcmp(argv[0], "show"))
1635 result = show(argc, argv);
1636 else if (!strcmp(argv[0], "prune"))
1637 result = prune(argc, argv);
1638 else if (!strcmp(argv[0], "update"))
1639 result = update(argc, argv);
1641 error(_("Unknown subcommand: %s"), argv[0]);
1642 usage_with_options(builtin_remote_usage, options);
1645 return result ? 1 : 0;