Sync with 'maint'
[git/gitster.git] / builtin / fetch.c
blob55f97134aa81e383e19efcaae5183f680344dd4e
1 /*
2 * "git fetch"
3 */
4 #include "builtin.h"
5 #include "advice.h"
6 #include "config.h"
7 #include "gettext.h"
8 #include "environment.h"
9 #include "hex.h"
10 #include "repository.h"
11 #include "refs.h"
12 #include "refspec.h"
13 #include "object-name.h"
14 #include "object-store-ll.h"
15 #include "oidset.h"
16 #include "oid-array.h"
17 #include "commit.h"
18 #include "string-list.h"
19 #include "remote.h"
20 #include "transport.h"
21 #include "run-command.h"
22 #include "parse-options.h"
23 #include "sigchain.h"
24 #include "submodule-config.h"
25 #include "submodule.h"
26 #include "connected.h"
27 #include "strvec.h"
28 #include "utf8.h"
29 #include "pager.h"
30 #include "path.h"
31 #include "pkt-line.h"
32 #include "list-objects-filter-options.h"
33 #include "commit-reach.h"
34 #include "branch.h"
35 #include "promisor-remote.h"
36 #include "commit-graph.h"
37 #include "shallow.h"
38 #include "trace.h"
39 #include "trace2.h"
40 #include "bundle-uri.h"
42 #define FORCED_UPDATES_DELAY_WARNING_IN_MS (10 * 1000)
44 static const char * const builtin_fetch_usage[] = {
45 N_("git fetch [<options>] [<repository> [<refspec>...]]"),
46 N_("git fetch [<options>] <group>"),
47 N_("git fetch --multiple [<options>] [(<repository> | <group>)...]"),
48 N_("git fetch --all [<options>]"),
49 NULL
52 enum {
53 TAGS_UNSET = 0,
54 TAGS_DEFAULT = 1,
55 TAGS_SET = 2
58 enum display_format {
59 DISPLAY_FORMAT_FULL,
60 DISPLAY_FORMAT_COMPACT,
61 DISPLAY_FORMAT_PORCELAIN,
64 struct display_state {
65 struct strbuf buf;
67 int refcol_width;
68 enum display_format format;
70 char *url;
71 int url_len, shown_url;
74 static uint64_t forced_updates_ms = 0;
75 static int prefetch = 0;
76 static int prune = -1; /* unspecified */
77 #define PRUNE_BY_DEFAULT 0 /* do we prune by default? */
79 static int prune_tags = -1; /* unspecified */
80 #define PRUNE_TAGS_BY_DEFAULT 0 /* do we prune tags by default? */
82 static int append, dry_run, force, keep, update_head_ok;
83 static int write_fetch_head = 1;
84 static int verbosity, deepen_relative, set_upstream, refetch;
85 static int progress = -1;
86 static int tags = TAGS_DEFAULT, update_shallow, deepen;
87 static int atomic_fetch;
88 static enum transport_family family;
89 static const char *depth;
90 static const char *deepen_since;
91 static const char *upload_pack;
92 static struct string_list deepen_not = STRING_LIST_INIT_NODUP;
93 static struct strbuf default_rla = STRBUF_INIT;
94 static struct transport *gtransport;
95 static struct transport *gsecondary;
96 static struct refspec refmap = REFSPEC_INIT_FETCH;
97 static struct list_objects_filter_options filter_options = LIST_OBJECTS_FILTER_INIT;
98 static struct string_list server_options = STRING_LIST_INIT_DUP;
99 static struct string_list negotiation_tip = STRING_LIST_INIT_NODUP;
101 struct fetch_config {
102 enum display_format display_format;
103 int all;
104 int prune;
105 int prune_tags;
106 int show_forced_updates;
107 int recurse_submodules;
108 int parallel;
109 int submodule_fetch_jobs;
112 static int git_fetch_config(const char *k, const char *v,
113 const struct config_context *ctx, void *cb)
115 struct fetch_config *fetch_config = cb;
117 if (!strcmp(k, "fetch.all")) {
118 fetch_config->all = git_config_bool(k, v);
119 return 0;
122 if (!strcmp(k, "fetch.prune")) {
123 fetch_config->prune = git_config_bool(k, v);
124 return 0;
127 if (!strcmp(k, "fetch.prunetags")) {
128 fetch_config->prune_tags = git_config_bool(k, v);
129 return 0;
132 if (!strcmp(k, "fetch.showforcedupdates")) {
133 fetch_config->show_forced_updates = git_config_bool(k, v);
134 return 0;
137 if (!strcmp(k, "submodule.recurse")) {
138 int r = git_config_bool(k, v) ?
139 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
140 fetch_config->recurse_submodules = r;
141 return 0;
144 if (!strcmp(k, "submodule.fetchjobs")) {
145 fetch_config->submodule_fetch_jobs = parse_submodule_fetchjobs(k, v, ctx->kvi);
146 return 0;
147 } else if (!strcmp(k, "fetch.recursesubmodules")) {
148 fetch_config->recurse_submodules = parse_fetch_recurse_submodules_arg(k, v);
149 return 0;
152 if (!strcmp(k, "fetch.parallel")) {
153 fetch_config->parallel = git_config_int(k, v, ctx->kvi);
154 if (fetch_config->parallel < 0)
155 die(_("fetch.parallel cannot be negative"));
156 if (!fetch_config->parallel)
157 fetch_config->parallel = online_cpus();
158 return 0;
161 if (!strcmp(k, "fetch.output")) {
162 if (!v)
163 return config_error_nonbool(k);
164 else if (!strcasecmp(v, "full"))
165 fetch_config->display_format = DISPLAY_FORMAT_FULL;
166 else if (!strcasecmp(v, "compact"))
167 fetch_config->display_format = DISPLAY_FORMAT_COMPACT;
168 else
169 die(_("invalid value for '%s': '%s'"),
170 "fetch.output", v);
173 return git_default_config(k, v, ctx, cb);
176 static int parse_refmap_arg(const struct option *opt, const char *arg, int unset)
178 BUG_ON_OPT_NEG(unset);
181 * "git fetch --refmap='' origin foo"
182 * can be used to tell the command not to store anywhere
184 refspec_append(opt->value, arg);
186 return 0;
189 static void unlock_pack(unsigned int flags)
191 if (gtransport)
192 transport_unlock_pack(gtransport, flags);
193 if (gsecondary)
194 transport_unlock_pack(gsecondary, flags);
197 static void unlock_pack_atexit(void)
199 unlock_pack(0);
202 static void unlock_pack_on_signal(int signo)
204 unlock_pack(TRANSPORT_UNLOCK_PACK_IN_SIGNAL_HANDLER);
205 sigchain_pop(signo);
206 raise(signo);
209 static void add_merge_config(struct ref **head,
210 const struct ref *remote_refs,
211 struct branch *branch,
212 struct ref ***tail)
214 int i;
216 for (i = 0; i < branch->merge_nr; i++) {
217 struct ref *rm, **old_tail = *tail;
218 struct refspec_item refspec;
220 for (rm = *head; rm; rm = rm->next) {
221 if (branch_merge_matches(branch, i, rm->name)) {
222 rm->fetch_head_status = FETCH_HEAD_MERGE;
223 break;
226 if (rm)
227 continue;
230 * Not fetched to a remote-tracking branch? We need to fetch
231 * it anyway to allow this branch's "branch.$name.merge"
232 * to be honored by 'git pull', but we do not have to
233 * fail if branch.$name.merge is misconfigured to point
234 * at a nonexisting branch. If we were indeed called by
235 * 'git pull', it will notice the misconfiguration because
236 * there is no entry in the resulting FETCH_HEAD marked
237 * for merging.
239 memset(&refspec, 0, sizeof(refspec));
240 refspec.src = branch->merge[i]->src;
241 get_fetch_map(remote_refs, &refspec, tail, 1);
242 for (rm = *old_tail; rm; rm = rm->next)
243 rm->fetch_head_status = FETCH_HEAD_MERGE;
247 static void create_fetch_oidset(struct ref **head, struct oidset *out)
249 struct ref *rm = *head;
250 while (rm) {
251 oidset_insert(out, &rm->old_oid);
252 rm = rm->next;
256 struct refname_hash_entry {
257 struct hashmap_entry ent;
258 struct object_id oid;
259 int ignore;
260 char refname[FLEX_ARRAY];
263 static int refname_hash_entry_cmp(const void *hashmap_cmp_fn_data UNUSED,
264 const struct hashmap_entry *eptr,
265 const struct hashmap_entry *entry_or_key,
266 const void *keydata)
268 const struct refname_hash_entry *e1, *e2;
270 e1 = container_of(eptr, const struct refname_hash_entry, ent);
271 e2 = container_of(entry_or_key, const struct refname_hash_entry, ent);
272 return strcmp(e1->refname, keydata ? keydata : e2->refname);
275 static struct refname_hash_entry *refname_hash_add(struct hashmap *map,
276 const char *refname,
277 const struct object_id *oid)
279 struct refname_hash_entry *ent;
280 size_t len = strlen(refname);
282 FLEX_ALLOC_MEM(ent, refname, refname, len);
283 hashmap_entry_init(&ent->ent, strhash(refname));
284 oidcpy(&ent->oid, oid);
285 hashmap_add(map, &ent->ent);
286 return ent;
289 static int add_one_refname(const char *refname, const char *referent UNUSED,
290 const struct object_id *oid,
291 int flag UNUSED, void *cbdata)
293 struct hashmap *refname_map = cbdata;
295 (void) refname_hash_add(refname_map, refname, oid);
296 return 0;
299 static void refname_hash_init(struct hashmap *map)
301 hashmap_init(map, refname_hash_entry_cmp, NULL, 0);
304 static int refname_hash_exists(struct hashmap *map, const char *refname)
306 return !!hashmap_get_from_hash(map, strhash(refname), refname);
309 static void clear_item(struct refname_hash_entry *item)
311 item->ignore = 1;
315 static void add_already_queued_tags(const char *refname,
316 const struct object_id *old_oid UNUSED,
317 const struct object_id *new_oid,
318 void *cb_data)
320 struct hashmap *queued_tags = cb_data;
321 if (starts_with(refname, "refs/tags/") && new_oid)
322 (void) refname_hash_add(queued_tags, refname, new_oid);
325 static void find_non_local_tags(const struct ref *refs,
326 struct ref_transaction *transaction,
327 struct ref **head,
328 struct ref ***tail)
330 struct hashmap existing_refs;
331 struct hashmap remote_refs;
332 struct oidset fetch_oids = OIDSET_INIT;
333 struct string_list remote_refs_list = STRING_LIST_INIT_NODUP;
334 struct string_list_item *remote_ref_item;
335 const struct ref *ref;
336 struct refname_hash_entry *item = NULL;
337 const int quick_flags = OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT;
339 refname_hash_init(&existing_refs);
340 refname_hash_init(&remote_refs);
341 create_fetch_oidset(head, &fetch_oids);
343 refs_for_each_ref(get_main_ref_store(the_repository), add_one_refname,
344 &existing_refs);
347 * If we already have a transaction, then we need to filter out all
348 * tags which have already been queued up.
350 if (transaction)
351 ref_transaction_for_each_queued_update(transaction,
352 add_already_queued_tags,
353 &existing_refs);
355 for (ref = refs; ref; ref = ref->next) {
356 if (!starts_with(ref->name, "refs/tags/"))
357 continue;
360 * The peeled ref always follows the matching base
361 * ref, so if we see a peeled ref that we don't want
362 * to fetch then we can mark the ref entry in the list
363 * as one to ignore by setting util to NULL.
365 if (ends_with(ref->name, "^{}")) {
366 if (item &&
367 !repo_has_object_file_with_flags(the_repository, &ref->old_oid, quick_flags) &&
368 !oidset_contains(&fetch_oids, &ref->old_oid) &&
369 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
370 !oidset_contains(&fetch_oids, &item->oid))
371 clear_item(item);
372 item = NULL;
373 continue;
377 * If item is non-NULL here, then we previously saw a
378 * ref not followed by a peeled reference, so we need
379 * to check if it is a lightweight tag that we want to
380 * fetch.
382 if (item &&
383 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
384 !oidset_contains(&fetch_oids, &item->oid))
385 clear_item(item);
387 item = NULL;
389 /* skip duplicates and refs that we already have */
390 if (refname_hash_exists(&remote_refs, ref->name) ||
391 refname_hash_exists(&existing_refs, ref->name))
392 continue;
394 item = refname_hash_add(&remote_refs, ref->name, &ref->old_oid);
395 string_list_insert(&remote_refs_list, ref->name);
397 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
400 * We may have a final lightweight tag that needs to be
401 * checked to see if it needs fetching.
403 if (item &&
404 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
405 !oidset_contains(&fetch_oids, &item->oid))
406 clear_item(item);
409 * For all the tags in the remote_refs_list,
410 * add them to the list of refs to be fetched
412 for_each_string_list_item(remote_ref_item, &remote_refs_list) {
413 const char *refname = remote_ref_item->string;
414 struct ref *rm;
415 unsigned int hash = strhash(refname);
417 item = hashmap_get_entry_from_hash(&remote_refs, hash, refname,
418 struct refname_hash_entry, ent);
419 if (!item)
420 BUG("unseen remote ref?");
422 /* Unless we have already decided to ignore this item... */
423 if (item->ignore)
424 continue;
426 rm = alloc_ref(item->refname);
427 rm->peer_ref = alloc_ref(item->refname);
428 oidcpy(&rm->old_oid, &item->oid);
429 **tail = rm;
430 *tail = &rm->next;
432 hashmap_clear_and_free(&remote_refs, struct refname_hash_entry, ent);
433 string_list_clear(&remote_refs_list, 0);
434 oidset_clear(&fetch_oids);
437 static void filter_prefetch_refspec(struct refspec *rs)
439 int i;
441 if (!prefetch)
442 return;
444 for (i = 0; i < rs->nr; i++) {
445 struct strbuf new_dst = STRBUF_INIT;
446 char *old_dst;
447 const char *sub = NULL;
449 if (rs->items[i].negative)
450 continue;
451 if (!rs->items[i].dst ||
452 (rs->items[i].src &&
453 starts_with(rs->items[i].src,
454 ref_namespace[NAMESPACE_TAGS].ref))) {
455 int j;
457 free(rs->items[i].src);
458 free(rs->items[i].dst);
460 for (j = i + 1; j < rs->nr; j++) {
461 rs->items[j - 1] = rs->items[j];
462 rs->raw[j - 1] = rs->raw[j];
464 rs->nr--;
465 i--;
466 continue;
469 old_dst = rs->items[i].dst;
470 strbuf_addstr(&new_dst, ref_namespace[NAMESPACE_PREFETCH].ref);
473 * If old_dst starts with "refs/", then place
474 * sub after that prefix. Otherwise, start at
475 * the beginning of the string.
477 if (!skip_prefix(old_dst, "refs/", &sub))
478 sub = old_dst;
479 strbuf_addstr(&new_dst, sub);
481 rs->items[i].dst = strbuf_detach(&new_dst, NULL);
482 rs->items[i].force = 1;
484 free(old_dst);
488 static struct ref *get_ref_map(struct remote *remote,
489 const struct ref *remote_refs,
490 struct refspec *rs,
491 int tags, int *autotags)
493 int i;
494 struct ref *rm;
495 struct ref *ref_map = NULL;
496 struct ref **tail = &ref_map;
498 /* opportunistically-updated references: */
499 struct ref *orefs = NULL, **oref_tail = &orefs;
501 struct hashmap existing_refs;
502 int existing_refs_populated = 0;
504 filter_prefetch_refspec(rs);
505 if (remote)
506 filter_prefetch_refspec(&remote->fetch);
508 if (rs->nr) {
509 struct refspec *fetch_refspec;
511 for (i = 0; i < rs->nr; i++) {
512 get_fetch_map(remote_refs, &rs->items[i], &tail, 0);
513 if (rs->items[i].dst && rs->items[i].dst[0])
514 *autotags = 1;
516 /* Merge everything on the command line (but not --tags) */
517 for (rm = ref_map; rm; rm = rm->next)
518 rm->fetch_head_status = FETCH_HEAD_MERGE;
521 * For any refs that we happen to be fetching via
522 * command-line arguments, the destination ref might
523 * have been missing or have been different than the
524 * remote-tracking ref that would be derived from the
525 * configured refspec. In these cases, we want to
526 * take the opportunity to update their configured
527 * remote-tracking reference. However, we do not want
528 * to mention these entries in FETCH_HEAD at all, as
529 * they would simply be duplicates of existing
530 * entries, so we set them FETCH_HEAD_IGNORE below.
532 * We compute these entries now, based only on the
533 * refspecs specified on the command line. But we add
534 * them to the list following the refspecs resulting
535 * from the tags option so that one of the latter,
536 * which has FETCH_HEAD_NOT_FOR_MERGE, is not removed
537 * by ref_remove_duplicates() in favor of one of these
538 * opportunistic entries with FETCH_HEAD_IGNORE.
540 if (refmap.nr)
541 fetch_refspec = &refmap;
542 else
543 fetch_refspec = &remote->fetch;
545 for (i = 0; i < fetch_refspec->nr; i++)
546 get_fetch_map(ref_map, &fetch_refspec->items[i], &oref_tail, 1);
547 } else if (refmap.nr) {
548 die("--refmap option is only meaningful with command-line refspec(s)");
549 } else {
550 /* Use the defaults */
551 struct branch *branch = branch_get(NULL);
552 int has_merge = branch_has_merge_config(branch);
553 if (remote &&
554 (remote->fetch.nr ||
555 /* Note: has_merge implies non-NULL branch->remote_name */
556 (has_merge && !strcmp(branch->remote_name, remote->name)))) {
557 for (i = 0; i < remote->fetch.nr; i++) {
558 get_fetch_map(remote_refs, &remote->fetch.items[i], &tail, 0);
559 if (remote->fetch.items[i].dst &&
560 remote->fetch.items[i].dst[0])
561 *autotags = 1;
562 if (!i && !has_merge && ref_map &&
563 !remote->fetch.items[0].pattern)
564 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
567 * if the remote we're fetching from is the same
568 * as given in branch.<name>.remote, we add the
569 * ref given in branch.<name>.merge, too.
571 * Note: has_merge implies non-NULL branch->remote_name
573 if (has_merge &&
574 !strcmp(branch->remote_name, remote->name))
575 add_merge_config(&ref_map, remote_refs, branch, &tail);
576 } else if (!prefetch) {
577 ref_map = get_remote_ref(remote_refs, "HEAD");
578 if (!ref_map)
579 die(_("couldn't find remote ref HEAD"));
580 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
581 tail = &ref_map->next;
585 if (tags == TAGS_SET) {
586 struct refspec_item tag_refspec;
588 /* also fetch all tags */
589 refspec_item_init(&tag_refspec, TAG_REFSPEC, 0);
590 get_fetch_map(remote_refs, &tag_refspec, &tail, 0);
591 refspec_item_clear(&tag_refspec);
592 } else if (tags == TAGS_DEFAULT && *autotags) {
593 find_non_local_tags(remote_refs, NULL, &ref_map, &tail);
596 /* Now append any refs to be updated opportunistically: */
597 *tail = orefs;
598 for (rm = orefs; rm; rm = rm->next) {
599 rm->fetch_head_status = FETCH_HEAD_IGNORE;
600 tail = &rm->next;
604 * apply negative refspecs first, before we remove duplicates. This is
605 * necessary as negative refspecs might remove an otherwise conflicting
606 * duplicate.
608 if (rs->nr)
609 ref_map = apply_negative_refspecs(ref_map, rs);
610 else
611 ref_map = apply_negative_refspecs(ref_map, &remote->fetch);
613 ref_map = ref_remove_duplicates(ref_map);
615 for (rm = ref_map; rm; rm = rm->next) {
616 if (rm->peer_ref) {
617 const char *refname = rm->peer_ref->name;
618 struct refname_hash_entry *peer_item;
619 unsigned int hash = strhash(refname);
621 if (!existing_refs_populated) {
622 refname_hash_init(&existing_refs);
623 refs_for_each_ref(get_main_ref_store(the_repository),
624 add_one_refname,
625 &existing_refs);
626 existing_refs_populated = 1;
629 peer_item = hashmap_get_entry_from_hash(&existing_refs,
630 hash, refname,
631 struct refname_hash_entry, ent);
632 if (peer_item) {
633 struct object_id *old_oid = &peer_item->oid;
634 oidcpy(&rm->peer_ref->old_oid, old_oid);
638 if (existing_refs_populated)
639 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
641 return ref_map;
644 #define STORE_REF_ERROR_OTHER 1
645 #define STORE_REF_ERROR_DF_CONFLICT 2
647 static int s_update_ref(const char *action,
648 struct ref *ref,
649 struct ref_transaction *transaction,
650 int check_old)
652 char *msg;
653 char *rla = getenv("GIT_REFLOG_ACTION");
654 struct ref_transaction *our_transaction = NULL;
655 struct strbuf err = STRBUF_INIT;
656 int ret;
658 if (dry_run)
659 return 0;
660 if (!rla)
661 rla = default_rla.buf;
662 msg = xstrfmt("%s: %s", rla, action);
665 * If no transaction was passed to us, we manage the transaction
666 * ourselves. Otherwise, we trust the caller to handle the transaction
667 * lifecycle.
669 if (!transaction) {
670 transaction = our_transaction = ref_store_transaction_begin(get_main_ref_store(the_repository),
671 &err);
672 if (!transaction) {
673 ret = STORE_REF_ERROR_OTHER;
674 goto out;
678 ret = ref_transaction_update(transaction, ref->name, &ref->new_oid,
679 check_old ? &ref->old_oid : NULL,
680 NULL, NULL, 0, msg, &err);
681 if (ret) {
682 ret = STORE_REF_ERROR_OTHER;
683 goto out;
686 if (our_transaction) {
687 switch (ref_transaction_commit(our_transaction, &err)) {
688 case 0:
689 break;
690 case TRANSACTION_NAME_CONFLICT:
691 ret = STORE_REF_ERROR_DF_CONFLICT;
692 goto out;
693 default:
694 ret = STORE_REF_ERROR_OTHER;
695 goto out;
699 out:
700 ref_transaction_free(our_transaction);
701 if (ret)
702 error("%s", err.buf);
703 strbuf_release(&err);
704 free(msg);
705 return ret;
708 static int refcol_width(const struct ref *ref_map, int compact_format)
710 const struct ref *ref;
711 int max, width = 10;
713 max = term_columns();
714 if (compact_format)
715 max = max * 2 / 3;
717 for (ref = ref_map; ref; ref = ref->next) {
718 int rlen, llen = 0, len;
720 if (ref->status == REF_STATUS_REJECT_SHALLOW ||
721 !ref->peer_ref ||
722 !strcmp(ref->name, "HEAD"))
723 continue;
725 /* uptodate lines are only shown on high verbosity level */
726 if (verbosity <= 0 && oideq(&ref->peer_ref->old_oid, &ref->old_oid))
727 continue;
729 rlen = utf8_strwidth(prettify_refname(ref->name));
730 if (!compact_format)
731 llen = utf8_strwidth(prettify_refname(ref->peer_ref->name));
734 * rough estimation to see if the output line is too long and
735 * should not be counted (we can't do precise calculation
736 * anyway because we don't know if the error explanation part
737 * will be printed in update_local_ref)
739 len = 21 /* flag and summary */ + rlen + 4 /* -> */ + llen;
740 if (len >= max)
741 continue;
743 if (width < rlen)
744 width = rlen;
747 return width;
750 static void display_state_init(struct display_state *display_state, struct ref *ref_map,
751 const char *raw_url, enum display_format format)
753 int i;
755 memset(display_state, 0, sizeof(*display_state));
756 strbuf_init(&display_state->buf, 0);
757 display_state->format = format;
759 if (raw_url)
760 display_state->url = transport_anonymize_url(raw_url);
761 else
762 display_state->url = xstrdup("foreign");
764 display_state->url_len = strlen(display_state->url);
765 for (i = display_state->url_len - 1; display_state->url[i] == '/' && 0 <= i; i--)
767 display_state->url_len = i + 1;
768 if (4 < i && !strncmp(".git", display_state->url + i - 3, 4))
769 display_state->url_len = i - 3;
771 if (verbosity < 0)
772 return;
774 switch (display_state->format) {
775 case DISPLAY_FORMAT_FULL:
776 case DISPLAY_FORMAT_COMPACT:
777 display_state->refcol_width = refcol_width(ref_map,
778 display_state->format == DISPLAY_FORMAT_COMPACT);
779 break;
780 case DISPLAY_FORMAT_PORCELAIN:
781 /* We don't need to precompute anything here. */
782 break;
783 default:
784 BUG("unexpected display format %d", display_state->format);
788 static void display_state_release(struct display_state *display_state)
790 strbuf_release(&display_state->buf);
791 free(display_state->url);
794 static void print_remote_to_local(struct display_state *display_state,
795 const char *remote, const char *local)
797 strbuf_addf(&display_state->buf, "%-*s -> %s",
798 display_state->refcol_width, remote, local);
801 static int find_and_replace(struct strbuf *haystack,
802 const char *needle,
803 const char *placeholder)
805 const char *p = NULL;
806 int plen, nlen;
808 nlen = strlen(needle);
809 if (ends_with(haystack->buf, needle))
810 p = haystack->buf + haystack->len - nlen;
811 else
812 p = strstr(haystack->buf, needle);
813 if (!p)
814 return 0;
816 if (p > haystack->buf && p[-1] != '/')
817 return 0;
819 plen = strlen(p);
820 if (plen > nlen && p[nlen] != '/')
821 return 0;
823 strbuf_splice(haystack, p - haystack->buf, nlen,
824 placeholder, strlen(placeholder));
825 return 1;
828 static void print_compact(struct display_state *display_state,
829 const char *remote, const char *local)
831 struct strbuf r = STRBUF_INIT;
832 struct strbuf l = STRBUF_INIT;
834 if (!strcmp(remote, local)) {
835 strbuf_addf(&display_state->buf, "%-*s -> *", display_state->refcol_width, remote);
836 return;
839 strbuf_addstr(&r, remote);
840 strbuf_addstr(&l, local);
842 if (!find_and_replace(&r, local, "*"))
843 find_and_replace(&l, remote, "*");
844 print_remote_to_local(display_state, r.buf, l.buf);
846 strbuf_release(&r);
847 strbuf_release(&l);
850 static void display_ref_update(struct display_state *display_state, char code,
851 const char *summary, const char *error,
852 const char *remote, const char *local,
853 const struct object_id *old_oid,
854 const struct object_id *new_oid,
855 int summary_width)
857 FILE *f = stderr;
859 if (verbosity < 0)
860 return;
862 strbuf_reset(&display_state->buf);
864 switch (display_state->format) {
865 case DISPLAY_FORMAT_FULL:
866 case DISPLAY_FORMAT_COMPACT: {
867 int width;
869 if (!display_state->shown_url) {
870 strbuf_addf(&display_state->buf, _("From %.*s\n"),
871 display_state->url_len, display_state->url);
872 display_state->shown_url = 1;
875 width = (summary_width + strlen(summary) - gettext_width(summary));
876 remote = prettify_refname(remote);
877 local = prettify_refname(local);
879 strbuf_addf(&display_state->buf, " %c %-*s ", code, width, summary);
881 if (display_state->format != DISPLAY_FORMAT_COMPACT)
882 print_remote_to_local(display_state, remote, local);
883 else
884 print_compact(display_state, remote, local);
886 if (error)
887 strbuf_addf(&display_state->buf, " (%s)", error);
889 break;
891 case DISPLAY_FORMAT_PORCELAIN:
892 strbuf_addf(&display_state->buf, "%c %s %s %s", code,
893 oid_to_hex(old_oid), oid_to_hex(new_oid), local);
894 f = stdout;
895 break;
896 default:
897 BUG("unexpected display format %d", display_state->format);
899 strbuf_addch(&display_state->buf, '\n');
901 fputs(display_state->buf.buf, f);
904 static int update_local_ref(struct ref *ref,
905 struct ref_transaction *transaction,
906 struct display_state *display_state,
907 const struct ref *remote_ref,
908 int summary_width,
909 const struct fetch_config *config)
911 struct commit *current = NULL, *updated;
912 int fast_forward = 0;
914 if (!repo_has_object_file(the_repository, &ref->new_oid))
915 die(_("object %s not found"), oid_to_hex(&ref->new_oid));
917 if (oideq(&ref->old_oid, &ref->new_oid)) {
918 if (verbosity > 0)
919 display_ref_update(display_state, '=', _("[up to date]"), NULL,
920 remote_ref->name, ref->name,
921 &ref->old_oid, &ref->new_oid, summary_width);
922 return 0;
925 if (!update_head_ok &&
926 !is_null_oid(&ref->old_oid) &&
927 branch_checked_out(ref->name)) {
929 * If this is the head, and it's not okay to update
930 * the head, and the old value of the head isn't empty...
932 display_ref_update(display_state, '!', _("[rejected]"),
933 _("can't fetch into checked-out branch"),
934 remote_ref->name, ref->name,
935 &ref->old_oid, &ref->new_oid, summary_width);
936 return 1;
939 if (!is_null_oid(&ref->old_oid) &&
940 starts_with(ref->name, "refs/tags/")) {
941 if (force || ref->force) {
942 int r;
943 r = s_update_ref("updating tag", ref, transaction, 0);
944 display_ref_update(display_state, r ? '!' : 't', _("[tag update]"),
945 r ? _("unable to update local ref") : NULL,
946 remote_ref->name, ref->name,
947 &ref->old_oid, &ref->new_oid, summary_width);
948 return r;
949 } else {
950 display_ref_update(display_state, '!', _("[rejected]"),
951 _("would clobber existing tag"),
952 remote_ref->name, ref->name,
953 &ref->old_oid, &ref->new_oid, summary_width);
954 return 1;
958 current = lookup_commit_reference_gently(the_repository,
959 &ref->old_oid, 1);
960 updated = lookup_commit_reference_gently(the_repository,
961 &ref->new_oid, 1);
962 if (!current || !updated) {
963 const char *msg;
964 const char *what;
965 int r;
967 * Nicely describe the new ref we're fetching.
968 * Base this on the remote's ref name, as it's
969 * more likely to follow a standard layout.
971 if (starts_with(remote_ref->name, "refs/tags/")) {
972 msg = "storing tag";
973 what = _("[new tag]");
974 } else if (starts_with(remote_ref->name, "refs/heads/")) {
975 msg = "storing head";
976 what = _("[new branch]");
977 } else {
978 msg = "storing ref";
979 what = _("[new ref]");
982 r = s_update_ref(msg, ref, transaction, 0);
983 display_ref_update(display_state, r ? '!' : '*', what,
984 r ? _("unable to update local ref") : NULL,
985 remote_ref->name, ref->name,
986 &ref->old_oid, &ref->new_oid, summary_width);
987 return r;
990 if (config->show_forced_updates) {
991 uint64_t t_before = getnanotime();
992 fast_forward = repo_in_merge_bases(the_repository, current,
993 updated);
994 if (fast_forward < 0)
995 exit(128);
996 forced_updates_ms += (getnanotime() - t_before) / 1000000;
997 } else {
998 fast_forward = 1;
1001 if (fast_forward) {
1002 struct strbuf quickref = STRBUF_INIT;
1003 int r;
1005 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
1006 strbuf_addstr(&quickref, "..");
1007 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
1008 r = s_update_ref("fast-forward", ref, transaction, 1);
1009 display_ref_update(display_state, r ? '!' : ' ', quickref.buf,
1010 r ? _("unable to update local ref") : NULL,
1011 remote_ref->name, ref->name,
1012 &ref->old_oid, &ref->new_oid, summary_width);
1013 strbuf_release(&quickref);
1014 return r;
1015 } else if (force || ref->force) {
1016 struct strbuf quickref = STRBUF_INIT;
1017 int r;
1018 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
1019 strbuf_addstr(&quickref, "...");
1020 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
1021 r = s_update_ref("forced-update", ref, transaction, 1);
1022 display_ref_update(display_state, r ? '!' : '+', quickref.buf,
1023 r ? _("unable to update local ref") : _("forced update"),
1024 remote_ref->name, ref->name,
1025 &ref->old_oid, &ref->new_oid, summary_width);
1026 strbuf_release(&quickref);
1027 return r;
1028 } else {
1029 display_ref_update(display_state, '!', _("[rejected]"), _("non-fast-forward"),
1030 remote_ref->name, ref->name,
1031 &ref->old_oid, &ref->new_oid, summary_width);
1032 return 1;
1036 static const struct object_id *iterate_ref_map(void *cb_data)
1038 struct ref **rm = cb_data;
1039 struct ref *ref = *rm;
1041 while (ref && ref->status == REF_STATUS_REJECT_SHALLOW)
1042 ref = ref->next;
1043 if (!ref)
1044 return NULL;
1045 *rm = ref->next;
1046 return &ref->old_oid;
1049 struct fetch_head {
1050 FILE *fp;
1051 struct strbuf buf;
1054 static int open_fetch_head(struct fetch_head *fetch_head)
1056 const char *filename = git_path_fetch_head(the_repository);
1058 if (write_fetch_head) {
1059 fetch_head->fp = fopen(filename, "a");
1060 if (!fetch_head->fp)
1061 return error_errno(_("cannot open '%s'"), filename);
1062 strbuf_init(&fetch_head->buf, 0);
1063 } else {
1064 fetch_head->fp = NULL;
1067 return 0;
1070 static void append_fetch_head(struct fetch_head *fetch_head,
1071 const struct object_id *old_oid,
1072 enum fetch_head_status fetch_head_status,
1073 const char *note,
1074 const char *url, size_t url_len)
1076 char old_oid_hex[GIT_MAX_HEXSZ + 1];
1077 const char *merge_status_marker;
1078 size_t i;
1080 if (!fetch_head->fp)
1081 return;
1083 switch (fetch_head_status) {
1084 case FETCH_HEAD_NOT_FOR_MERGE:
1085 merge_status_marker = "not-for-merge";
1086 break;
1087 case FETCH_HEAD_MERGE:
1088 merge_status_marker = "";
1089 break;
1090 default:
1091 /* do not write anything to FETCH_HEAD */
1092 return;
1095 strbuf_addf(&fetch_head->buf, "%s\t%s\t%s",
1096 oid_to_hex_r(old_oid_hex, old_oid), merge_status_marker, note);
1097 for (i = 0; i < url_len; ++i)
1098 if ('\n' == url[i])
1099 strbuf_addstr(&fetch_head->buf, "\\n");
1100 else
1101 strbuf_addch(&fetch_head->buf, url[i]);
1102 strbuf_addch(&fetch_head->buf, '\n');
1105 * When using an atomic fetch, we do not want to update FETCH_HEAD if
1106 * any of the reference updates fails. We thus have to write all
1107 * updates to a buffer first and only commit it as soon as all
1108 * references have been successfully updated.
1110 if (!atomic_fetch) {
1111 strbuf_write(&fetch_head->buf, fetch_head->fp);
1112 strbuf_reset(&fetch_head->buf);
1116 static void commit_fetch_head(struct fetch_head *fetch_head)
1118 if (!fetch_head->fp || !atomic_fetch)
1119 return;
1120 strbuf_write(&fetch_head->buf, fetch_head->fp);
1123 static void close_fetch_head(struct fetch_head *fetch_head)
1125 if (!fetch_head->fp)
1126 return;
1128 fclose(fetch_head->fp);
1129 strbuf_release(&fetch_head->buf);
1132 static const char warn_show_forced_updates[] =
1133 N_("fetch normally indicates which branches had a forced update,\n"
1134 "but that check has been disabled; to re-enable, use '--show-forced-updates'\n"
1135 "flag or run 'git config fetch.showForcedUpdates true'");
1136 static const char warn_time_show_forced_updates[] =
1137 N_("it took %.2f seconds to check forced updates; you can use\n"
1138 "'--no-show-forced-updates' or run 'git config fetch.showForcedUpdates false'\n"
1139 "to avoid this check\n");
1141 static int store_updated_refs(struct display_state *display_state,
1142 const char *remote_name,
1143 int connectivity_checked,
1144 struct ref_transaction *transaction, struct ref *ref_map,
1145 struct fetch_head *fetch_head,
1146 const struct fetch_config *config)
1148 int rc = 0;
1149 struct strbuf note = STRBUF_INIT;
1150 const char *what, *kind;
1151 struct ref *rm;
1152 int want_status;
1153 int summary_width = 0;
1155 if (verbosity >= 0)
1156 summary_width = transport_summary_width(ref_map);
1158 if (!connectivity_checked) {
1159 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1161 opt.exclude_hidden_refs_section = "fetch";
1162 rm = ref_map;
1163 if (check_connected(iterate_ref_map, &rm, &opt)) {
1164 rc = error(_("%s did not send all necessary objects"),
1165 display_state->url);
1166 goto abort;
1171 * We do a pass for each fetch_head_status type in their enum order, so
1172 * merged entries are written before not-for-merge. That lets readers
1173 * use FETCH_HEAD as a refname to refer to the ref to be merged.
1175 for (want_status = FETCH_HEAD_MERGE;
1176 want_status <= FETCH_HEAD_IGNORE;
1177 want_status++) {
1178 for (rm = ref_map; rm; rm = rm->next) {
1179 struct ref *ref = NULL;
1181 if (rm->status == REF_STATUS_REJECT_SHALLOW) {
1182 if (want_status == FETCH_HEAD_MERGE)
1183 warning(_("rejected %s because shallow roots are not allowed to be updated"),
1184 rm->peer_ref ? rm->peer_ref->name : rm->name);
1185 continue;
1189 * When writing FETCH_HEAD we need to determine whether
1190 * we already have the commit or not. If not, then the
1191 * reference is not for merge and needs to be written
1192 * to the reflog after other commits which we already
1193 * have. We're not interested in this property though
1194 * in case FETCH_HEAD is not to be updated, so we can
1195 * skip the classification in that case.
1197 if (fetch_head->fp) {
1198 struct commit *commit = NULL;
1201 * References in "refs/tags/" are often going to point
1202 * to annotated tags, which are not part of the
1203 * commit-graph. We thus only try to look up refs in
1204 * the graph which are not in that namespace to not
1205 * regress performance in repositories with many
1206 * annotated tags.
1208 if (!starts_with(rm->name, "refs/tags/"))
1209 commit = lookup_commit_in_graph(the_repository, &rm->old_oid);
1210 if (!commit) {
1211 commit = lookup_commit_reference_gently(the_repository,
1212 &rm->old_oid,
1214 if (!commit)
1215 rm->fetch_head_status = FETCH_HEAD_NOT_FOR_MERGE;
1219 if (rm->fetch_head_status != want_status)
1220 continue;
1222 if (rm->peer_ref) {
1223 ref = alloc_ref(rm->peer_ref->name);
1224 oidcpy(&ref->old_oid, &rm->peer_ref->old_oid);
1225 oidcpy(&ref->new_oid, &rm->old_oid);
1226 ref->force = rm->peer_ref->force;
1229 if (config->recurse_submodules != RECURSE_SUBMODULES_OFF &&
1230 (!rm->peer_ref || !oideq(&ref->old_oid, &ref->new_oid))) {
1231 check_for_new_submodule_commits(&rm->old_oid);
1234 if (!strcmp(rm->name, "HEAD")) {
1235 kind = "";
1236 what = "";
1237 } else if (skip_prefix(rm->name, "refs/heads/", &what)) {
1238 kind = "branch";
1239 } else if (skip_prefix(rm->name, "refs/tags/", &what)) {
1240 kind = "tag";
1241 } else if (skip_prefix(rm->name, "refs/remotes/", &what)) {
1242 kind = "remote-tracking branch";
1243 } else {
1244 kind = "";
1245 what = rm->name;
1248 strbuf_reset(&note);
1249 if (*what) {
1250 if (*kind)
1251 strbuf_addf(&note, "%s ", kind);
1252 strbuf_addf(&note, "'%s' of ", what);
1255 append_fetch_head(fetch_head, &rm->old_oid,
1256 rm->fetch_head_status,
1257 note.buf, display_state->url,
1258 display_state->url_len);
1260 if (ref) {
1261 rc |= update_local_ref(ref, transaction, display_state,
1262 rm, summary_width, config);
1263 free(ref);
1264 } else if (write_fetch_head || dry_run) {
1266 * Display fetches written to FETCH_HEAD (or
1267 * would be written to FETCH_HEAD, if --dry-run
1268 * is set).
1270 display_ref_update(display_state, '*',
1271 *kind ? kind : "branch", NULL,
1272 rm->name,
1273 "FETCH_HEAD",
1274 &rm->new_oid, &rm->old_oid,
1275 summary_width);
1280 if (rc & STORE_REF_ERROR_DF_CONFLICT)
1281 error(_("some local refs could not be updated; try running\n"
1282 " 'git remote prune %s' to remove any old, conflicting "
1283 "branches"), remote_name);
1285 if (advice_enabled(ADVICE_FETCH_SHOW_FORCED_UPDATES)) {
1286 if (!config->show_forced_updates) {
1287 warning(_(warn_show_forced_updates));
1288 } else if (forced_updates_ms > FORCED_UPDATES_DELAY_WARNING_IN_MS) {
1289 warning(_(warn_time_show_forced_updates),
1290 forced_updates_ms / 1000.0);
1294 abort:
1295 strbuf_release(&note);
1296 return rc;
1300 * We would want to bypass the object transfer altogether if
1301 * everything we are going to fetch already exists and is connected
1302 * locally.
1304 static int check_exist_and_connected(struct ref *ref_map)
1306 struct ref *rm = ref_map;
1307 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1308 struct ref *r;
1311 * If we are deepening a shallow clone we already have these
1312 * objects reachable. Running rev-list here will return with
1313 * a good (0) exit status and we'll bypass the fetch that we
1314 * really need to perform. Claiming failure now will ensure
1315 * we perform the network exchange to deepen our history.
1317 if (deepen)
1318 return -1;
1321 * Similarly, if we need to refetch, we always want to perform a full
1322 * fetch ignoring existing objects.
1324 if (refetch)
1325 return -1;
1329 * check_connected() allows objects to merely be promised, but
1330 * we need all direct targets to exist.
1332 for (r = rm; r; r = r->next) {
1333 if (!repo_has_object_file_with_flags(the_repository, &r->old_oid,
1334 OBJECT_INFO_SKIP_FETCH_OBJECT))
1335 return -1;
1338 opt.quiet = 1;
1339 opt.exclude_hidden_refs_section = "fetch";
1340 return check_connected(iterate_ref_map, &rm, &opt);
1343 static int fetch_and_consume_refs(struct display_state *display_state,
1344 struct transport *transport,
1345 struct ref_transaction *transaction,
1346 struct ref *ref_map,
1347 struct fetch_head *fetch_head,
1348 const struct fetch_config *config)
1350 int connectivity_checked = 1;
1351 int ret;
1354 * We don't need to perform a fetch in case we can already satisfy all
1355 * refs.
1357 ret = check_exist_and_connected(ref_map);
1358 if (ret) {
1359 trace2_region_enter("fetch", "fetch_refs", the_repository);
1360 ret = transport_fetch_refs(transport, ref_map);
1361 trace2_region_leave("fetch", "fetch_refs", the_repository);
1362 if (ret)
1363 goto out;
1364 connectivity_checked = transport->smart_options ?
1365 transport->smart_options->connectivity_checked : 0;
1368 trace2_region_enter("fetch", "consume_refs", the_repository);
1369 ret = store_updated_refs(display_state, transport->remote->name,
1370 connectivity_checked, transaction, ref_map,
1371 fetch_head, config);
1372 trace2_region_leave("fetch", "consume_refs", the_repository);
1374 out:
1375 transport_unlock_pack(transport, 0);
1376 return ret;
1379 static int prune_refs(struct display_state *display_state,
1380 struct refspec *rs,
1381 struct ref_transaction *transaction,
1382 struct ref *ref_map)
1384 int result = 0;
1385 struct ref *ref, *stale_refs = get_stale_heads(rs, ref_map);
1386 struct strbuf err = STRBUF_INIT;
1387 const char *dangling_msg = dry_run
1388 ? _(" (%s will become dangling)")
1389 : _(" (%s has become dangling)");
1391 if (!dry_run) {
1392 if (transaction) {
1393 for (ref = stale_refs; ref; ref = ref->next) {
1394 result = ref_transaction_delete(transaction, ref->name, NULL,
1395 NULL, 0, "fetch: prune", &err);
1396 if (result)
1397 goto cleanup;
1399 } else {
1400 struct string_list refnames = STRING_LIST_INIT_NODUP;
1402 for (ref = stale_refs; ref; ref = ref->next)
1403 string_list_append(&refnames, ref->name);
1405 result = refs_delete_refs(get_main_ref_store(the_repository),
1406 "fetch: prune", &refnames,
1408 string_list_clear(&refnames, 0);
1412 if (verbosity >= 0) {
1413 int summary_width = transport_summary_width(stale_refs);
1415 for (ref = stale_refs; ref; ref = ref->next) {
1416 display_ref_update(display_state, '-', _("[deleted]"), NULL,
1417 _("(none)"), ref->name,
1418 &ref->new_oid, &ref->old_oid,
1419 summary_width);
1420 refs_warn_dangling_symref(get_main_ref_store(the_repository),
1421 stderr, dangling_msg, ref->name);
1425 cleanup:
1426 strbuf_release(&err);
1427 free_refs(stale_refs);
1428 return result;
1431 static void check_not_current_branch(struct ref *ref_map)
1433 const char *path;
1434 for (; ref_map; ref_map = ref_map->next)
1435 if (ref_map->peer_ref &&
1436 starts_with(ref_map->peer_ref->name, "refs/heads/") &&
1437 (path = branch_checked_out(ref_map->peer_ref->name)))
1438 die(_("refusing to fetch into branch '%s' "
1439 "checked out at '%s'"),
1440 ref_map->peer_ref->name, path);
1443 static int truncate_fetch_head(void)
1445 const char *filename = git_path_fetch_head(the_repository);
1446 FILE *fp = fopen_for_writing(filename);
1448 if (!fp)
1449 return error_errno(_("cannot open '%s'"), filename);
1450 fclose(fp);
1451 return 0;
1454 static void set_option(struct transport *transport, const char *name, const char *value)
1456 int r = transport_set_option(transport, name, value);
1457 if (r < 0)
1458 die(_("option \"%s\" value \"%s\" is not valid for %s"),
1459 name, value, transport->url);
1460 if (r > 0)
1461 warning(_("option \"%s\" is ignored for %s"),
1462 name, transport->url);
1466 static int add_oid(const char *refname UNUSED,
1467 const char *referent UNUSED,
1468 const struct object_id *oid,
1469 int flags UNUSED, void *cb_data)
1471 struct oid_array *oids = cb_data;
1473 oid_array_append(oids, oid);
1474 return 0;
1477 static void add_negotiation_tips(struct git_transport_options *smart_options)
1479 struct oid_array *oids = xcalloc(1, sizeof(*oids));
1480 int i;
1482 for (i = 0; i < negotiation_tip.nr; i++) {
1483 const char *s = negotiation_tip.items[i].string;
1484 int old_nr;
1485 if (!has_glob_specials(s)) {
1486 struct object_id oid;
1487 if (repo_get_oid(the_repository, s, &oid))
1488 die(_("%s is not a valid object"), s);
1489 if (!has_object(the_repository, &oid, 0))
1490 die(_("the object %s does not exist"), s);
1491 oid_array_append(oids, &oid);
1492 continue;
1494 old_nr = oids->nr;
1495 refs_for_each_glob_ref(get_main_ref_store(the_repository),
1496 add_oid, s, oids);
1497 if (old_nr == oids->nr)
1498 warning("ignoring --negotiation-tip=%s because it does not match any refs",
1501 smart_options->negotiation_tips = oids;
1504 static struct transport *prepare_transport(struct remote *remote, int deepen)
1506 struct transport *transport;
1508 transport = transport_get(remote, NULL);
1509 transport_set_verbosity(transport, verbosity, progress);
1510 transport->family = family;
1511 if (upload_pack)
1512 set_option(transport, TRANS_OPT_UPLOADPACK, upload_pack);
1513 if (keep)
1514 set_option(transport, TRANS_OPT_KEEP, "yes");
1515 if (depth)
1516 set_option(transport, TRANS_OPT_DEPTH, depth);
1517 if (deepen && deepen_since)
1518 set_option(transport, TRANS_OPT_DEEPEN_SINCE, deepen_since);
1519 if (deepen && deepen_not.nr)
1520 set_option(transport, TRANS_OPT_DEEPEN_NOT,
1521 (const char *)&deepen_not);
1522 if (deepen_relative)
1523 set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, "yes");
1524 if (update_shallow)
1525 set_option(transport, TRANS_OPT_UPDATE_SHALLOW, "yes");
1526 if (refetch)
1527 set_option(transport, TRANS_OPT_REFETCH, "yes");
1528 if (filter_options.choice) {
1529 const char *spec =
1530 expand_list_objects_filter_spec(&filter_options);
1531 set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER, spec);
1532 set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1534 if (negotiation_tip.nr) {
1535 if (transport->smart_options)
1536 add_negotiation_tips(transport->smart_options);
1537 else
1538 warning("ignoring --negotiation-tip because the protocol does not support it");
1540 return transport;
1543 static int backfill_tags(struct display_state *display_state,
1544 struct transport *transport,
1545 struct ref_transaction *transaction,
1546 struct ref *ref_map,
1547 struct fetch_head *fetch_head,
1548 const struct fetch_config *config)
1550 int retcode, cannot_reuse;
1553 * Once we have set TRANS_OPT_DEEPEN_SINCE, we can't unset it
1554 * when remote helper is used (setting it to an empty string
1555 * is not unsetting). We could extend the remote helper
1556 * protocol for that, but for now, just force a new connection
1557 * without deepen-since. Similar story for deepen-not.
1559 cannot_reuse = transport->cannot_reuse ||
1560 deepen_since || deepen_not.nr;
1561 if (cannot_reuse) {
1562 gsecondary = prepare_transport(transport->remote, 0);
1563 transport = gsecondary;
1566 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
1567 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
1568 transport_set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, NULL);
1569 retcode = fetch_and_consume_refs(display_state, transport, transaction, ref_map,
1570 fetch_head, config);
1572 if (gsecondary) {
1573 transport_disconnect(gsecondary);
1574 gsecondary = NULL;
1577 return retcode;
1580 static int do_fetch(struct transport *transport,
1581 struct refspec *rs,
1582 const struct fetch_config *config)
1584 struct ref_transaction *transaction = NULL;
1585 struct ref *ref_map = NULL;
1586 struct display_state display_state = { 0 };
1587 int autotags = (transport->remote->fetch_tags == 1);
1588 int retcode = 0;
1589 const struct ref *remote_refs;
1590 struct transport_ls_refs_options transport_ls_refs_options =
1591 TRANSPORT_LS_REFS_OPTIONS_INIT;
1592 int must_list_refs = 1;
1593 struct fetch_head fetch_head = { 0 };
1594 struct strbuf err = STRBUF_INIT;
1596 if (tags == TAGS_DEFAULT) {
1597 if (transport->remote->fetch_tags == 2)
1598 tags = TAGS_SET;
1599 if (transport->remote->fetch_tags == -1)
1600 tags = TAGS_UNSET;
1603 /* if not appending, truncate FETCH_HEAD */
1604 if (!append && write_fetch_head) {
1605 retcode = truncate_fetch_head();
1606 if (retcode)
1607 goto cleanup;
1610 if (rs->nr) {
1611 int i;
1613 refspec_ref_prefixes(rs, &transport_ls_refs_options.ref_prefixes);
1616 * We can avoid listing refs if all of them are exact
1617 * OIDs
1619 must_list_refs = 0;
1620 for (i = 0; i < rs->nr; i++) {
1621 if (!rs->items[i].exact_sha1) {
1622 must_list_refs = 1;
1623 break;
1626 } else {
1627 struct branch *branch = branch_get(NULL);
1629 if (transport->remote->fetch.nr)
1630 refspec_ref_prefixes(&transport->remote->fetch,
1631 &transport_ls_refs_options.ref_prefixes);
1632 if (branch_has_merge_config(branch) &&
1633 !strcmp(branch->remote_name, transport->remote->name)) {
1634 int i;
1635 for (i = 0; i < branch->merge_nr; i++) {
1636 strvec_push(&transport_ls_refs_options.ref_prefixes,
1637 branch->merge[i]->src);
1642 if (tags == TAGS_SET || tags == TAGS_DEFAULT) {
1643 must_list_refs = 1;
1644 if (transport_ls_refs_options.ref_prefixes.nr)
1645 strvec_push(&transport_ls_refs_options.ref_prefixes,
1646 "refs/tags/");
1649 if (must_list_refs) {
1650 trace2_region_enter("fetch", "remote_refs", the_repository);
1651 remote_refs = transport_get_remote_refs(transport,
1652 &transport_ls_refs_options);
1653 trace2_region_leave("fetch", "remote_refs", the_repository);
1654 } else
1655 remote_refs = NULL;
1657 transport_ls_refs_options_release(&transport_ls_refs_options);
1659 ref_map = get_ref_map(transport->remote, remote_refs, rs,
1660 tags, &autotags);
1661 if (!update_head_ok)
1662 check_not_current_branch(ref_map);
1664 retcode = open_fetch_head(&fetch_head);
1665 if (retcode)
1666 goto cleanup;
1668 display_state_init(&display_state, ref_map, transport->url,
1669 config->display_format);
1671 if (atomic_fetch) {
1672 transaction = ref_store_transaction_begin(get_main_ref_store(the_repository),
1673 &err);
1674 if (!transaction) {
1675 retcode = -1;
1676 goto cleanup;
1680 if (tags == TAGS_DEFAULT && autotags)
1681 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1682 if (prune) {
1684 * We only prune based on refspecs specified
1685 * explicitly (via command line or configuration); we
1686 * don't care whether --tags was specified.
1688 if (rs->nr) {
1689 retcode = prune_refs(&display_state, rs, transaction, ref_map);
1690 } else {
1691 retcode = prune_refs(&display_state, &transport->remote->fetch,
1692 transaction, ref_map);
1694 if (retcode != 0)
1695 retcode = 1;
1698 if (fetch_and_consume_refs(&display_state, transport, transaction, ref_map,
1699 &fetch_head, config)) {
1700 retcode = 1;
1701 goto cleanup;
1705 * If neither --no-tags nor --tags was specified, do automated tag
1706 * following.
1708 if (tags == TAGS_DEFAULT && autotags) {
1709 struct ref *tags_ref_map = NULL, **tail = &tags_ref_map;
1711 find_non_local_tags(remote_refs, transaction, &tags_ref_map, &tail);
1712 if (tags_ref_map) {
1714 * If backfilling of tags fails then we want to tell
1715 * the user so, but we have to continue regardless to
1716 * populate upstream information of the references we
1717 * have already fetched above. The exception though is
1718 * when `--atomic` is passed: in that case we'll abort
1719 * the transaction and don't commit anything.
1721 if (backfill_tags(&display_state, transport, transaction, tags_ref_map,
1722 &fetch_head, config))
1723 retcode = 1;
1726 free_refs(tags_ref_map);
1729 if (transaction) {
1730 if (retcode)
1731 goto cleanup;
1733 retcode = ref_transaction_commit(transaction, &err);
1734 if (retcode)
1735 goto cleanup;
1738 commit_fetch_head(&fetch_head);
1740 if (set_upstream) {
1741 struct branch *branch = branch_get("HEAD");
1742 struct ref *rm;
1743 struct ref *source_ref = NULL;
1746 * We're setting the upstream configuration for the
1747 * current branch. The relevant upstream is the
1748 * fetched branch that is meant to be merged with the
1749 * current one, i.e. the one fetched to FETCH_HEAD.
1751 * When there are several such branches, consider the
1752 * request ambiguous and err on the safe side by doing
1753 * nothing and just emit a warning.
1755 for (rm = ref_map; rm; rm = rm->next) {
1756 if (!rm->peer_ref) {
1757 if (source_ref) {
1758 warning(_("multiple branches detected, incompatible with --set-upstream"));
1759 goto cleanup;
1760 } else {
1761 source_ref = rm;
1765 if (source_ref) {
1766 if (!branch) {
1767 const char *shortname = source_ref->name;
1768 skip_prefix(shortname, "refs/heads/", &shortname);
1770 warning(_("could not set upstream of HEAD to '%s' from '%s' when "
1771 "it does not point to any branch."),
1772 shortname, transport->remote->name);
1773 goto cleanup;
1776 if (!strcmp(source_ref->name, "HEAD") ||
1777 starts_with(source_ref->name, "refs/heads/"))
1778 install_branch_config(0,
1779 branch->name,
1780 transport->remote->name,
1781 source_ref->name);
1782 else if (starts_with(source_ref->name, "refs/remotes/"))
1783 warning(_("not setting upstream for a remote remote-tracking branch"));
1784 else if (starts_with(source_ref->name, "refs/tags/"))
1785 warning(_("not setting upstream for a remote tag"));
1786 else
1787 warning(_("unknown branch type"));
1788 } else {
1789 warning(_("no source branch found;\n"
1790 "you need to specify exactly one branch with the --set-upstream option"));
1794 cleanup:
1795 if (retcode) {
1796 if (err.len) {
1797 error("%s", err.buf);
1798 strbuf_reset(&err);
1800 if (transaction && ref_transaction_abort(transaction, &err) &&
1801 err.len)
1802 error("%s", err.buf);
1803 transaction = NULL;
1806 if (transaction)
1807 ref_transaction_free(transaction);
1808 display_state_release(&display_state);
1809 close_fetch_head(&fetch_head);
1810 strbuf_release(&err);
1811 free_refs(ref_map);
1812 return retcode;
1815 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
1817 struct string_list *list = priv;
1818 if (!remote->skip_default_update)
1819 string_list_append(list, remote->name);
1820 return 0;
1823 struct remote_group_data {
1824 const char *name;
1825 struct string_list *list;
1828 static int get_remote_group(const char *key, const char *value,
1829 const struct config_context *ctx UNUSED,
1830 void *priv)
1832 struct remote_group_data *g = priv;
1834 if (skip_prefix(key, "remotes.", &key) && !strcmp(key, g->name)) {
1835 /* split list by white space */
1836 while (*value) {
1837 size_t wordlen = strcspn(value, " \t\n");
1839 if (wordlen >= 1)
1840 string_list_append_nodup(g->list,
1841 xstrndup(value, wordlen));
1842 value += wordlen + (value[wordlen] != '\0');
1846 return 0;
1849 static int add_remote_or_group(const char *name, struct string_list *list)
1851 int prev_nr = list->nr;
1852 struct remote_group_data g;
1853 g.name = name; g.list = list;
1855 git_config(get_remote_group, &g);
1856 if (list->nr == prev_nr) {
1857 struct remote *remote = remote_get(name);
1858 if (!remote_is_configured(remote, 0))
1859 return 0;
1860 string_list_append(list, remote->name);
1862 return 1;
1865 static void add_options_to_argv(struct strvec *argv,
1866 const struct fetch_config *config)
1868 if (dry_run)
1869 strvec_push(argv, "--dry-run");
1870 if (prune != -1)
1871 strvec_push(argv, prune ? "--prune" : "--no-prune");
1872 if (prune_tags != -1)
1873 strvec_push(argv, prune_tags ? "--prune-tags" : "--no-prune-tags");
1874 if (update_head_ok)
1875 strvec_push(argv, "--update-head-ok");
1876 if (force)
1877 strvec_push(argv, "--force");
1878 if (keep)
1879 strvec_push(argv, "--keep");
1880 if (config->recurse_submodules == RECURSE_SUBMODULES_ON)
1881 strvec_push(argv, "--recurse-submodules");
1882 else if (config->recurse_submodules == RECURSE_SUBMODULES_OFF)
1883 strvec_push(argv, "--no-recurse-submodules");
1884 else if (config->recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND)
1885 strvec_push(argv, "--recurse-submodules=on-demand");
1886 if (tags == TAGS_SET)
1887 strvec_push(argv, "--tags");
1888 else if (tags == TAGS_UNSET)
1889 strvec_push(argv, "--no-tags");
1890 if (verbosity >= 2)
1891 strvec_push(argv, "-v");
1892 if (verbosity >= 1)
1893 strvec_push(argv, "-v");
1894 else if (verbosity < 0)
1895 strvec_push(argv, "-q");
1896 if (family == TRANSPORT_FAMILY_IPV4)
1897 strvec_push(argv, "--ipv4");
1898 else if (family == TRANSPORT_FAMILY_IPV6)
1899 strvec_push(argv, "--ipv6");
1900 if (!write_fetch_head)
1901 strvec_push(argv, "--no-write-fetch-head");
1902 if (config->display_format == DISPLAY_FORMAT_PORCELAIN)
1903 strvec_pushf(argv, "--porcelain");
1906 /* Fetch multiple remotes in parallel */
1908 struct parallel_fetch_state {
1909 const char **argv;
1910 struct string_list *remotes;
1911 int next, result;
1912 const struct fetch_config *config;
1915 static int fetch_next_remote(struct child_process *cp,
1916 struct strbuf *out UNUSED,
1917 void *cb, void **task_cb)
1919 struct parallel_fetch_state *state = cb;
1920 char *remote;
1922 if (state->next < 0 || state->next >= state->remotes->nr)
1923 return 0;
1925 remote = state->remotes->items[state->next++].string;
1926 *task_cb = remote;
1928 strvec_pushv(&cp->args, state->argv);
1929 strvec_push(&cp->args, remote);
1930 cp->git_cmd = 1;
1932 if (verbosity >= 0 && state->config->display_format != DISPLAY_FORMAT_PORCELAIN)
1933 printf(_("Fetching %s\n"), remote);
1935 return 1;
1938 static int fetch_failed_to_start(struct strbuf *out UNUSED,
1939 void *cb, void *task_cb)
1941 struct parallel_fetch_state *state = cb;
1942 const char *remote = task_cb;
1944 state->result = error(_("could not fetch %s"), remote);
1946 return 0;
1949 static int fetch_finished(int result, struct strbuf *out,
1950 void *cb, void *task_cb)
1952 struct parallel_fetch_state *state = cb;
1953 const char *remote = task_cb;
1955 if (result) {
1956 strbuf_addf(out, _("could not fetch '%s' (exit code: %d)\n"),
1957 remote, result);
1958 state->result = -1;
1961 return 0;
1964 static int fetch_multiple(struct string_list *list, int max_children,
1965 const struct fetch_config *config)
1967 int i, result = 0;
1968 struct strvec argv = STRVEC_INIT;
1970 if (!append && write_fetch_head) {
1971 int errcode = truncate_fetch_head();
1972 if (errcode)
1973 return errcode;
1977 * Cancel out the fetch.bundleURI config when running subprocesses,
1978 * to avoid fetching from the same bundle list multiple times.
1980 strvec_pushl(&argv, "-c", "fetch.bundleURI=",
1981 "fetch", "--append", "--no-auto-gc",
1982 "--no-write-commit-graph", NULL);
1983 add_options_to_argv(&argv, config);
1985 if (max_children != 1 && list->nr != 1) {
1986 struct parallel_fetch_state state = { argv.v, list, 0, 0, config };
1987 const struct run_process_parallel_opts opts = {
1988 .tr2_category = "fetch",
1989 .tr2_label = "parallel/fetch",
1991 .processes = max_children,
1993 .get_next_task = &fetch_next_remote,
1994 .start_failure = &fetch_failed_to_start,
1995 .task_finished = &fetch_finished,
1996 .data = &state,
1999 strvec_push(&argv, "--end-of-options");
2001 run_processes_parallel(&opts);
2002 result = state.result;
2003 } else
2004 for (i = 0; i < list->nr; i++) {
2005 const char *name = list->items[i].string;
2006 struct child_process cmd = CHILD_PROCESS_INIT;
2008 strvec_pushv(&cmd.args, argv.v);
2009 strvec_push(&cmd.args, name);
2010 if (verbosity >= 0 && config->display_format != DISPLAY_FORMAT_PORCELAIN)
2011 printf(_("Fetching %s\n"), name);
2012 cmd.git_cmd = 1;
2013 if (run_command(&cmd)) {
2014 error(_("could not fetch %s"), name);
2015 result = 1;
2019 strvec_clear(&argv);
2020 return !!result;
2024 * Fetching from the promisor remote should use the given filter-spec
2025 * or inherit the default filter-spec from the config.
2027 static inline void fetch_one_setup_partial(struct remote *remote)
2030 * Explicit --no-filter argument overrides everything, regardless
2031 * of any prior partial clones and fetches.
2033 if (filter_options.no_filter)
2034 return;
2037 * If no prior partial clone/fetch and the current fetch DID NOT
2038 * request a partial-fetch, do a normal fetch.
2040 if (!repo_has_promisor_remote(the_repository) && !filter_options.choice)
2041 return;
2044 * If this is a partial-fetch request, we enable partial on
2045 * this repo if not already enabled and remember the given
2046 * filter-spec as the default for subsequent fetches to this
2047 * remote if there is currently no default filter-spec.
2049 if (filter_options.choice) {
2050 partial_clone_register(remote->name, &filter_options);
2051 return;
2055 * Do a partial-fetch from the promisor remote using either the
2056 * explicitly given filter-spec or inherit the filter-spec from
2057 * the config.
2059 if (!filter_options.choice)
2060 partial_clone_get_default_filter_spec(&filter_options, remote->name);
2061 return;
2064 static int fetch_one(struct remote *remote, int argc, const char **argv,
2065 int prune_tags_ok, int use_stdin_refspecs,
2066 const struct fetch_config *config)
2068 struct refspec rs = REFSPEC_INIT_FETCH;
2069 int i;
2070 int exit_code;
2071 int maybe_prune_tags;
2072 int remote_via_config = remote_is_configured(remote, 0);
2074 if (!remote)
2075 die(_("no remote repository specified; please specify either a URL or a\n"
2076 "remote name from which new revisions should be fetched"));
2078 gtransport = prepare_transport(remote, 1);
2080 if (prune < 0) {
2081 /* no command line request */
2082 if (0 <= remote->prune)
2083 prune = remote->prune;
2084 else if (0 <= config->prune)
2085 prune = config->prune;
2086 else
2087 prune = PRUNE_BY_DEFAULT;
2090 if (prune_tags < 0) {
2091 /* no command line request */
2092 if (0 <= remote->prune_tags)
2093 prune_tags = remote->prune_tags;
2094 else if (0 <= config->prune_tags)
2095 prune_tags = config->prune_tags;
2096 else
2097 prune_tags = PRUNE_TAGS_BY_DEFAULT;
2100 maybe_prune_tags = prune_tags_ok && prune_tags;
2101 if (maybe_prune_tags && remote_via_config)
2102 refspec_append(&remote->fetch, TAG_REFSPEC);
2104 if (maybe_prune_tags && (argc || !remote_via_config))
2105 refspec_append(&rs, TAG_REFSPEC);
2107 for (i = 0; i < argc; i++) {
2108 if (!strcmp(argv[i], "tag")) {
2109 i++;
2110 if (i >= argc)
2111 die(_("you need to specify a tag name"));
2113 refspec_appendf(&rs, "refs/tags/%s:refs/tags/%s",
2114 argv[i], argv[i]);
2115 } else {
2116 refspec_append(&rs, argv[i]);
2120 if (use_stdin_refspecs) {
2121 struct strbuf line = STRBUF_INIT;
2122 while (strbuf_getline_lf(&line, stdin) != EOF)
2123 refspec_append(&rs, line.buf);
2124 strbuf_release(&line);
2127 if (server_options.nr)
2128 gtransport->server_options = &server_options;
2130 sigchain_push_common(unlock_pack_on_signal);
2131 atexit(unlock_pack_atexit);
2132 sigchain_push(SIGPIPE, SIG_IGN);
2133 exit_code = do_fetch(gtransport, &rs, config);
2134 sigchain_pop(SIGPIPE);
2135 refspec_clear(&rs);
2136 transport_disconnect(gtransport);
2137 gtransport = NULL;
2138 return exit_code;
2141 int cmd_fetch(int argc, const char **argv, const char *prefix)
2143 struct fetch_config config = {
2144 .display_format = DISPLAY_FORMAT_FULL,
2145 .prune = -1,
2146 .prune_tags = -1,
2147 .show_forced_updates = 1,
2148 .recurse_submodules = RECURSE_SUBMODULES_DEFAULT,
2149 .parallel = 1,
2150 .submodule_fetch_jobs = -1,
2152 const char *submodule_prefix = "";
2153 const char *bundle_uri;
2154 struct string_list list = STRING_LIST_INIT_DUP;
2155 struct remote *remote = NULL;
2156 int all = -1, multiple = 0;
2157 int result = 0;
2158 int prune_tags_ok = 1;
2159 int enable_auto_gc = 1;
2160 int unshallow = 0;
2161 int max_jobs = -1;
2162 int recurse_submodules_cli = RECURSE_SUBMODULES_DEFAULT;
2163 int recurse_submodules_default = RECURSE_SUBMODULES_ON_DEMAND;
2164 int fetch_write_commit_graph = -1;
2165 int stdin_refspecs = 0;
2166 int negotiate_only = 0;
2167 int porcelain = 0;
2168 int i;
2170 struct option builtin_fetch_options[] = {
2171 OPT__VERBOSITY(&verbosity),
2172 OPT_BOOL(0, "all", &all,
2173 N_("fetch from all remotes")),
2174 OPT_BOOL(0, "set-upstream", &set_upstream,
2175 N_("set upstream for git pull/fetch")),
2176 OPT_BOOL('a', "append", &append,
2177 N_("append to .git/FETCH_HEAD instead of overwriting")),
2178 OPT_BOOL(0, "atomic", &atomic_fetch,
2179 N_("use atomic transaction to update references")),
2180 OPT_STRING(0, "upload-pack", &upload_pack, N_("path"),
2181 N_("path to upload pack on remote end")),
2182 OPT__FORCE(&force, N_("force overwrite of local reference"), 0),
2183 OPT_BOOL('m', "multiple", &multiple,
2184 N_("fetch from multiple remotes")),
2185 OPT_SET_INT('t', "tags", &tags,
2186 N_("fetch all tags and associated objects"), TAGS_SET),
2187 OPT_SET_INT('n', NULL, &tags,
2188 N_("do not fetch all tags (--no-tags)"), TAGS_UNSET),
2189 OPT_INTEGER('j', "jobs", &max_jobs,
2190 N_("number of submodules fetched in parallel")),
2191 OPT_BOOL(0, "prefetch", &prefetch,
2192 N_("modify the refspec to place all refs within refs/prefetch/")),
2193 OPT_BOOL('p', "prune", &prune,
2194 N_("prune remote-tracking branches no longer on remote")),
2195 OPT_BOOL('P', "prune-tags", &prune_tags,
2196 N_("prune local tags no longer on remote and clobber changed tags")),
2197 OPT_CALLBACK_F(0, "recurse-submodules", &recurse_submodules_cli, N_("on-demand"),
2198 N_("control recursive fetching of submodules"),
2199 PARSE_OPT_OPTARG, option_fetch_parse_recurse_submodules),
2200 OPT_BOOL(0, "dry-run", &dry_run,
2201 N_("dry run")),
2202 OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
2203 OPT_BOOL(0, "write-fetch-head", &write_fetch_head,
2204 N_("write fetched references to the FETCH_HEAD file")),
2205 OPT_BOOL('k', "keep", &keep, N_("keep downloaded pack")),
2206 OPT_BOOL('u', "update-head-ok", &update_head_ok,
2207 N_("allow updating of HEAD ref")),
2208 OPT_BOOL(0, "progress", &progress, N_("force progress reporting")),
2209 OPT_STRING(0, "depth", &depth, N_("depth"),
2210 N_("deepen history of shallow clone")),
2211 OPT_STRING(0, "shallow-since", &deepen_since, N_("time"),
2212 N_("deepen history of shallow repository based on time")),
2213 OPT_STRING_LIST(0, "shallow-exclude", &deepen_not, N_("revision"),
2214 N_("deepen history of shallow clone, excluding rev")),
2215 OPT_INTEGER(0, "deepen", &deepen_relative,
2216 N_("deepen history of shallow clone")),
2217 OPT_SET_INT_F(0, "unshallow", &unshallow,
2218 N_("convert to a complete repository"),
2219 1, PARSE_OPT_NONEG),
2220 OPT_SET_INT_F(0, "refetch", &refetch,
2221 N_("re-fetch without negotiating common commits"),
2222 1, PARSE_OPT_NONEG),
2223 { OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, N_("dir"),
2224 N_("prepend this to submodule path output"), PARSE_OPT_HIDDEN },
2225 OPT_CALLBACK_F(0, "recurse-submodules-default",
2226 &recurse_submodules_default, N_("on-demand"),
2227 N_("default for recursive fetching of submodules "
2228 "(lower priority than config files)"),
2229 PARSE_OPT_HIDDEN, option_fetch_parse_recurse_submodules),
2230 OPT_BOOL(0, "update-shallow", &update_shallow,
2231 N_("accept refs that update .git/shallow")),
2232 OPT_CALLBACK_F(0, "refmap", &refmap, N_("refmap"),
2233 N_("specify fetch refmap"), PARSE_OPT_NONEG, parse_refmap_arg),
2234 OPT_STRING_LIST('o', "server-option", &server_options, N_("server-specific"), N_("option to transmit")),
2235 OPT_IPVERSION(&family),
2236 OPT_STRING_LIST(0, "negotiation-tip", &negotiation_tip, N_("revision"),
2237 N_("report that we have only objects reachable from this object")),
2238 OPT_BOOL(0, "negotiate-only", &negotiate_only,
2239 N_("do not fetch a packfile; instead, print ancestors of negotiation tips")),
2240 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
2241 OPT_BOOL(0, "auto-maintenance", &enable_auto_gc,
2242 N_("run 'maintenance --auto' after fetching")),
2243 OPT_BOOL(0, "auto-gc", &enable_auto_gc,
2244 N_("run 'maintenance --auto' after fetching")),
2245 OPT_BOOL(0, "show-forced-updates", &config.show_forced_updates,
2246 N_("check for forced-updates on all updated branches")),
2247 OPT_BOOL(0, "write-commit-graph", &fetch_write_commit_graph,
2248 N_("write the commit-graph after fetching")),
2249 OPT_BOOL(0, "stdin", &stdin_refspecs,
2250 N_("accept refspecs from stdin")),
2251 OPT_END()
2254 packet_trace_identity("fetch");
2256 /* Record the command line for the reflog */
2257 strbuf_addstr(&default_rla, "fetch");
2258 for (i = 1; i < argc; i++) {
2259 /* This handles non-URLs gracefully */
2260 char *anon = transport_anonymize_url(argv[i]);
2262 strbuf_addf(&default_rla, " %s", anon);
2263 free(anon);
2266 git_config(git_fetch_config, &config);
2267 if (the_repository->gitdir) {
2268 prepare_repo_settings(the_repository);
2269 the_repository->settings.command_requires_full_index = 0;
2272 argc = parse_options(argc, argv, prefix,
2273 builtin_fetch_options, builtin_fetch_usage, 0);
2275 if (recurse_submodules_cli != RECURSE_SUBMODULES_DEFAULT)
2276 config.recurse_submodules = recurse_submodules_cli;
2278 if (negotiate_only) {
2279 switch (recurse_submodules_cli) {
2280 case RECURSE_SUBMODULES_OFF:
2281 case RECURSE_SUBMODULES_DEFAULT:
2283 * --negotiate-only should never recurse into
2284 * submodules. Skip it by setting recurse_submodules to
2285 * RECURSE_SUBMODULES_OFF.
2287 config.recurse_submodules = RECURSE_SUBMODULES_OFF;
2288 break;
2290 default:
2291 die(_("options '%s' and '%s' cannot be used together"),
2292 "--negotiate-only", "--recurse-submodules");
2296 if (config.recurse_submodules != RECURSE_SUBMODULES_OFF) {
2297 int *sfjc = config.submodule_fetch_jobs == -1
2298 ? &config.submodule_fetch_jobs : NULL;
2299 int *rs = config.recurse_submodules == RECURSE_SUBMODULES_DEFAULT
2300 ? &config.recurse_submodules : NULL;
2302 fetch_config_from_gitmodules(sfjc, rs);
2306 if (porcelain) {
2307 switch (recurse_submodules_cli) {
2308 case RECURSE_SUBMODULES_OFF:
2309 case RECURSE_SUBMODULES_DEFAULT:
2311 * Reference updates in submodules would be ambiguous
2312 * in porcelain mode, so we reject this combination.
2314 config.recurse_submodules = RECURSE_SUBMODULES_OFF;
2315 break;
2317 default:
2318 die(_("options '%s' and '%s' cannot be used together"),
2319 "--porcelain", "--recurse-submodules");
2322 config.display_format = DISPLAY_FORMAT_PORCELAIN;
2325 if (negotiate_only && !negotiation_tip.nr)
2326 die(_("--negotiate-only needs one or more --negotiation-tip=*"));
2328 if (deepen_relative) {
2329 if (deepen_relative < 0)
2330 die(_("negative depth in --deepen is not supported"));
2331 if (depth)
2332 die(_("options '%s' and '%s' cannot be used together"), "--deepen", "--depth");
2333 depth = xstrfmt("%d", deepen_relative);
2335 if (unshallow) {
2336 if (depth)
2337 die(_("options '%s' and '%s' cannot be used together"), "--depth", "--unshallow");
2338 else if (!is_repository_shallow(the_repository))
2339 die(_("--unshallow on a complete repository does not make sense"));
2340 else
2341 depth = xstrfmt("%d", INFINITE_DEPTH);
2344 /* no need to be strict, transport_set_option() will validate it again */
2345 if (depth && atoi(depth) < 1)
2346 die(_("depth %s is not a positive number"), depth);
2347 if (depth || deepen_since || deepen_not.nr)
2348 deepen = 1;
2350 /* FETCH_HEAD never gets updated in --dry-run mode */
2351 if (dry_run)
2352 write_fetch_head = 0;
2354 if (!max_jobs)
2355 max_jobs = online_cpus();
2357 if (!git_config_get_string_tmp("fetch.bundleuri", &bundle_uri) &&
2358 fetch_bundle_uri(the_repository, bundle_uri, NULL))
2359 warning(_("failed to fetch bundles from '%s'"), bundle_uri);
2361 if (all < 0) {
2363 * no --[no-]all given;
2364 * only use config option if no remote was explicitly specified
2366 all = (!argc) ? config.all : 0;
2369 if (all) {
2370 if (argc == 1)
2371 die(_("fetch --all does not take a repository argument"));
2372 else if (argc > 1)
2373 die(_("fetch --all does not make sense with refspecs"));
2375 (void) for_each_remote(get_one_remote_for_fetch, &list);
2377 /* do not do fetch_multiple() of one */
2378 if (list.nr == 1)
2379 remote = remote_get(list.items[0].string);
2380 } else if (argc == 0) {
2381 /* No arguments -- use default remote */
2382 remote = remote_get(NULL);
2383 } else if (multiple) {
2384 /* All arguments are assumed to be remotes or groups */
2385 for (i = 0; i < argc; i++)
2386 if (!add_remote_or_group(argv[i], &list))
2387 die(_("no such remote or remote group: %s"),
2388 argv[i]);
2389 } else {
2390 /* Single remote or group */
2391 (void) add_remote_or_group(argv[0], &list);
2392 if (list.nr > 1) {
2393 /* More than one remote */
2394 if (argc > 1)
2395 die(_("fetching a group and specifying refspecs does not make sense"));
2396 } else {
2397 /* Zero or one remotes */
2398 remote = remote_get(argv[0]);
2399 prune_tags_ok = (argc == 1);
2400 argc--;
2401 argv++;
2404 string_list_remove_duplicates(&list, 0);
2406 if (negotiate_only) {
2407 struct oidset acked_commits = OIDSET_INIT;
2408 struct oidset_iter iter;
2409 const struct object_id *oid;
2411 trace2_region_enter("fetch", "negotiate-only", the_repository);
2412 if (!remote)
2413 die(_("must supply remote when using --negotiate-only"));
2414 gtransport = prepare_transport(remote, 1);
2415 if (gtransport->smart_options) {
2416 gtransport->smart_options->acked_commits = &acked_commits;
2417 } else {
2418 warning(_("protocol does not support --negotiate-only, exiting"));
2419 result = 1;
2420 trace2_region_leave("fetch", "negotiate-only", the_repository);
2421 goto cleanup;
2423 if (server_options.nr)
2424 gtransport->server_options = &server_options;
2425 result = transport_fetch_refs(gtransport, NULL);
2427 oidset_iter_init(&acked_commits, &iter);
2428 while ((oid = oidset_iter_next(&iter)))
2429 printf("%s\n", oid_to_hex(oid));
2430 oidset_clear(&acked_commits);
2431 trace2_region_leave("fetch", "negotiate-only", the_repository);
2432 } else if (remote) {
2433 if (filter_options.choice || repo_has_promisor_remote(the_repository)) {
2434 trace2_region_enter("fetch", "setup-partial", the_repository);
2435 fetch_one_setup_partial(remote);
2436 trace2_region_leave("fetch", "setup-partial", the_repository);
2438 trace2_region_enter("fetch", "fetch-one", the_repository);
2439 result = fetch_one(remote, argc, argv, prune_tags_ok, stdin_refspecs,
2440 &config);
2441 trace2_region_leave("fetch", "fetch-one", the_repository);
2442 } else {
2443 int max_children = max_jobs;
2445 if (filter_options.choice)
2446 die(_("--filter can only be used with the remote "
2447 "configured in extensions.partialclone"));
2449 if (atomic_fetch)
2450 die(_("--atomic can only be used when fetching "
2451 "from one remote"));
2453 if (stdin_refspecs)
2454 die(_("--stdin can only be used when fetching "
2455 "from one remote"));
2457 if (max_children < 0)
2458 max_children = config.parallel;
2460 /* TODO should this also die if we have a previous partial-clone? */
2461 trace2_region_enter("fetch", "fetch-multiple", the_repository);
2462 result = fetch_multiple(&list, max_children, &config);
2463 trace2_region_leave("fetch", "fetch-multiple", the_repository);
2467 * This is only needed after fetch_one(), which does not fetch
2468 * submodules by itself.
2470 * When we fetch from multiple remotes, fetch_multiple() has
2471 * already updated submodules to grab commits necessary for
2472 * the fetched history from each remote, so there is no need
2473 * to fetch submodules from here.
2475 if (!result && remote && (config.recurse_submodules != RECURSE_SUBMODULES_OFF)) {
2476 struct strvec options = STRVEC_INIT;
2477 int max_children = max_jobs;
2479 if (max_children < 0)
2480 max_children = config.submodule_fetch_jobs;
2481 if (max_children < 0)
2482 max_children = config.parallel;
2484 add_options_to_argv(&options, &config);
2485 trace2_region_enter_printf("fetch", "recurse-submodule", the_repository, "%s", submodule_prefix);
2486 result = fetch_submodules(the_repository,
2487 &options,
2488 submodule_prefix,
2489 config.recurse_submodules,
2490 recurse_submodules_default,
2491 verbosity < 0,
2492 max_children);
2493 trace2_region_leave_printf("fetch", "recurse-submodule", the_repository, "%s", submodule_prefix);
2494 strvec_clear(&options);
2498 * Skip irrelevant tasks because we know objects were not
2499 * fetched.
2501 * NEEDSWORK: as a future optimization, we can return early
2502 * whenever objects were not fetched e.g. if we already have all
2503 * of them.
2505 if (negotiate_only)
2506 goto cleanup;
2508 prepare_repo_settings(the_repository);
2509 if (fetch_write_commit_graph > 0 ||
2510 (fetch_write_commit_graph < 0 &&
2511 the_repository->settings.fetch_write_commit_graph)) {
2512 int commit_graph_flags = COMMIT_GRAPH_WRITE_SPLIT;
2514 if (progress)
2515 commit_graph_flags |= COMMIT_GRAPH_WRITE_PROGRESS;
2517 trace2_region_enter("fetch", "write-commit-graph", the_repository);
2518 write_commit_graph_reachable(the_repository->objects->odb,
2519 commit_graph_flags,
2520 NULL);
2521 trace2_region_leave("fetch", "write-commit-graph", the_repository);
2524 if (enable_auto_gc) {
2525 if (refetch) {
2527 * Hint auto-maintenance strongly to encourage repacking,
2528 * but respect config settings disabling it.
2530 int opt_val;
2531 if (git_config_get_int("gc.autopacklimit", &opt_val))
2532 opt_val = -1;
2533 if (opt_val != 0)
2534 git_config_push_parameter("gc.autoPackLimit=1");
2536 if (git_config_get_int("maintenance.incremental-repack.auto", &opt_val))
2537 opt_val = -1;
2538 if (opt_val != 0)
2539 git_config_push_parameter("maintenance.incremental-repack.auto=-1");
2541 run_auto_maintenance(verbosity < 0);
2544 cleanup:
2545 string_list_clear(&list, 0);
2546 return result;