3 #include "parse-options.h"
6 #include "string-list.h"
8 #include "run-command.h"
10 #include "argv-array.h"
12 static const char * const builtin_remote_usage[] = {
13 N_("git remote [-v | --verbose]"),
14 N_("git remote add [-t <branch>] [-m <master>] [-f] [--tags | --no-tags] [--mirror=<fetch|push>] <name> <url>"),
15 N_("git remote rename <old> <new>"),
16 N_("git remote remove <name>"),
17 N_("git remote set-head <name> (-a | --auto | -d | --delete | <branch>)"),
18 N_("git remote [-v | --verbose] show [-n] <name>"),
19 N_("git remote prune [-n | --dry-run] <name>"),
20 N_("git remote [-v | --verbose] update [-p | --prune] [(<group> | <remote>)...]"),
21 N_("git remote set-branches [--add] <name> <branch>..."),
22 N_("git remote get-url [--push] [--all] <name>"),
23 N_("git remote set-url [--push] <name> <newurl> [<oldurl>]"),
24 N_("git remote set-url --add <name> <newurl>"),
25 N_("git remote set-url --delete <name> <url>"),
29 static const char * const builtin_remote_add_usage[] = {
30 N_("git remote add [<options>] <name> <url>"),
34 static const char * const builtin_remote_rename_usage[] = {
35 N_("git remote rename <old> <new>"),
39 static const char * const builtin_remote_rm_usage[] = {
40 N_("git remote remove <name>"),
44 static const char * const builtin_remote_sethead_usage[] = {
45 N_("git remote set-head <name> (-a | --auto | -d | --delete | <branch>)"),
49 static const char * const builtin_remote_setbranches_usage[] = {
50 N_("git remote set-branches <name> <branch>..."),
51 N_("git remote set-branches --add <name> <branch>..."),
55 static const char * const builtin_remote_show_usage[] = {
56 N_("git remote show [<options>] <name>"),
60 static const char * const builtin_remote_prune_usage[] = {
61 N_("git remote prune [<options>] <name>"),
65 static const char * const builtin_remote_update_usage[] = {
66 N_("git remote update [<options>] [<group> | <remote>]..."),
70 static const char * const builtin_remote_geturl_usage[] = {
71 N_("git remote get-url [--push] [--all] <name>"),
75 static const char * const builtin_remote_seturl_usage[] = {
76 N_("git remote set-url [--push] <name> <newurl> [<oldurl>]"),
77 N_("git remote set-url --add <name> <newurl>"),
78 N_("git remote set-url --delete <name> <url>"),
82 #define GET_REF_STATES (1<<0)
83 #define GET_HEAD_NAMES (1<<1)
84 #define GET_PUSH_REF_STATES (1<<2)
88 static int fetch_remote(const char *name)
90 const char *argv[] = { "fetch", name, NULL, NULL };
95 printf_ln(_("Updating %s"), name);
96 if (run_command_v_opt(argv, RUN_GIT_CMD))
97 return error(_("Could not fetch %s"), name);
107 #define MIRROR_NONE 0
108 #define MIRROR_FETCH 1
109 #define MIRROR_PUSH 2
110 #define MIRROR_BOTH (MIRROR_FETCH|MIRROR_PUSH)
112 static void add_branch(const char *key, const char *branchname,
113 const char *remotename, int mirror, struct strbuf *tmp)
116 strbuf_addch(tmp, '+');
118 strbuf_addf(tmp, "refs/%s:refs/%s",
119 branchname, branchname);
121 strbuf_addf(tmp, "refs/heads/%s:refs/remotes/%s/%s",
122 branchname, remotename, branchname);
123 git_config_set_multivar(key, tmp->buf, "^$", 0);
126 static const char mirror_advice[] =
127 N_("--mirror is dangerous and deprecated; please\n"
128 "\t use --mirror=fetch or --mirror=push instead");
130 static int parse_mirror_opt(const struct option *opt, const char *arg, int not)
132 unsigned *mirror = opt->value;
134 *mirror = MIRROR_NONE;
136 warning("%s", _(mirror_advice));
137 *mirror = MIRROR_BOTH;
139 else if (!strcmp(arg, "fetch"))
140 *mirror = MIRROR_FETCH;
141 else if (!strcmp(arg, "push"))
142 *mirror = MIRROR_PUSH;
144 return error(_("unknown mirror argument: %s"), arg);
148 static int add(int argc, const char **argv)
150 int fetch = 0, fetch_tags = TAGS_DEFAULT;
151 unsigned mirror = MIRROR_NONE;
152 struct string_list track = STRING_LIST_INIT_NODUP;
153 const char *master = NULL;
154 struct remote *remote;
155 struct strbuf buf = STRBUF_INIT, buf2 = STRBUF_INIT;
156 const char *name, *url;
159 struct option options[] = {
160 OPT_BOOL('f', "fetch", &fetch, N_("fetch the remote branches")),
161 OPT_SET_INT(0, "tags", &fetch_tags,
162 N_("import all tags and associated objects when fetching"),
164 OPT_SET_INT(0, NULL, &fetch_tags,
165 N_("or do not fetch any tag at all (--no-tags)"), TAGS_UNSET),
166 OPT_STRING_LIST('t', "track", &track, N_("branch"),
167 N_("branch(es) to track")),
168 OPT_STRING('m', "master", &master, N_("branch"), N_("master branch")),
169 { OPTION_CALLBACK, 0, "mirror", &mirror, N_("push|fetch"),
170 N_("set up remote as a mirror to push to or fetch from"),
171 PARSE_OPT_OPTARG, parse_mirror_opt },
175 argc = parse_options(argc, argv, NULL, options, builtin_remote_add_usage,
179 usage_with_options(builtin_remote_add_usage, options);
181 if (mirror && master)
182 die(_("specifying a master branch makes no sense with --mirror"));
183 if (mirror && !(mirror & MIRROR_FETCH) && track.nr)
184 die(_("specifying branches to track makes sense only with fetch mirrors"));
189 remote = remote_get(name);
190 if (remote_is_configured(remote, 1))
191 die(_("remote %s already exists."), name);
193 strbuf_addf(&buf2, "refs/heads/test:refs/remotes/%s/test", name);
194 if (!valid_fetch_refspec(buf2.buf))
195 die(_("'%s' is not a valid remote name"), name);
197 strbuf_addf(&buf, "remote.%s.url", name);
198 git_config_set(buf.buf, url);
200 if (!mirror || mirror & MIRROR_FETCH) {
202 strbuf_addf(&buf, "remote.%s.fetch", name);
204 string_list_append(&track, "*");
205 for (i = 0; i < track.nr; i++) {
206 add_branch(buf.buf, track.items[i].string,
207 name, mirror, &buf2);
211 if (mirror & MIRROR_PUSH) {
213 strbuf_addf(&buf, "remote.%s.mirror", name);
214 git_config_set(buf.buf, "true");
217 if (fetch_tags != TAGS_DEFAULT) {
219 strbuf_addf(&buf, "remote.%s.tagopt", name);
220 git_config_set(buf.buf,
221 fetch_tags == TAGS_SET ? "--tags" : "--no-tags");
224 if (fetch && fetch_remote(name))
229 strbuf_addf(&buf, "refs/remotes/%s/HEAD", name);
232 strbuf_addf(&buf2, "refs/remotes/%s/%s", name, master);
234 if (create_symref(buf.buf, buf2.buf, "remote add"))
235 return error(_("Could not setup master '%s'"), master);
238 strbuf_release(&buf);
239 strbuf_release(&buf2);
240 string_list_clear(&track, 0);
247 struct string_list merge;
248 enum { NO_REBASE, NORMAL_REBASE, INTERACTIVE_REBASE } rebase;
251 static struct string_list branch_list = STRING_LIST_INIT_NODUP;
253 static const char *abbrev_ref(const char *name, const char *prefix)
255 skip_prefix(name, prefix, &name);
258 #define abbrev_branch(name) abbrev_ref((name), "refs/heads/")
260 static int config_read_branches(const char *key, const char *value, void *cb)
262 if (starts_with(key, "branch.")) {
263 const char *orig_key = key;
265 struct string_list_item *item;
266 struct branch_info *info;
267 enum { REMOTE, MERGE, REBASE } type;
271 if (strip_suffix(key, ".remote", &key_len)) {
272 name = xmemdupz(key, key_len);
274 } else if (strip_suffix(key, ".merge", &key_len)) {
275 name = xmemdupz(key, key_len);
277 } else if (strip_suffix(key, ".rebase", &key_len)) {
278 name = xmemdupz(key, key_len);
283 item = string_list_insert(&branch_list, name);
286 item->util = xcalloc(1, sizeof(struct branch_info));
288 if (type == REMOTE) {
289 if (info->remote_name)
290 warning(_("more than one %s"), orig_key);
291 info->remote_name = xstrdup(value);
292 } else if (type == MERGE) {
293 char *space = strchr(value, ' ');
294 value = abbrev_branch(value);
297 merge = xstrndup(value, space - value);
298 string_list_append(&info->merge, merge);
299 value = abbrev_branch(space + 1);
300 space = strchr(value, ' ');
302 string_list_append(&info->merge, xstrdup(value));
304 int v = git_parse_maybe_bool(value);
307 else if (!strcmp(value, "preserve"))
308 info->rebase = NORMAL_REBASE;
309 else if (!strcmp(value, "interactive"))
310 info->rebase = INTERACTIVE_REBASE;
316 static void read_branches(void)
320 git_config(config_read_branches, NULL);
324 struct remote *remote;
325 struct string_list new, stale, tracked, heads, push;
329 static int get_ref_states(const struct ref *remote_refs, struct ref_states *states)
331 struct ref *fetch_map = NULL, **tail = &fetch_map;
332 struct ref *ref, *stale_refs;
335 for (i = 0; i < states->remote->fetch_refspec_nr; i++)
336 if (get_fetch_map(remote_refs, states->remote->fetch + i, &tail, 1))
337 die(_("Could not get fetch map for refspec %s"),
338 states->remote->fetch_refspec[i]);
340 states->new.strdup_strings = 1;
341 states->tracked.strdup_strings = 1;
342 states->stale.strdup_strings = 1;
343 for (ref = fetch_map; ref; ref = ref->next) {
344 if (!ref->peer_ref || !ref_exists(ref->peer_ref->name))
345 string_list_append(&states->new, abbrev_branch(ref->name));
347 string_list_append(&states->tracked, abbrev_branch(ref->name));
349 stale_refs = get_stale_heads(states->remote->fetch,
350 states->remote->fetch_refspec_nr, fetch_map);
351 for (ref = stale_refs; ref; ref = ref->next) {
352 struct string_list_item *item =
353 string_list_append(&states->stale, abbrev_branch(ref->name));
354 item->util = xstrdup(ref->name);
356 free_refs(stale_refs);
357 free_refs(fetch_map);
359 string_list_sort(&states->new);
360 string_list_sort(&states->tracked);
361 string_list_sort(&states->stale);
370 PUSH_STATUS_CREATE = 0,
372 PUSH_STATUS_UPTODATE,
373 PUSH_STATUS_FASTFORWARD,
374 PUSH_STATUS_OUTOFDATE,
375 PUSH_STATUS_NOTQUERIED
379 static int get_push_ref_states(const struct ref *remote_refs,
380 struct ref_states *states)
382 struct remote *remote = states->remote;
383 struct ref *ref, *local_refs, *push_map;
387 local_refs = get_local_heads();
388 push_map = copy_ref_list(remote_refs);
390 match_push_refs(local_refs, &push_map, remote->push_refspec_nr,
391 remote->push_refspec, MATCH_REFS_NONE);
393 states->push.strdup_strings = 1;
394 for (ref = push_map; ref; ref = ref->next) {
395 struct string_list_item *item;
396 struct push_info *info;
400 oidcpy(&ref->new_oid, &ref->peer_ref->new_oid);
402 item = string_list_append(&states->push,
403 abbrev_branch(ref->peer_ref->name));
404 item->util = xcalloc(1, sizeof(struct push_info));
406 info->forced = ref->force;
407 info->dest = xstrdup(abbrev_branch(ref->name));
409 if (is_null_oid(&ref->new_oid)) {
410 info->status = PUSH_STATUS_DELETE;
411 } else if (!oidcmp(&ref->old_oid, &ref->new_oid))
412 info->status = PUSH_STATUS_UPTODATE;
413 else if (is_null_oid(&ref->old_oid))
414 info->status = PUSH_STATUS_CREATE;
415 else if (has_object_file(&ref->old_oid) &&
416 ref_newer(&ref->new_oid, &ref->old_oid))
417 info->status = PUSH_STATUS_FASTFORWARD;
419 info->status = PUSH_STATUS_OUTOFDATE;
421 free_refs(local_refs);
426 static int get_push_ref_states_noquery(struct ref_states *states)
429 struct remote *remote = states->remote;
430 struct string_list_item *item;
431 struct push_info *info;
436 states->push.strdup_strings = 1;
437 if (!remote->push_refspec_nr) {
438 item = string_list_append(&states->push, _("(matching)"));
439 info = item->util = xcalloc(1, sizeof(struct push_info));
440 info->status = PUSH_STATUS_NOTQUERIED;
441 info->dest = xstrdup(item->string);
443 for (i = 0; i < remote->push_refspec_nr; i++) {
444 struct refspec *spec = remote->push + i;
446 item = string_list_append(&states->push, _("(matching)"));
447 else if (strlen(spec->src))
448 item = string_list_append(&states->push, spec->src);
450 item = string_list_append(&states->push, _("(delete)"));
452 info = item->util = xcalloc(1, sizeof(struct push_info));
453 info->forced = spec->force;
454 info->status = PUSH_STATUS_NOTQUERIED;
455 info->dest = xstrdup(spec->dst ? spec->dst : item->string);
460 static int get_head_names(const struct ref *remote_refs, struct ref_states *states)
462 struct ref *ref, *matches;
463 struct ref *fetch_map = NULL, **fetch_map_tail = &fetch_map;
464 struct refspec refspec;
468 refspec.src = refspec.dst = "refs/heads/*";
469 states->heads.strdup_strings = 1;
470 get_fetch_map(remote_refs, &refspec, &fetch_map_tail, 0);
471 matches = guess_remote_head(find_ref_by_name(remote_refs, "HEAD"),
473 for (ref = matches; ref; ref = ref->next)
474 string_list_append(&states->heads, abbrev_branch(ref->name));
476 free_refs(fetch_map);
482 struct known_remote {
483 struct known_remote *next;
484 struct remote *remote;
487 struct known_remotes {
488 struct remote *to_delete;
489 struct known_remote *list;
492 static int add_known_remote(struct remote *remote, void *cb_data)
494 struct known_remotes *all = cb_data;
495 struct known_remote *r;
497 if (!strcmp(all->to_delete->name, remote->name))
500 r = xmalloc(sizeof(*r));
507 struct branches_for_remote {
508 struct remote *remote;
509 struct string_list *branches, *skipped;
510 struct known_remotes *keep;
513 static int add_branch_for_removal(const char *refname,
514 const struct object_id *oid, int flags, void *cb_data)
516 struct branches_for_remote *branches = cb_data;
517 struct refspec refspec;
518 struct known_remote *kr;
520 memset(&refspec, 0, sizeof(refspec));
521 refspec.dst = (char *)refname;
522 if (remote_find_tracking(branches->remote, &refspec))
525 /* don't delete a branch if another remote also uses it */
526 for (kr = branches->keep->list; kr; kr = kr->next) {
527 memset(&refspec, 0, sizeof(refspec));
528 refspec.dst = (char *)refname;
529 if (!remote_find_tracking(kr->remote, &refspec))
533 /* don't delete non-remote-tracking refs */
534 if (!starts_with(refname, "refs/remotes/")) {
535 /* advise user how to delete local branches */
536 if (starts_with(refname, "refs/heads/"))
537 string_list_append(branches->skipped,
538 abbrev_branch(refname));
539 /* silently skip over other non-remote refs */
543 string_list_append(branches->branches, refname);
551 struct string_list *remote_branches;
554 static int read_remote_branches(const char *refname,
555 const struct object_id *oid, int flags, void *cb_data)
557 struct rename_info *rename = cb_data;
558 struct strbuf buf = STRBUF_INIT;
559 struct string_list_item *item;
563 strbuf_addf(&buf, "refs/remotes/%s/", rename->old);
564 if (starts_with(refname, buf.buf)) {
565 item = string_list_append(rename->remote_branches, xstrdup(refname));
566 symref = resolve_ref_unsafe(refname, RESOLVE_REF_READING,
568 if (symref && (flag & REF_ISSYMREF))
569 item->util = xstrdup(symref);
573 strbuf_release(&buf);
578 static int migrate_file(struct remote *remote)
580 struct strbuf buf = STRBUF_INIT;
583 strbuf_addf(&buf, "remote.%s.url", remote->name);
584 for (i = 0; i < remote->url_nr; i++)
585 git_config_set_multivar(buf.buf, remote->url[i], "^$", 0);
587 strbuf_addf(&buf, "remote.%s.push", remote->name);
588 for (i = 0; i < remote->push_refspec_nr; i++)
589 git_config_set_multivar(buf.buf, remote->push_refspec[i], "^$", 0);
591 strbuf_addf(&buf, "remote.%s.fetch", remote->name);
592 for (i = 0; i < remote->fetch_refspec_nr; i++)
593 git_config_set_multivar(buf.buf, remote->fetch_refspec[i], "^$", 0);
594 if (remote->origin == REMOTE_REMOTES)
595 unlink_or_warn(git_path("remotes/%s", remote->name));
596 else if (remote->origin == REMOTE_BRANCHES)
597 unlink_or_warn(git_path("branches/%s", remote->name));
598 strbuf_release(&buf);
603 static int mv(int argc, const char **argv)
605 struct option options[] = {
608 struct remote *oldremote, *newremote;
609 struct strbuf buf = STRBUF_INIT, buf2 = STRBUF_INIT, buf3 = STRBUF_INIT,
610 old_remote_context = STRBUF_INIT;
611 struct string_list remote_branches = STRING_LIST_INIT_NODUP;
612 struct rename_info rename;
613 int i, refspec_updated = 0;
616 usage_with_options(builtin_remote_rename_usage, options);
618 rename.old = argv[1];
619 rename.new = argv[2];
620 rename.remote_branches = &remote_branches;
622 oldremote = remote_get(rename.old);
623 if (!remote_is_configured(oldremote, 1))
624 die(_("No such remote: %s"), rename.old);
626 if (!strcmp(rename.old, rename.new) && oldremote->origin != REMOTE_CONFIG)
627 return migrate_file(oldremote);
629 newremote = remote_get(rename.new);
630 if (remote_is_configured(newremote, 1))
631 die(_("remote %s already exists."), rename.new);
633 strbuf_addf(&buf, "refs/heads/test:refs/remotes/%s/test", rename.new);
634 if (!valid_fetch_refspec(buf.buf))
635 die(_("'%s' is not a valid remote name"), rename.new);
638 strbuf_addf(&buf, "remote.%s", rename.old);
639 strbuf_addf(&buf2, "remote.%s", rename.new);
640 if (git_config_rename_section(buf.buf, buf2.buf) < 1)
641 return error(_("Could not rename config section '%s' to '%s'"),
645 strbuf_addf(&buf, "remote.%s.fetch", rename.new);
646 git_config_set_multivar(buf.buf, NULL, NULL, 1);
647 strbuf_addf(&old_remote_context, ":refs/remotes/%s/", rename.old);
648 for (i = 0; i < oldremote->fetch_refspec_nr; i++) {
652 strbuf_addstr(&buf2, oldremote->fetch_refspec[i]);
653 ptr = strstr(buf2.buf, old_remote_context.buf);
657 ptr-buf2.buf + strlen(":refs/remotes/"),
658 strlen(rename.old), rename.new,
661 warning(_("Not updating non-default fetch refspec\n"
663 "\tPlease update the configuration manually if necessary."),
666 git_config_set_multivar(buf.buf, buf2.buf, "^$", 0);
670 for (i = 0; i < branch_list.nr; i++) {
671 struct string_list_item *item = branch_list.items + i;
672 struct branch_info *info = item->util;
673 if (info->remote_name && !strcmp(info->remote_name, rename.old)) {
675 strbuf_addf(&buf, "branch.%s.remote", item->string);
676 git_config_set(buf.buf, rename.new);
680 if (!refspec_updated)
684 * First remove symrefs, then rename the rest, finally create
687 for_each_ref(read_remote_branches, &rename);
688 for (i = 0; i < remote_branches.nr; i++) {
689 struct string_list_item *item = remote_branches.items + i;
691 struct object_id oid;
693 read_ref_full(item->string, RESOLVE_REF_READING, oid.hash, &flag);
694 if (!(flag & REF_ISSYMREF))
696 if (delete_ref(NULL, item->string, NULL, REF_NODEREF))
697 die(_("deleting '%s' failed"), item->string);
699 for (i = 0; i < remote_branches.nr; i++) {
700 struct string_list_item *item = remote_branches.items + i;
705 strbuf_addstr(&buf, item->string);
706 strbuf_splice(&buf, strlen("refs/remotes/"), strlen(rename.old),
707 rename.new, strlen(rename.new));
709 strbuf_addf(&buf2, "remote: renamed %s to %s",
710 item->string, buf.buf);
711 if (rename_ref(item->string, buf.buf, buf2.buf))
712 die(_("renaming '%s' failed"), item->string);
714 for (i = 0; i < remote_branches.nr; i++) {
715 struct string_list_item *item = remote_branches.items + i;
720 strbuf_addstr(&buf, item->string);
721 strbuf_splice(&buf, strlen("refs/remotes/"), strlen(rename.old),
722 rename.new, strlen(rename.new));
724 strbuf_addstr(&buf2, item->util);
725 strbuf_splice(&buf2, strlen("refs/remotes/"), strlen(rename.old),
726 rename.new, strlen(rename.new));
728 strbuf_addf(&buf3, "remote: renamed %s to %s",
729 item->string, buf.buf);
730 if (create_symref(buf.buf, buf2.buf, buf3.buf))
731 die(_("creating '%s' failed"), buf.buf);
736 static int rm(int argc, const char **argv)
738 struct option options[] = {
741 struct remote *remote;
742 struct strbuf buf = STRBUF_INIT;
743 struct known_remotes known_remotes = { NULL, NULL };
744 struct string_list branches = STRING_LIST_INIT_DUP;
745 struct string_list skipped = STRING_LIST_INIT_DUP;
746 struct branches_for_remote cb_data;
749 memset(&cb_data, 0, sizeof(cb_data));
750 cb_data.branches = &branches;
751 cb_data.skipped = &skipped;
752 cb_data.keep = &known_remotes;
755 usage_with_options(builtin_remote_rm_usage, options);
757 remote = remote_get(argv[1]);
758 if (!remote_is_configured(remote, 1))
759 die(_("No such remote: %s"), argv[1]);
761 known_remotes.to_delete = remote;
762 for_each_remote(add_known_remote, &known_remotes);
765 for (i = 0; i < branch_list.nr; i++) {
766 struct string_list_item *item = branch_list.items + i;
767 struct branch_info *info = item->util;
768 if (info->remote_name && !strcmp(info->remote_name, remote->name)) {
769 const char *keys[] = { "remote", "merge", NULL }, **k;
770 for (k = keys; *k; k++) {
772 strbuf_addf(&buf, "branch.%s.%s",
774 result = git_config_set_gently(buf.buf, NULL);
775 if (result && result != CONFIG_NOTHING_SET)
776 die(_("could not unset '%s'"), buf.buf);
782 * We cannot just pass a function to for_each_ref() which deletes
783 * the branches one by one, since for_each_ref() relies on cached
784 * refs, which are invalidated when deleting a branch.
786 cb_data.remote = remote;
787 result = for_each_ref(add_branch_for_removal, &cb_data);
788 strbuf_release(&buf);
791 result = delete_refs("remote: remove", &branches, REF_NODEREF);
792 string_list_clear(&branches, 0);
796 Q_("Note: A branch outside the refs/remotes/ hierarchy was not removed;\n"
797 "to delete it, use:",
798 "Note: Some branches outside the refs/remotes/ hierarchy were not removed;\n"
799 "to delete them, use:",
801 for (i = 0; i < skipped.nr; i++)
802 fprintf(stderr, " git branch -d %s\n",
803 skipped.items[i].string);
805 string_list_clear(&skipped, 0);
808 strbuf_addf(&buf, "remote.%s", remote->name);
809 if (git_config_rename_section(buf.buf, NULL) < 1)
810 return error(_("Could not remove config section '%s'"), buf.buf);
816 static void clear_push_info(void *util, const char *string)
818 struct push_info *info = util;
823 static void free_remote_ref_states(struct ref_states *states)
825 string_list_clear(&states->new, 0);
826 string_list_clear(&states->stale, 1);
827 string_list_clear(&states->tracked, 0);
828 string_list_clear(&states->heads, 0);
829 string_list_clear_func(&states->push, clear_push_info);
832 static int append_ref_to_tracked_list(const char *refname,
833 const struct object_id *oid, int flags, void *cb_data)
835 struct ref_states *states = cb_data;
836 struct refspec refspec;
838 if (flags & REF_ISSYMREF)
841 memset(&refspec, 0, sizeof(refspec));
842 refspec.dst = (char *)refname;
843 if (!remote_find_tracking(states->remote, &refspec))
844 string_list_append(&states->tracked, abbrev_branch(refspec.src));
849 static int get_remote_ref_states(const char *name,
850 struct ref_states *states,
853 struct transport *transport;
854 const struct ref *remote_refs;
856 states->remote = remote_get(name);
858 return error(_("No such remote: %s"), name);
863 transport = transport_get(states->remote, states->remote->url_nr > 0 ?
864 states->remote->url[0] : NULL);
865 remote_refs = transport_get_remote_refs(transport);
866 transport_disconnect(transport);
869 if (query & GET_REF_STATES)
870 get_ref_states(remote_refs, states);
871 if (query & GET_HEAD_NAMES)
872 get_head_names(remote_refs, states);
873 if (query & GET_PUSH_REF_STATES)
874 get_push_ref_states(remote_refs, states);
876 for_each_ref(append_ref_to_tracked_list, states);
877 string_list_sort(&states->tracked);
878 get_push_ref_states_noquery(states);
885 struct string_list *list;
886 struct ref_states *states;
891 static int add_remote_to_show_info(struct string_list_item *item, void *cb_data)
893 struct show_info *info = cb_data;
894 int n = strlen(item->string);
897 string_list_insert(info->list, item->string);
901 static int show_remote_info_item(struct string_list_item *item, void *cb_data)
903 struct show_info *info = cb_data;
904 struct ref_states *states = info->states;
905 const char *name = item->string;
907 if (states->queried) {
908 const char *fmt = "%s";
909 const char *arg = "";
910 if (string_list_has_string(&states->new, name)) {
911 fmt = _(" new (next fetch will store in remotes/%s)");
912 arg = states->remote->name;
913 } else if (string_list_has_string(&states->tracked, name))
915 else if (string_list_has_string(&states->stale, name))
916 arg = _(" stale (use 'git remote prune' to remove)");
919 printf(" %-*s", info->width, name);
923 printf(" %s\n", name);
928 static int add_local_to_show_info(struct string_list_item *branch_item, void *cb_data)
930 struct show_info *show_info = cb_data;
931 struct ref_states *states = show_info->states;
932 struct branch_info *branch_info = branch_item->util;
933 struct string_list_item *item;
936 if (!branch_info->merge.nr || !branch_info->remote_name ||
937 strcmp(states->remote->name, branch_info->remote_name))
939 if ((n = strlen(branch_item->string)) > show_info->width)
940 show_info->width = n;
941 if (branch_info->rebase)
942 show_info->any_rebase = 1;
944 item = string_list_insert(show_info->list, branch_item->string);
945 item->util = branch_info;
950 static int show_local_info_item(struct string_list_item *item, void *cb_data)
952 struct show_info *show_info = cb_data;
953 struct branch_info *branch_info = item->util;
954 struct string_list *merge = &branch_info->merge;
955 int width = show_info->width + 4;
958 if (branch_info->rebase && branch_info->merge.nr > 1) {
959 error(_("invalid branch.%s.merge; cannot rebase onto > 1 branch"),
964 printf(" %-*s ", show_info->width, item->string);
965 if (branch_info->rebase) {
966 printf_ln(branch_info->rebase == INTERACTIVE_REBASE
967 ? _("rebases interactively onto remote %s")
968 : _("rebases onto remote %s"), merge->items[0].string);
970 } else if (show_info->any_rebase) {
971 printf_ln(_(" merges with remote %s"), merge->items[0].string);
974 printf_ln(_("merges with remote %s"), merge->items[0].string);
976 for (i = 1; i < merge->nr; i++)
977 printf(_("%-*s and with remote %s\n"), width, "",
978 merge->items[i].string);
983 static int add_push_to_show_info(struct string_list_item *push_item, void *cb_data)
985 struct show_info *show_info = cb_data;
986 struct push_info *push_info = push_item->util;
987 struct string_list_item *item;
989 if ((n = strlen(push_item->string)) > show_info->width)
990 show_info->width = n;
991 if ((n = strlen(push_info->dest)) > show_info->width2)
992 show_info->width2 = n;
993 item = string_list_append(show_info->list, push_item->string);
994 item->util = push_item->util;
999 * Sorting comparison for a string list that has push_info
1000 * structs in its util field
1002 static int cmp_string_with_push(const void *va, const void *vb)
1004 const struct string_list_item *a = va;
1005 const struct string_list_item *b = vb;
1006 const struct push_info *a_push = a->util;
1007 const struct push_info *b_push = b->util;
1008 int cmp = strcmp(a->string, b->string);
1009 return cmp ? cmp : strcmp(a_push->dest, b_push->dest);
1012 static int show_push_info_item(struct string_list_item *item, void *cb_data)
1014 struct show_info *show_info = cb_data;
1015 struct push_info *push_info = item->util;
1016 const char *src = item->string, *status = NULL;
1018 switch (push_info->status) {
1019 case PUSH_STATUS_CREATE:
1020 status = _("create");
1022 case PUSH_STATUS_DELETE:
1023 status = _("delete");
1026 case PUSH_STATUS_UPTODATE:
1027 status = _("up to date");
1029 case PUSH_STATUS_FASTFORWARD:
1030 status = _("fast-forwardable");
1032 case PUSH_STATUS_OUTOFDATE:
1033 status = _("local out of date");
1035 case PUSH_STATUS_NOTQUERIED:
1039 if (push_info->forced)
1040 printf_ln(_(" %-*s forces to %-*s (%s)"), show_info->width, src,
1041 show_info->width2, push_info->dest, status);
1043 printf_ln(_(" %-*s pushes to %-*s (%s)"), show_info->width, src,
1044 show_info->width2, push_info->dest, status);
1046 if (push_info->forced)
1047 printf_ln(_(" %-*s forces to %s"), show_info->width, src,
1050 printf_ln(_(" %-*s pushes to %s"), show_info->width, src,
1056 static int get_one_entry(struct remote *remote, void *priv)
1058 struct string_list *list = priv;
1059 struct strbuf url_buf = STRBUF_INIT;
1063 if (remote->url_nr > 0) {
1064 strbuf_addf(&url_buf, "%s (fetch)", remote->url[0]);
1065 string_list_append(list, remote->name)->util =
1066 strbuf_detach(&url_buf, NULL);
1068 string_list_append(list, remote->name)->util = NULL;
1069 if (remote->pushurl_nr) {
1070 url = remote->pushurl;
1071 url_nr = remote->pushurl_nr;
1074 url_nr = remote->url_nr;
1076 for (i = 0; i < url_nr; i++)
1078 strbuf_addf(&url_buf, "%s (push)", url[i]);
1079 string_list_append(list, remote->name)->util =
1080 strbuf_detach(&url_buf, NULL);
1086 static int show_all(void)
1088 struct string_list list = STRING_LIST_INIT_NODUP;
1091 list.strdup_strings = 1;
1092 result = for_each_remote(get_one_entry, &list);
1097 string_list_sort(&list);
1098 for (i = 0; i < list.nr; i++) {
1099 struct string_list_item *item = list.items + i;
1101 printf("%s\t%s\n", item->string,
1102 item->util ? (const char *)item->util : "");
1104 if (i && !strcmp((item - 1)->string, item->string))
1106 printf("%s\n", item->string);
1110 string_list_clear(&list, 1);
1114 static int show(int argc, const char **argv)
1116 int no_query = 0, result = 0, query_flag = 0;
1117 struct option options[] = {
1118 OPT_BOOL('n', NULL, &no_query, N_("do not query remotes")),
1121 struct ref_states states;
1122 struct string_list info_list = STRING_LIST_INIT_NODUP;
1123 struct show_info info;
1125 argc = parse_options(argc, argv, NULL, options, builtin_remote_show_usage,
1132 query_flag = (GET_REF_STATES | GET_HEAD_NAMES | GET_PUSH_REF_STATES);
1134 memset(&states, 0, sizeof(states));
1135 memset(&info, 0, sizeof(info));
1136 info.states = &states;
1137 info.list = &info_list;
1138 for (; argc; argc--, argv++) {
1143 get_remote_ref_states(*argv, &states, query_flag);
1145 printf_ln(_("* remote %s"), *argv);
1146 printf_ln(_(" Fetch URL: %s"), states.remote->url_nr > 0 ?
1147 states.remote->url[0] : _("(no URL)"));
1148 if (states.remote->pushurl_nr) {
1149 url = states.remote->pushurl;
1150 url_nr = states.remote->pushurl_nr;
1152 url = states.remote->url;
1153 url_nr = states.remote->url_nr;
1155 for (i = 0; i < url_nr; i++)
1157 * TRANSLATORS: the colon ':' should align
1158 * with the one in " Fetch URL: %s"
1161 printf_ln(_(" Push URL: %s"), url[i]);
1163 printf_ln(_(" Push URL: %s"), _("(no URL)"));
1165 printf_ln(_(" HEAD branch: %s"), _("(not queried)"));
1166 else if (!states.heads.nr)
1167 printf_ln(_(" HEAD branch: %s"), _("(unknown)"));
1168 else if (states.heads.nr == 1)
1169 printf_ln(_(" HEAD branch: %s"), states.heads.items[0].string);
1171 printf(_(" HEAD branch (remote HEAD is ambiguous,"
1172 " may be one of the following):\n"));
1173 for (i = 0; i < states.heads.nr; i++)
1174 printf(" %s\n", states.heads.items[i].string);
1177 /* remote branch info */
1179 for_each_string_list(&states.new, add_remote_to_show_info, &info);
1180 for_each_string_list(&states.tracked, add_remote_to_show_info, &info);
1181 for_each_string_list(&states.stale, add_remote_to_show_info, &info);
1183 printf_ln(Q_(" Remote branch:%s",
1184 " Remote branches:%s",
1186 no_query ? _(" (status not queried)") : "");
1187 for_each_string_list(info.list, show_remote_info_item, &info);
1188 string_list_clear(info.list, 0);
1192 info.any_rebase = 0;
1193 for_each_string_list(&branch_list, add_local_to_show_info, &info);
1195 printf_ln(Q_(" Local branch configured for 'git pull':",
1196 " Local branches configured for 'git pull':",
1198 for_each_string_list(info.list, show_local_info_item, &info);
1199 string_list_clear(info.list, 0);
1202 if (states.remote->mirror)
1203 printf_ln(_(" Local refs will be mirrored by 'git push'"));
1205 info.width = info.width2 = 0;
1206 for_each_string_list(&states.push, add_push_to_show_info, &info);
1207 QSORT(info.list->items, info.list->nr, cmp_string_with_push);
1209 printf_ln(Q_(" Local ref configured for 'git push'%s:",
1210 " Local refs configured for 'git push'%s:",
1212 no_query ? _(" (status not queried)") : "");
1213 for_each_string_list(info.list, show_push_info_item, &info);
1214 string_list_clear(info.list, 0);
1216 free_remote_ref_states(&states);
1222 static int set_head(int argc, const char **argv)
1224 int i, opt_a = 0, opt_d = 0, result = 0;
1225 struct strbuf buf = STRBUF_INIT, buf2 = STRBUF_INIT;
1226 char *head_name = NULL;
1228 struct option options[] = {
1229 OPT_BOOL('a', "auto", &opt_a,
1230 N_("set refs/remotes/<name>/HEAD according to remote")),
1231 OPT_BOOL('d', "delete", &opt_d,
1232 N_("delete refs/remotes/<name>/HEAD")),
1235 argc = parse_options(argc, argv, NULL, options, builtin_remote_sethead_usage,
1238 strbuf_addf(&buf, "refs/remotes/%s/HEAD", argv[0]);
1240 if (!opt_a && !opt_d && argc == 2) {
1241 head_name = xstrdup(argv[1]);
1242 } else if (opt_a && !opt_d && argc == 1) {
1243 struct ref_states states;
1244 memset(&states, 0, sizeof(states));
1245 get_remote_ref_states(argv[0], &states, GET_HEAD_NAMES);
1246 if (!states.heads.nr)
1247 result |= error(_("Cannot determine remote HEAD"));
1248 else if (states.heads.nr > 1) {
1249 result |= error(_("Multiple remote HEAD branches. "
1250 "Please choose one explicitly with:"));
1251 for (i = 0; i < states.heads.nr; i++)
1252 fprintf(stderr, " git remote set-head %s %s\n",
1253 argv[0], states.heads.items[i].string);
1255 head_name = xstrdup(states.heads.items[0].string);
1256 free_remote_ref_states(&states);
1257 } else if (opt_d && !opt_a && argc == 1) {
1258 if (delete_ref(NULL, buf.buf, NULL, REF_NODEREF))
1259 result |= error(_("Could not delete %s"), buf.buf);
1261 usage_with_options(builtin_remote_sethead_usage, options);
1264 strbuf_addf(&buf2, "refs/remotes/%s/%s", argv[0], head_name);
1265 /* make sure it's valid */
1266 if (!ref_exists(buf2.buf))
1267 result |= error(_("Not a valid ref: %s"), buf2.buf);
1268 else if (create_symref(buf.buf, buf2.buf, "remote set-head"))
1269 result |= error(_("Could not setup %s"), buf.buf);
1271 printf("%s/HEAD set to %s\n", argv[0], head_name);
1275 strbuf_release(&buf);
1276 strbuf_release(&buf2);
1280 static int prune_remote(const char *remote, int dry_run)
1283 struct ref_states states;
1284 struct string_list refs_to_prune = STRING_LIST_INIT_NODUP;
1285 struct string_list_item *item;
1286 const char *dangling_msg = dry_run
1287 ? _(" %s will become dangling!")
1288 : _(" %s has become dangling!");
1290 memset(&states, 0, sizeof(states));
1291 get_remote_ref_states(remote, &states, GET_REF_STATES);
1293 if (!states.stale.nr) {
1294 free_remote_ref_states(&states);
1298 printf_ln(_("Pruning %s"), remote);
1299 printf_ln(_("URL: %s"),
1300 states.remote->url_nr
1301 ? states.remote->url[0]
1304 for_each_string_list_item(item, &states.stale)
1305 string_list_append(&refs_to_prune, item->util);
1306 string_list_sort(&refs_to_prune);
1309 result |= delete_refs("remote: prune", &refs_to_prune, 0);
1311 for_each_string_list_item(item, &states.stale) {
1312 const char *refname = item->util;
1315 printf_ln(_(" * [would prune] %s"),
1316 abbrev_ref(refname, "refs/remotes/"));
1318 printf_ln(_(" * [pruned] %s"),
1319 abbrev_ref(refname, "refs/remotes/"));
1322 warn_dangling_symrefs(stdout, dangling_msg, &refs_to_prune);
1324 string_list_clear(&refs_to_prune, 0);
1325 free_remote_ref_states(&states);
1329 static int prune(int argc, const char **argv)
1331 int dry_run = 0, result = 0;
1332 struct option options[] = {
1333 OPT__DRY_RUN(&dry_run, N_("dry run")),
1337 argc = parse_options(argc, argv, NULL, options, builtin_remote_prune_usage,
1341 usage_with_options(builtin_remote_prune_usage, options);
1343 for (; argc; argc--, argv++)
1344 result |= prune_remote(*argv, dry_run);
1349 static int get_remote_default(const char *key, const char *value, void *priv)
1351 if (strcmp(key, "remotes.default") == 0) {
1358 static int update(int argc, const char **argv)
1361 struct option options[] = {
1362 OPT_BOOL('p', "prune", &prune,
1363 N_("prune remotes after fetching")),
1366 struct argv_array fetch_argv = ARGV_ARRAY_INIT;
1367 int default_defined = 0;
1370 argc = parse_options(argc, argv, NULL, options, builtin_remote_update_usage,
1371 PARSE_OPT_KEEP_ARGV0);
1373 argv_array_push(&fetch_argv, "fetch");
1376 argv_array_push(&fetch_argv, prune ? "--prune" : "--no-prune");
1378 argv_array_push(&fetch_argv, "-v");
1379 argv_array_push(&fetch_argv, "--multiple");
1381 argv_array_push(&fetch_argv, "default");
1382 for (i = 1; i < argc; i++)
1383 argv_array_push(&fetch_argv, argv[i]);
1385 if (strcmp(fetch_argv.argv[fetch_argv.argc-1], "default") == 0) {
1386 git_config(get_remote_default, &default_defined);
1387 if (!default_defined) {
1388 argv_array_pop(&fetch_argv);
1389 argv_array_push(&fetch_argv, "--all");
1393 retval = run_command_v_opt(fetch_argv.argv, RUN_GIT_CMD);
1394 argv_array_clear(&fetch_argv);
1398 static int remove_all_fetch_refspecs(const char *remote, const char *key)
1400 return git_config_set_multivar_gently(key, NULL, NULL, 1);
1403 static void add_branches(struct remote *remote, const char **branches,
1406 const char *remotename = remote->name;
1407 int mirror = remote->mirror;
1408 struct strbuf refspec = STRBUF_INIT;
1410 for (; *branches; branches++)
1411 add_branch(key, *branches, remotename, mirror, &refspec);
1413 strbuf_release(&refspec);
1416 static int set_remote_branches(const char *remotename, const char **branches,
1419 struct strbuf key = STRBUF_INIT;
1420 struct remote *remote;
1422 strbuf_addf(&key, "remote.%s.fetch", remotename);
1424 remote = remote_get(remotename);
1425 if (!remote_is_configured(remote, 1))
1426 die(_("No such remote '%s'"), remotename);
1428 if (!add_mode && remove_all_fetch_refspecs(remotename, key.buf)) {
1429 strbuf_release(&key);
1432 add_branches(remote, branches, key.buf);
1434 strbuf_release(&key);
1438 static int set_branches(int argc, const char **argv)
1441 struct option options[] = {
1442 OPT_BOOL('\0', "add", &add_mode, N_("add branch")),
1446 argc = parse_options(argc, argv, NULL, options,
1447 builtin_remote_setbranches_usage, 0);
1449 error(_("no remote specified"));
1450 usage_with_options(builtin_remote_setbranches_usage, options);
1454 return set_remote_branches(argv[0], argv + 1, add_mode);
1457 static int get_url(int argc, const char **argv)
1459 int i, push_mode = 0, all_mode = 0;
1460 const char *remotename = NULL;
1461 struct remote *remote;
1464 struct option options[] = {
1465 OPT_BOOL('\0', "push", &push_mode,
1466 N_("query push URLs rather than fetch URLs")),
1467 OPT_BOOL('\0', "all", &all_mode,
1468 N_("return all URLs")),
1471 argc = parse_options(argc, argv, NULL, options, builtin_remote_geturl_usage, 0);
1474 usage_with_options(builtin_remote_geturl_usage, options);
1476 remotename = argv[0];
1478 remote = remote_get(remotename);
1479 if (!remote_is_configured(remote, 1))
1480 die(_("No such remote '%s'"), remotename);
1484 url = remote->pushurl;
1485 url_nr = remote->pushurl_nr;
1487 /* else fetch mode */
1489 /* Use the fetch URL when no push URLs were found or requested. */
1492 url_nr = remote->url_nr;
1496 die(_("no URLs configured for remote '%s'"), remotename);
1499 for (i = 0; i < url_nr; i++)
1500 printf_ln("%s", url[i]);
1502 printf_ln("%s", *url);
1508 static int set_url(int argc, const char **argv)
1510 int i, push_mode = 0, add_mode = 0, delete_mode = 0;
1511 int matches = 0, negative_matches = 0;
1512 const char *remotename = NULL;
1513 const char *newurl = NULL;
1514 const char *oldurl = NULL;
1515 struct remote *remote;
1517 const char **urlset;
1519 struct strbuf name_buf = STRBUF_INIT;
1520 struct option options[] = {
1521 OPT_BOOL('\0', "push", &push_mode,
1522 N_("manipulate push URLs")),
1523 OPT_BOOL('\0', "add", &add_mode,
1525 OPT_BOOL('\0', "delete", &delete_mode,
1529 argc = parse_options(argc, argv, NULL, options, builtin_remote_seturl_usage,
1530 PARSE_OPT_KEEP_ARGV0);
1532 if (add_mode && delete_mode)
1533 die(_("--add --delete doesn't make sense"));
1535 if (argc < 3 || argc > 4 || ((add_mode || delete_mode) && argc != 3))
1536 usage_with_options(builtin_remote_seturl_usage, options);
1538 remotename = argv[1];
1546 remote = remote_get(remotename);
1547 if (!remote_is_configured(remote, 1))
1548 die(_("No such remote '%s'"), remotename);
1551 strbuf_addf(&name_buf, "remote.%s.pushurl", remotename);
1552 urlset = remote->pushurl;
1553 urlset_nr = remote->pushurl_nr;
1555 strbuf_addf(&name_buf, "remote.%s.url", remotename);
1556 urlset = remote->url;
1557 urlset_nr = remote->url_nr;
1560 /* Special cases that add new entry. */
1561 if ((!oldurl && !delete_mode) || add_mode) {
1563 git_config_set_multivar(name_buf.buf, newurl,
1566 git_config_set(name_buf.buf, newurl);
1570 /* Old URL specified. Demand that one matches. */
1571 if (regcomp(&old_regex, oldurl, REG_EXTENDED))
1572 die(_("Invalid old URL pattern: %s"), oldurl);
1574 for (i = 0; i < urlset_nr; i++)
1575 if (!regexec(&old_regex, urlset[i], 0, NULL, 0))
1579 if (!delete_mode && !matches)
1580 die(_("No such URL found: %s"), oldurl);
1581 if (delete_mode && !negative_matches && !push_mode)
1582 die(_("Will not delete all non-push URLs"));
1584 regfree(&old_regex);
1587 git_config_set_multivar(name_buf.buf, newurl, oldurl, 0);
1589 git_config_set_multivar(name_buf.buf, NULL, oldurl, 1);
1591 strbuf_release(&name_buf);
1595 int cmd_remote(int argc, const char **argv, const char *prefix)
1597 struct option options[] = {
1598 OPT__VERBOSE(&verbose, N_("be verbose; must be placed before a subcommand")),
1603 argc = parse_options(argc, argv, prefix, options, builtin_remote_usage,
1604 PARSE_OPT_STOP_AT_NON_OPTION);
1607 result = show_all();
1608 else if (!strcmp(argv[0], "add"))
1609 result = add(argc, argv);
1610 else if (!strcmp(argv[0], "rename"))
1611 result = mv(argc, argv);
1612 else if (!strcmp(argv[0], "rm") || !strcmp(argv[0], "remove"))
1613 result = rm(argc, argv);
1614 else if (!strcmp(argv[0], "set-head"))
1615 result = set_head(argc, argv);
1616 else if (!strcmp(argv[0], "set-branches"))
1617 result = set_branches(argc, argv);
1618 else if (!strcmp(argv[0], "get-url"))
1619 result = get_url(argc, argv);
1620 else if (!strcmp(argv[0], "set-url"))
1621 result = set_url(argc, argv);
1622 else if (!strcmp(argv[0], "show"))
1623 result = show(argc, argv);
1624 else if (!strcmp(argv[0], "prune"))
1625 result = prune(argc, argv);
1626 else if (!strcmp(argv[0], "update"))
1627 result = update(argc, argv);
1629 error(_("Unknown subcommand: %s"), argv[0]);
1630 usage_with_options(builtin_remote_usage, options);
1633 return result ? 1 : 0;