Merge branch 'js/merge-tree-3-trees'
[git.git] / builtin / fetch.c
blob46a793411a437969b53c4f14d941df27358d00ed
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;
143 if (!strcmp(k, "submodule.fetchjobs")) {
144 fetch_config->submodule_fetch_jobs = parse_submodule_fetchjobs(k, v, ctx->kvi);
145 return 0;
146 } else if (!strcmp(k, "fetch.recursesubmodules")) {
147 fetch_config->recurse_submodules = parse_fetch_recurse_submodules_arg(k, v);
148 return 0;
151 if (!strcmp(k, "fetch.parallel")) {
152 fetch_config->parallel = git_config_int(k, v, ctx->kvi);
153 if (fetch_config->parallel < 0)
154 die(_("fetch.parallel cannot be negative"));
155 if (!fetch_config->parallel)
156 fetch_config->parallel = online_cpus();
157 return 0;
160 if (!strcmp(k, "fetch.output")) {
161 if (!v)
162 return config_error_nonbool(k);
163 else if (!strcasecmp(v, "full"))
164 fetch_config->display_format = DISPLAY_FORMAT_FULL;
165 else if (!strcasecmp(v, "compact"))
166 fetch_config->display_format = DISPLAY_FORMAT_COMPACT;
167 else
168 die(_("invalid value for '%s': '%s'"),
169 "fetch.output", v);
172 return git_default_config(k, v, ctx, cb);
175 static int parse_refmap_arg(const struct option *opt, const char *arg, int unset)
177 BUG_ON_OPT_NEG(unset);
180 * "git fetch --refmap='' origin foo"
181 * can be used to tell the command not to store anywhere
183 refspec_append(opt->value, arg);
185 return 0;
188 static void unlock_pack(unsigned int flags)
190 if (gtransport)
191 transport_unlock_pack(gtransport, flags);
192 if (gsecondary)
193 transport_unlock_pack(gsecondary, flags);
196 static void unlock_pack_atexit(void)
198 unlock_pack(0);
201 static void unlock_pack_on_signal(int signo)
203 unlock_pack(TRANSPORT_UNLOCK_PACK_IN_SIGNAL_HANDLER);
204 sigchain_pop(signo);
205 raise(signo);
208 static void add_merge_config(struct ref **head,
209 const struct ref *remote_refs,
210 struct branch *branch,
211 struct ref ***tail)
213 int i;
215 for (i = 0; i < branch->merge_nr; i++) {
216 struct ref *rm, **old_tail = *tail;
217 struct refspec_item refspec;
219 for (rm = *head; rm; rm = rm->next) {
220 if (branch_merge_matches(branch, i, rm->name)) {
221 rm->fetch_head_status = FETCH_HEAD_MERGE;
222 break;
225 if (rm)
226 continue;
229 * Not fetched to a remote-tracking branch? We need to fetch
230 * it anyway to allow this branch's "branch.$name.merge"
231 * to be honored by 'git pull', but we do not have to
232 * fail if branch.$name.merge is misconfigured to point
233 * at a nonexisting branch. If we were indeed called by
234 * 'git pull', it will notice the misconfiguration because
235 * there is no entry in the resulting FETCH_HEAD marked
236 * for merging.
238 memset(&refspec, 0, sizeof(refspec));
239 refspec.src = branch->merge[i]->src;
240 get_fetch_map(remote_refs, &refspec, tail, 1);
241 for (rm = *old_tail; rm; rm = rm->next)
242 rm->fetch_head_status = FETCH_HEAD_MERGE;
246 static void create_fetch_oidset(struct ref **head, struct oidset *out)
248 struct ref *rm = *head;
249 while (rm) {
250 oidset_insert(out, &rm->old_oid);
251 rm = rm->next;
255 struct refname_hash_entry {
256 struct hashmap_entry ent;
257 struct object_id oid;
258 int ignore;
259 char refname[FLEX_ARRAY];
262 static int refname_hash_entry_cmp(const void *hashmap_cmp_fn_data UNUSED,
263 const struct hashmap_entry *eptr,
264 const struct hashmap_entry *entry_or_key,
265 const void *keydata)
267 const struct refname_hash_entry *e1, *e2;
269 e1 = container_of(eptr, const struct refname_hash_entry, ent);
270 e2 = container_of(entry_or_key, const struct refname_hash_entry, ent);
271 return strcmp(e1->refname, keydata ? keydata : e2->refname);
274 static struct refname_hash_entry *refname_hash_add(struct hashmap *map,
275 const char *refname,
276 const struct object_id *oid)
278 struct refname_hash_entry *ent;
279 size_t len = strlen(refname);
281 FLEX_ALLOC_MEM(ent, refname, refname, len);
282 hashmap_entry_init(&ent->ent, strhash(refname));
283 oidcpy(&ent->oid, oid);
284 hashmap_add(map, &ent->ent);
285 return ent;
288 static int add_one_refname(const char *refname,
289 const struct object_id *oid,
290 int flag UNUSED, void *cbdata)
292 struct hashmap *refname_map = cbdata;
294 (void) refname_hash_add(refname_map, refname, oid);
295 return 0;
298 static void refname_hash_init(struct hashmap *map)
300 hashmap_init(map, refname_hash_entry_cmp, NULL, 0);
303 static int refname_hash_exists(struct hashmap *map, const char *refname)
305 return !!hashmap_get_from_hash(map, strhash(refname), refname);
308 static void clear_item(struct refname_hash_entry *item)
310 item->ignore = 1;
314 static void add_already_queued_tags(const char *refname,
315 const struct object_id *old_oid UNUSED,
316 const struct object_id *new_oid,
317 void *cb_data)
319 struct hashmap *queued_tags = cb_data;
320 if (starts_with(refname, "refs/tags/") && new_oid)
321 (void) refname_hash_add(queued_tags, refname, new_oid);
324 static void find_non_local_tags(const struct ref *refs,
325 struct ref_transaction *transaction,
326 struct ref **head,
327 struct ref ***tail)
329 struct hashmap existing_refs;
330 struct hashmap remote_refs;
331 struct oidset fetch_oids = OIDSET_INIT;
332 struct string_list remote_refs_list = STRING_LIST_INIT_NODUP;
333 struct string_list_item *remote_ref_item;
334 const struct ref *ref;
335 struct refname_hash_entry *item = NULL;
336 const int quick_flags = OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT;
338 refname_hash_init(&existing_refs);
339 refname_hash_init(&remote_refs);
340 create_fetch_oidset(head, &fetch_oids);
342 for_each_ref(add_one_refname, &existing_refs);
345 * If we already have a transaction, then we need to filter out all
346 * tags which have already been queued up.
348 if (transaction)
349 ref_transaction_for_each_queued_update(transaction,
350 add_already_queued_tags,
351 &existing_refs);
353 for (ref = refs; ref; ref = ref->next) {
354 if (!starts_with(ref->name, "refs/tags/"))
355 continue;
358 * The peeled ref always follows the matching base
359 * ref, so if we see a peeled ref that we don't want
360 * to fetch then we can mark the ref entry in the list
361 * as one to ignore by setting util to NULL.
363 if (ends_with(ref->name, "^{}")) {
364 if (item &&
365 !repo_has_object_file_with_flags(the_repository, &ref->old_oid, quick_flags) &&
366 !oidset_contains(&fetch_oids, &ref->old_oid) &&
367 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
368 !oidset_contains(&fetch_oids, &item->oid))
369 clear_item(item);
370 item = NULL;
371 continue;
375 * If item is non-NULL here, then we previously saw a
376 * ref not followed by a peeled reference, so we need
377 * to check if it is a lightweight tag that we want to
378 * fetch.
380 if (item &&
381 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
382 !oidset_contains(&fetch_oids, &item->oid))
383 clear_item(item);
385 item = NULL;
387 /* skip duplicates and refs that we already have */
388 if (refname_hash_exists(&remote_refs, ref->name) ||
389 refname_hash_exists(&existing_refs, ref->name))
390 continue;
392 item = refname_hash_add(&remote_refs, ref->name, &ref->old_oid);
393 string_list_insert(&remote_refs_list, ref->name);
395 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
398 * We may have a final lightweight tag that needs to be
399 * checked to see if it needs fetching.
401 if (item &&
402 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
403 !oidset_contains(&fetch_oids, &item->oid))
404 clear_item(item);
407 * For all the tags in the remote_refs_list,
408 * add them to the list of refs to be fetched
410 for_each_string_list_item(remote_ref_item, &remote_refs_list) {
411 const char *refname = remote_ref_item->string;
412 struct ref *rm;
413 unsigned int hash = strhash(refname);
415 item = hashmap_get_entry_from_hash(&remote_refs, hash, refname,
416 struct refname_hash_entry, ent);
417 if (!item)
418 BUG("unseen remote ref?");
420 /* Unless we have already decided to ignore this item... */
421 if (item->ignore)
422 continue;
424 rm = alloc_ref(item->refname);
425 rm->peer_ref = alloc_ref(item->refname);
426 oidcpy(&rm->old_oid, &item->oid);
427 **tail = rm;
428 *tail = &rm->next;
430 hashmap_clear_and_free(&remote_refs, struct refname_hash_entry, ent);
431 string_list_clear(&remote_refs_list, 0);
432 oidset_clear(&fetch_oids);
435 static void filter_prefetch_refspec(struct refspec *rs)
437 int i;
439 if (!prefetch)
440 return;
442 for (i = 0; i < rs->nr; i++) {
443 struct strbuf new_dst = STRBUF_INIT;
444 char *old_dst;
445 const char *sub = NULL;
447 if (rs->items[i].negative)
448 continue;
449 if (!rs->items[i].dst ||
450 (rs->items[i].src &&
451 starts_with(rs->items[i].src,
452 ref_namespace[NAMESPACE_TAGS].ref))) {
453 int j;
455 free(rs->items[i].src);
456 free(rs->items[i].dst);
458 for (j = i + 1; j < rs->nr; j++) {
459 rs->items[j - 1] = rs->items[j];
460 rs->raw[j - 1] = rs->raw[j];
462 rs->nr--;
463 i--;
464 continue;
467 old_dst = rs->items[i].dst;
468 strbuf_addstr(&new_dst, ref_namespace[NAMESPACE_PREFETCH].ref);
471 * If old_dst starts with "refs/", then place
472 * sub after that prefix. Otherwise, start at
473 * the beginning of the string.
475 if (!skip_prefix(old_dst, "refs/", &sub))
476 sub = old_dst;
477 strbuf_addstr(&new_dst, sub);
479 rs->items[i].dst = strbuf_detach(&new_dst, NULL);
480 rs->items[i].force = 1;
482 free(old_dst);
486 static struct ref *get_ref_map(struct remote *remote,
487 const struct ref *remote_refs,
488 struct refspec *rs,
489 int tags, int *autotags)
491 int i;
492 struct ref *rm;
493 struct ref *ref_map = NULL;
494 struct ref **tail = &ref_map;
496 /* opportunistically-updated references: */
497 struct ref *orefs = NULL, **oref_tail = &orefs;
499 struct hashmap existing_refs;
500 int existing_refs_populated = 0;
502 filter_prefetch_refspec(rs);
503 if (remote)
504 filter_prefetch_refspec(&remote->fetch);
506 if (rs->nr) {
507 struct refspec *fetch_refspec;
509 for (i = 0; i < rs->nr; i++) {
510 get_fetch_map(remote_refs, &rs->items[i], &tail, 0);
511 if (rs->items[i].dst && rs->items[i].dst[0])
512 *autotags = 1;
514 /* Merge everything on the command line (but not --tags) */
515 for (rm = ref_map; rm; rm = rm->next)
516 rm->fetch_head_status = FETCH_HEAD_MERGE;
519 * For any refs that we happen to be fetching via
520 * command-line arguments, the destination ref might
521 * have been missing or have been different than the
522 * remote-tracking ref that would be derived from the
523 * configured refspec. In these cases, we want to
524 * take the opportunity to update their configured
525 * remote-tracking reference. However, we do not want
526 * to mention these entries in FETCH_HEAD at all, as
527 * they would simply be duplicates of existing
528 * entries, so we set them FETCH_HEAD_IGNORE below.
530 * We compute these entries now, based only on the
531 * refspecs specified on the command line. But we add
532 * them to the list following the refspecs resulting
533 * from the tags option so that one of the latter,
534 * which has FETCH_HEAD_NOT_FOR_MERGE, is not removed
535 * by ref_remove_duplicates() in favor of one of these
536 * opportunistic entries with FETCH_HEAD_IGNORE.
538 if (refmap.nr)
539 fetch_refspec = &refmap;
540 else
541 fetch_refspec = &remote->fetch;
543 for (i = 0; i < fetch_refspec->nr; i++)
544 get_fetch_map(ref_map, &fetch_refspec->items[i], &oref_tail, 1);
545 } else if (refmap.nr) {
546 die("--refmap option is only meaningful with command-line refspec(s)");
547 } else {
548 /* Use the defaults */
549 struct branch *branch = branch_get(NULL);
550 int has_merge = branch_has_merge_config(branch);
551 if (remote &&
552 (remote->fetch.nr ||
553 /* Note: has_merge implies non-NULL branch->remote_name */
554 (has_merge && !strcmp(branch->remote_name, remote->name)))) {
555 for (i = 0; i < remote->fetch.nr; i++) {
556 get_fetch_map(remote_refs, &remote->fetch.items[i], &tail, 0);
557 if (remote->fetch.items[i].dst &&
558 remote->fetch.items[i].dst[0])
559 *autotags = 1;
560 if (!i && !has_merge && ref_map &&
561 !remote->fetch.items[0].pattern)
562 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
565 * if the remote we're fetching from is the same
566 * as given in branch.<name>.remote, we add the
567 * ref given in branch.<name>.merge, too.
569 * Note: has_merge implies non-NULL branch->remote_name
571 if (has_merge &&
572 !strcmp(branch->remote_name, remote->name))
573 add_merge_config(&ref_map, remote_refs, branch, &tail);
574 } else if (!prefetch) {
575 ref_map = get_remote_ref(remote_refs, "HEAD");
576 if (!ref_map)
577 die(_("couldn't find remote ref HEAD"));
578 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
579 tail = &ref_map->next;
583 if (tags == TAGS_SET)
584 /* also fetch all tags */
585 get_fetch_map(remote_refs, tag_refspec, &tail, 0);
586 else if (tags == TAGS_DEFAULT && *autotags)
587 find_non_local_tags(remote_refs, NULL, &ref_map, &tail);
589 /* Now append any refs to be updated opportunistically: */
590 *tail = orefs;
591 for (rm = orefs; rm; rm = rm->next) {
592 rm->fetch_head_status = FETCH_HEAD_IGNORE;
593 tail = &rm->next;
597 * apply negative refspecs first, before we remove duplicates. This is
598 * necessary as negative refspecs might remove an otherwise conflicting
599 * duplicate.
601 if (rs->nr)
602 ref_map = apply_negative_refspecs(ref_map, rs);
603 else
604 ref_map = apply_negative_refspecs(ref_map, &remote->fetch);
606 ref_map = ref_remove_duplicates(ref_map);
608 for (rm = ref_map; rm; rm = rm->next) {
609 if (rm->peer_ref) {
610 const char *refname = rm->peer_ref->name;
611 struct refname_hash_entry *peer_item;
612 unsigned int hash = strhash(refname);
614 if (!existing_refs_populated) {
615 refname_hash_init(&existing_refs);
616 for_each_ref(add_one_refname, &existing_refs);
617 existing_refs_populated = 1;
620 peer_item = hashmap_get_entry_from_hash(&existing_refs,
621 hash, refname,
622 struct refname_hash_entry, ent);
623 if (peer_item) {
624 struct object_id *old_oid = &peer_item->oid;
625 oidcpy(&rm->peer_ref->old_oid, old_oid);
629 if (existing_refs_populated)
630 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
632 return ref_map;
635 #define STORE_REF_ERROR_OTHER 1
636 #define STORE_REF_ERROR_DF_CONFLICT 2
638 static int s_update_ref(const char *action,
639 struct ref *ref,
640 struct ref_transaction *transaction,
641 int check_old)
643 char *msg;
644 char *rla = getenv("GIT_REFLOG_ACTION");
645 struct ref_transaction *our_transaction = NULL;
646 struct strbuf err = STRBUF_INIT;
647 int ret;
649 if (dry_run)
650 return 0;
651 if (!rla)
652 rla = default_rla.buf;
653 msg = xstrfmt("%s: %s", rla, action);
656 * If no transaction was passed to us, we manage the transaction
657 * ourselves. Otherwise, we trust the caller to handle the transaction
658 * lifecycle.
660 if (!transaction) {
661 transaction = our_transaction = ref_transaction_begin(&err);
662 if (!transaction) {
663 ret = STORE_REF_ERROR_OTHER;
664 goto out;
668 ret = ref_transaction_update(transaction, ref->name, &ref->new_oid,
669 check_old ? &ref->old_oid : NULL,
670 0, msg, &err);
671 if (ret) {
672 ret = STORE_REF_ERROR_OTHER;
673 goto out;
676 if (our_transaction) {
677 switch (ref_transaction_commit(our_transaction, &err)) {
678 case 0:
679 break;
680 case TRANSACTION_NAME_CONFLICT:
681 ret = STORE_REF_ERROR_DF_CONFLICT;
682 goto out;
683 default:
684 ret = STORE_REF_ERROR_OTHER;
685 goto out;
689 out:
690 ref_transaction_free(our_transaction);
691 if (ret)
692 error("%s", err.buf);
693 strbuf_release(&err);
694 free(msg);
695 return ret;
698 static int refcol_width(const struct ref *ref_map, int compact_format)
700 const struct ref *ref;
701 int max, width = 10;
703 max = term_columns();
704 if (compact_format)
705 max = max * 2 / 3;
707 for (ref = ref_map; ref; ref = ref->next) {
708 int rlen, llen = 0, len;
710 if (ref->status == REF_STATUS_REJECT_SHALLOW ||
711 !ref->peer_ref ||
712 !strcmp(ref->name, "HEAD"))
713 continue;
715 /* uptodate lines are only shown on high verbosity level */
716 if (verbosity <= 0 && oideq(&ref->peer_ref->old_oid, &ref->old_oid))
717 continue;
719 rlen = utf8_strwidth(prettify_refname(ref->name));
720 if (!compact_format)
721 llen = utf8_strwidth(prettify_refname(ref->peer_ref->name));
724 * rough estimation to see if the output line is too long and
725 * should not be counted (we can't do precise calculation
726 * anyway because we don't know if the error explanation part
727 * will be printed in update_local_ref)
729 len = 21 /* flag and summary */ + rlen + 4 /* -> */ + llen;
730 if (len >= max)
731 continue;
733 if (width < rlen)
734 width = rlen;
737 return width;
740 static void display_state_init(struct display_state *display_state, struct ref *ref_map,
741 const char *raw_url, enum display_format format)
743 int i;
745 memset(display_state, 0, sizeof(*display_state));
746 strbuf_init(&display_state->buf, 0);
747 display_state->format = format;
749 if (raw_url)
750 display_state->url = transport_anonymize_url(raw_url);
751 else
752 display_state->url = xstrdup("foreign");
754 display_state->url_len = strlen(display_state->url);
755 for (i = display_state->url_len - 1; display_state->url[i] == '/' && 0 <= i; i--)
757 display_state->url_len = i + 1;
758 if (4 < i && !strncmp(".git", display_state->url + i - 3, 4))
759 display_state->url_len = i - 3;
761 if (verbosity < 0)
762 return;
764 switch (display_state->format) {
765 case DISPLAY_FORMAT_FULL:
766 case DISPLAY_FORMAT_COMPACT:
767 display_state->refcol_width = refcol_width(ref_map,
768 display_state->format == DISPLAY_FORMAT_COMPACT);
769 break;
770 case DISPLAY_FORMAT_PORCELAIN:
771 /* We don't need to precompute anything here. */
772 break;
773 default:
774 BUG("unexpected display format %d", display_state->format);
778 static void display_state_release(struct display_state *display_state)
780 strbuf_release(&display_state->buf);
781 free(display_state->url);
784 static void print_remote_to_local(struct display_state *display_state,
785 const char *remote, const char *local)
787 strbuf_addf(&display_state->buf, "%-*s -> %s",
788 display_state->refcol_width, remote, local);
791 static int find_and_replace(struct strbuf *haystack,
792 const char *needle,
793 const char *placeholder)
795 const char *p = NULL;
796 int plen, nlen;
798 nlen = strlen(needle);
799 if (ends_with(haystack->buf, needle))
800 p = haystack->buf + haystack->len - nlen;
801 else
802 p = strstr(haystack->buf, needle);
803 if (!p)
804 return 0;
806 if (p > haystack->buf && p[-1] != '/')
807 return 0;
809 plen = strlen(p);
810 if (plen > nlen && p[nlen] != '/')
811 return 0;
813 strbuf_splice(haystack, p - haystack->buf, nlen,
814 placeholder, strlen(placeholder));
815 return 1;
818 static void print_compact(struct display_state *display_state,
819 const char *remote, const char *local)
821 struct strbuf r = STRBUF_INIT;
822 struct strbuf l = STRBUF_INIT;
824 if (!strcmp(remote, local)) {
825 strbuf_addf(&display_state->buf, "%-*s -> *", display_state->refcol_width, remote);
826 return;
829 strbuf_addstr(&r, remote);
830 strbuf_addstr(&l, local);
832 if (!find_and_replace(&r, local, "*"))
833 find_and_replace(&l, remote, "*");
834 print_remote_to_local(display_state, r.buf, l.buf);
836 strbuf_release(&r);
837 strbuf_release(&l);
840 static void display_ref_update(struct display_state *display_state, char code,
841 const char *summary, const char *error,
842 const char *remote, const char *local,
843 const struct object_id *old_oid,
844 const struct object_id *new_oid,
845 int summary_width)
847 FILE *f = stderr;
849 if (verbosity < 0)
850 return;
852 strbuf_reset(&display_state->buf);
854 switch (display_state->format) {
855 case DISPLAY_FORMAT_FULL:
856 case DISPLAY_FORMAT_COMPACT: {
857 int width;
859 if (!display_state->shown_url) {
860 strbuf_addf(&display_state->buf, _("From %.*s\n"),
861 display_state->url_len, display_state->url);
862 display_state->shown_url = 1;
865 width = (summary_width + strlen(summary) - gettext_width(summary));
866 remote = prettify_refname(remote);
867 local = prettify_refname(local);
869 strbuf_addf(&display_state->buf, " %c %-*s ", code, width, summary);
871 if (display_state->format != DISPLAY_FORMAT_COMPACT)
872 print_remote_to_local(display_state, remote, local);
873 else
874 print_compact(display_state, remote, local);
876 if (error)
877 strbuf_addf(&display_state->buf, " (%s)", error);
879 break;
881 case DISPLAY_FORMAT_PORCELAIN:
882 strbuf_addf(&display_state->buf, "%c %s %s %s", code,
883 oid_to_hex(old_oid), oid_to_hex(new_oid), local);
884 f = stdout;
885 break;
886 default:
887 BUG("unexpected display format %d", display_state->format);
889 strbuf_addch(&display_state->buf, '\n');
891 fputs(display_state->buf.buf, f);
894 static int update_local_ref(struct ref *ref,
895 struct ref_transaction *transaction,
896 struct display_state *display_state,
897 const struct ref *remote_ref,
898 int summary_width,
899 const struct fetch_config *config)
901 struct commit *current = NULL, *updated;
902 int fast_forward = 0;
904 if (!repo_has_object_file(the_repository, &ref->new_oid))
905 die(_("object %s not found"), oid_to_hex(&ref->new_oid));
907 if (oideq(&ref->old_oid, &ref->new_oid)) {
908 if (verbosity > 0)
909 display_ref_update(display_state, '=', _("[up to date]"), NULL,
910 remote_ref->name, ref->name,
911 &ref->old_oid, &ref->new_oid, summary_width);
912 return 0;
915 if (!update_head_ok &&
916 !is_null_oid(&ref->old_oid) &&
917 branch_checked_out(ref->name)) {
919 * If this is the head, and it's not okay to update
920 * the head, and the old value of the head isn't empty...
922 display_ref_update(display_state, '!', _("[rejected]"),
923 _("can't fetch into checked-out branch"),
924 remote_ref->name, ref->name,
925 &ref->old_oid, &ref->new_oid, summary_width);
926 return 1;
929 if (!is_null_oid(&ref->old_oid) &&
930 starts_with(ref->name, "refs/tags/")) {
931 if (force || ref->force) {
932 int r;
933 r = s_update_ref("updating tag", ref, transaction, 0);
934 display_ref_update(display_state, r ? '!' : 't', _("[tag update]"),
935 r ? _("unable to update local ref") : NULL,
936 remote_ref->name, ref->name,
937 &ref->old_oid, &ref->new_oid, summary_width);
938 return r;
939 } else {
940 display_ref_update(display_state, '!', _("[rejected]"),
941 _("would clobber existing tag"),
942 remote_ref->name, ref->name,
943 &ref->old_oid, &ref->new_oid, summary_width);
944 return 1;
948 current = lookup_commit_reference_gently(the_repository,
949 &ref->old_oid, 1);
950 updated = lookup_commit_reference_gently(the_repository,
951 &ref->new_oid, 1);
952 if (!current || !updated) {
953 const char *msg;
954 const char *what;
955 int r;
957 * Nicely describe the new ref we're fetching.
958 * Base this on the remote's ref name, as it's
959 * more likely to follow a standard layout.
961 if (starts_with(remote_ref->name, "refs/tags/")) {
962 msg = "storing tag";
963 what = _("[new tag]");
964 } else if (starts_with(remote_ref->name, "refs/heads/")) {
965 msg = "storing head";
966 what = _("[new branch]");
967 } else {
968 msg = "storing ref";
969 what = _("[new ref]");
972 r = s_update_ref(msg, ref, transaction, 0);
973 display_ref_update(display_state, r ? '!' : '*', what,
974 r ? _("unable to update local ref") : NULL,
975 remote_ref->name, ref->name,
976 &ref->old_oid, &ref->new_oid, summary_width);
977 return r;
980 if (config->show_forced_updates) {
981 uint64_t t_before = getnanotime();
982 fast_forward = repo_in_merge_bases(the_repository, current,
983 updated);
984 if (fast_forward < 0)
985 exit(128);
986 forced_updates_ms += (getnanotime() - t_before) / 1000000;
987 } else {
988 fast_forward = 1;
991 if (fast_forward) {
992 struct strbuf quickref = STRBUF_INIT;
993 int r;
995 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
996 strbuf_addstr(&quickref, "..");
997 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
998 r = s_update_ref("fast-forward", ref, transaction, 1);
999 display_ref_update(display_state, r ? '!' : ' ', quickref.buf,
1000 r ? _("unable to update local ref") : NULL,
1001 remote_ref->name, ref->name,
1002 &ref->old_oid, &ref->new_oid, summary_width);
1003 strbuf_release(&quickref);
1004 return r;
1005 } else if (force || ref->force) {
1006 struct strbuf quickref = STRBUF_INIT;
1007 int r;
1008 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
1009 strbuf_addstr(&quickref, "...");
1010 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
1011 r = s_update_ref("forced-update", ref, transaction, 1);
1012 display_ref_update(display_state, r ? '!' : '+', quickref.buf,
1013 r ? _("unable to update local ref") : _("forced update"),
1014 remote_ref->name, ref->name,
1015 &ref->old_oid, &ref->new_oid, summary_width);
1016 strbuf_release(&quickref);
1017 return r;
1018 } else {
1019 display_ref_update(display_state, '!', _("[rejected]"), _("non-fast-forward"),
1020 remote_ref->name, ref->name,
1021 &ref->old_oid, &ref->new_oid, summary_width);
1022 return 1;
1026 static const struct object_id *iterate_ref_map(void *cb_data)
1028 struct ref **rm = cb_data;
1029 struct ref *ref = *rm;
1031 while (ref && ref->status == REF_STATUS_REJECT_SHALLOW)
1032 ref = ref->next;
1033 if (!ref)
1034 return NULL;
1035 *rm = ref->next;
1036 return &ref->old_oid;
1039 struct fetch_head {
1040 FILE *fp;
1041 struct strbuf buf;
1044 static int open_fetch_head(struct fetch_head *fetch_head)
1046 const char *filename = git_path_fetch_head(the_repository);
1048 if (write_fetch_head) {
1049 fetch_head->fp = fopen(filename, "a");
1050 if (!fetch_head->fp)
1051 return error_errno(_("cannot open '%s'"), filename);
1052 strbuf_init(&fetch_head->buf, 0);
1053 } else {
1054 fetch_head->fp = NULL;
1057 return 0;
1060 static void append_fetch_head(struct fetch_head *fetch_head,
1061 const struct object_id *old_oid,
1062 enum fetch_head_status fetch_head_status,
1063 const char *note,
1064 const char *url, size_t url_len)
1066 char old_oid_hex[GIT_MAX_HEXSZ + 1];
1067 const char *merge_status_marker;
1068 size_t i;
1070 if (!fetch_head->fp)
1071 return;
1073 switch (fetch_head_status) {
1074 case FETCH_HEAD_NOT_FOR_MERGE:
1075 merge_status_marker = "not-for-merge";
1076 break;
1077 case FETCH_HEAD_MERGE:
1078 merge_status_marker = "";
1079 break;
1080 default:
1081 /* do not write anything to FETCH_HEAD */
1082 return;
1085 strbuf_addf(&fetch_head->buf, "%s\t%s\t%s",
1086 oid_to_hex_r(old_oid_hex, old_oid), merge_status_marker, note);
1087 for (i = 0; i < url_len; ++i)
1088 if ('\n' == url[i])
1089 strbuf_addstr(&fetch_head->buf, "\\n");
1090 else
1091 strbuf_addch(&fetch_head->buf, url[i]);
1092 strbuf_addch(&fetch_head->buf, '\n');
1095 * When using an atomic fetch, we do not want to update FETCH_HEAD if
1096 * any of the reference updates fails. We thus have to write all
1097 * updates to a buffer first and only commit it as soon as all
1098 * references have been successfully updated.
1100 if (!atomic_fetch) {
1101 strbuf_write(&fetch_head->buf, fetch_head->fp);
1102 strbuf_reset(&fetch_head->buf);
1106 static void commit_fetch_head(struct fetch_head *fetch_head)
1108 if (!fetch_head->fp || !atomic_fetch)
1109 return;
1110 strbuf_write(&fetch_head->buf, fetch_head->fp);
1113 static void close_fetch_head(struct fetch_head *fetch_head)
1115 if (!fetch_head->fp)
1116 return;
1118 fclose(fetch_head->fp);
1119 strbuf_release(&fetch_head->buf);
1122 static const char warn_show_forced_updates[] =
1123 N_("fetch normally indicates which branches had a forced update,\n"
1124 "but that check has been disabled; to re-enable, use '--show-forced-updates'\n"
1125 "flag or run 'git config fetch.showForcedUpdates true'");
1126 static const char warn_time_show_forced_updates[] =
1127 N_("it took %.2f seconds to check forced updates; you can use\n"
1128 "'--no-show-forced-updates' or run 'git config fetch.showForcedUpdates false'\n"
1129 "to avoid this check\n");
1131 static int store_updated_refs(struct display_state *display_state,
1132 const char *remote_name,
1133 int connectivity_checked,
1134 struct ref_transaction *transaction, struct ref *ref_map,
1135 struct fetch_head *fetch_head,
1136 const struct fetch_config *config)
1138 int rc = 0;
1139 struct strbuf note = STRBUF_INIT;
1140 const char *what, *kind;
1141 struct ref *rm;
1142 int want_status;
1143 int summary_width = 0;
1145 if (verbosity >= 0)
1146 summary_width = transport_summary_width(ref_map);
1148 if (!connectivity_checked) {
1149 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1151 opt.exclude_hidden_refs_section = "fetch";
1152 rm = ref_map;
1153 if (check_connected(iterate_ref_map, &rm, &opt)) {
1154 rc = error(_("%s did not send all necessary objects\n"),
1155 display_state->url);
1156 goto abort;
1161 * We do a pass for each fetch_head_status type in their enum order, so
1162 * merged entries are written before not-for-merge. That lets readers
1163 * use FETCH_HEAD as a refname to refer to the ref to be merged.
1165 for (want_status = FETCH_HEAD_MERGE;
1166 want_status <= FETCH_HEAD_IGNORE;
1167 want_status++) {
1168 for (rm = ref_map; rm; rm = rm->next) {
1169 struct ref *ref = NULL;
1171 if (rm->status == REF_STATUS_REJECT_SHALLOW) {
1172 if (want_status == FETCH_HEAD_MERGE)
1173 warning(_("rejected %s because shallow roots are not allowed to be updated"),
1174 rm->peer_ref ? rm->peer_ref->name : rm->name);
1175 continue;
1179 * When writing FETCH_HEAD we need to determine whether
1180 * we already have the commit or not. If not, then the
1181 * reference is not for merge and needs to be written
1182 * to the reflog after other commits which we already
1183 * have. We're not interested in this property though
1184 * in case FETCH_HEAD is not to be updated, so we can
1185 * skip the classification in that case.
1187 if (fetch_head->fp) {
1188 struct commit *commit = NULL;
1191 * References in "refs/tags/" are often going to point
1192 * to annotated tags, which are not part of the
1193 * commit-graph. We thus only try to look up refs in
1194 * the graph which are not in that namespace to not
1195 * regress performance in repositories with many
1196 * annotated tags.
1198 if (!starts_with(rm->name, "refs/tags/"))
1199 commit = lookup_commit_in_graph(the_repository, &rm->old_oid);
1200 if (!commit) {
1201 commit = lookup_commit_reference_gently(the_repository,
1202 &rm->old_oid,
1204 if (!commit)
1205 rm->fetch_head_status = FETCH_HEAD_NOT_FOR_MERGE;
1209 if (rm->fetch_head_status != want_status)
1210 continue;
1212 if (rm->peer_ref) {
1213 ref = alloc_ref(rm->peer_ref->name);
1214 oidcpy(&ref->old_oid, &rm->peer_ref->old_oid);
1215 oidcpy(&ref->new_oid, &rm->old_oid);
1216 ref->force = rm->peer_ref->force;
1219 if (config->recurse_submodules != RECURSE_SUBMODULES_OFF &&
1220 (!rm->peer_ref || !oideq(&ref->old_oid, &ref->new_oid))) {
1221 check_for_new_submodule_commits(&rm->old_oid);
1224 if (!strcmp(rm->name, "HEAD")) {
1225 kind = "";
1226 what = "";
1227 } else if (skip_prefix(rm->name, "refs/heads/", &what)) {
1228 kind = "branch";
1229 } else if (skip_prefix(rm->name, "refs/tags/", &what)) {
1230 kind = "tag";
1231 } else if (skip_prefix(rm->name, "refs/remotes/", &what)) {
1232 kind = "remote-tracking branch";
1233 } else {
1234 kind = "";
1235 what = rm->name;
1238 strbuf_reset(&note);
1239 if (*what) {
1240 if (*kind)
1241 strbuf_addf(&note, "%s ", kind);
1242 strbuf_addf(&note, "'%s' of ", what);
1245 append_fetch_head(fetch_head, &rm->old_oid,
1246 rm->fetch_head_status,
1247 note.buf, display_state->url,
1248 display_state->url_len);
1250 if (ref) {
1251 rc |= update_local_ref(ref, transaction, display_state,
1252 rm, summary_width, config);
1253 free(ref);
1254 } else if (write_fetch_head || dry_run) {
1256 * Display fetches written to FETCH_HEAD (or
1257 * would be written to FETCH_HEAD, if --dry-run
1258 * is set).
1260 display_ref_update(display_state, '*',
1261 *kind ? kind : "branch", NULL,
1262 rm->name,
1263 "FETCH_HEAD",
1264 &rm->new_oid, &rm->old_oid,
1265 summary_width);
1270 if (rc & STORE_REF_ERROR_DF_CONFLICT)
1271 error(_("some local refs could not be updated; try running\n"
1272 " 'git remote prune %s' to remove any old, conflicting "
1273 "branches"), remote_name);
1275 if (advice_enabled(ADVICE_FETCH_SHOW_FORCED_UPDATES)) {
1276 if (!config->show_forced_updates) {
1277 warning(_(warn_show_forced_updates));
1278 } else if (forced_updates_ms > FORCED_UPDATES_DELAY_WARNING_IN_MS) {
1279 warning(_(warn_time_show_forced_updates),
1280 forced_updates_ms / 1000.0);
1284 abort:
1285 strbuf_release(&note);
1286 return rc;
1290 * We would want to bypass the object transfer altogether if
1291 * everything we are going to fetch already exists and is connected
1292 * locally.
1294 static int check_exist_and_connected(struct ref *ref_map)
1296 struct ref *rm = ref_map;
1297 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1298 struct ref *r;
1301 * If we are deepening a shallow clone we already have these
1302 * objects reachable. Running rev-list here will return with
1303 * a good (0) exit status and we'll bypass the fetch that we
1304 * really need to perform. Claiming failure now will ensure
1305 * we perform the network exchange to deepen our history.
1307 if (deepen)
1308 return -1;
1311 * Similarly, if we need to refetch, we always want to perform a full
1312 * fetch ignoring existing objects.
1314 if (refetch)
1315 return -1;
1319 * check_connected() allows objects to merely be promised, but
1320 * we need all direct targets to exist.
1322 for (r = rm; r; r = r->next) {
1323 if (!repo_has_object_file_with_flags(the_repository, &r->old_oid,
1324 OBJECT_INFO_SKIP_FETCH_OBJECT))
1325 return -1;
1328 opt.quiet = 1;
1329 opt.exclude_hidden_refs_section = "fetch";
1330 return check_connected(iterate_ref_map, &rm, &opt);
1333 static int fetch_and_consume_refs(struct display_state *display_state,
1334 struct transport *transport,
1335 struct ref_transaction *transaction,
1336 struct ref *ref_map,
1337 struct fetch_head *fetch_head,
1338 const struct fetch_config *config)
1340 int connectivity_checked = 1;
1341 int ret;
1344 * We don't need to perform a fetch in case we can already satisfy all
1345 * refs.
1347 ret = check_exist_and_connected(ref_map);
1348 if (ret) {
1349 trace2_region_enter("fetch", "fetch_refs", the_repository);
1350 ret = transport_fetch_refs(transport, ref_map);
1351 trace2_region_leave("fetch", "fetch_refs", the_repository);
1352 if (ret)
1353 goto out;
1354 connectivity_checked = transport->smart_options ?
1355 transport->smart_options->connectivity_checked : 0;
1358 trace2_region_enter("fetch", "consume_refs", the_repository);
1359 ret = store_updated_refs(display_state, transport->remote->name,
1360 connectivity_checked, transaction, ref_map,
1361 fetch_head, config);
1362 trace2_region_leave("fetch", "consume_refs", the_repository);
1364 out:
1365 transport_unlock_pack(transport, 0);
1366 return ret;
1369 static int prune_refs(struct display_state *display_state,
1370 struct refspec *rs,
1371 struct ref_transaction *transaction,
1372 struct ref *ref_map)
1374 int result = 0;
1375 struct ref *ref, *stale_refs = get_stale_heads(rs, ref_map);
1376 struct strbuf err = STRBUF_INIT;
1377 const char *dangling_msg = dry_run
1378 ? _(" (%s will become dangling)")
1379 : _(" (%s has become dangling)");
1381 if (!dry_run) {
1382 if (transaction) {
1383 for (ref = stale_refs; ref; ref = ref->next) {
1384 result = ref_transaction_delete(transaction, ref->name, NULL, 0,
1385 "fetch: prune", &err);
1386 if (result)
1387 goto cleanup;
1389 } else {
1390 struct string_list refnames = STRING_LIST_INIT_NODUP;
1392 for (ref = stale_refs; ref; ref = ref->next)
1393 string_list_append(&refnames, ref->name);
1395 result = delete_refs("fetch: prune", &refnames, 0);
1396 string_list_clear(&refnames, 0);
1400 if (verbosity >= 0) {
1401 int summary_width = transport_summary_width(stale_refs);
1403 for (ref = stale_refs; ref; ref = ref->next) {
1404 display_ref_update(display_state, '-', _("[deleted]"), NULL,
1405 _("(none)"), ref->name,
1406 &ref->new_oid, &ref->old_oid,
1407 summary_width);
1408 warn_dangling_symref(stderr, dangling_msg, ref->name);
1412 cleanup:
1413 strbuf_release(&err);
1414 free_refs(stale_refs);
1415 return result;
1418 static void check_not_current_branch(struct ref *ref_map)
1420 const char *path;
1421 for (; ref_map; ref_map = ref_map->next)
1422 if (ref_map->peer_ref &&
1423 starts_with(ref_map->peer_ref->name, "refs/heads/") &&
1424 (path = branch_checked_out(ref_map->peer_ref->name)))
1425 die(_("refusing to fetch into branch '%s' "
1426 "checked out at '%s'"),
1427 ref_map->peer_ref->name, path);
1430 static int truncate_fetch_head(void)
1432 const char *filename = git_path_fetch_head(the_repository);
1433 FILE *fp = fopen_for_writing(filename);
1435 if (!fp)
1436 return error_errno(_("cannot open '%s'"), filename);
1437 fclose(fp);
1438 return 0;
1441 static void set_option(struct transport *transport, const char *name, const char *value)
1443 int r = transport_set_option(transport, name, value);
1444 if (r < 0)
1445 die(_("option \"%s\" value \"%s\" is not valid for %s"),
1446 name, value, transport->url);
1447 if (r > 0)
1448 warning(_("option \"%s\" is ignored for %s\n"),
1449 name, transport->url);
1453 static int add_oid(const char *refname UNUSED,
1454 const struct object_id *oid,
1455 int flags UNUSED, void *cb_data)
1457 struct oid_array *oids = cb_data;
1459 oid_array_append(oids, oid);
1460 return 0;
1463 static void add_negotiation_tips(struct git_transport_options *smart_options)
1465 struct oid_array *oids = xcalloc(1, sizeof(*oids));
1466 int i;
1468 for (i = 0; i < negotiation_tip.nr; i++) {
1469 const char *s = negotiation_tip.items[i].string;
1470 int old_nr;
1471 if (!has_glob_specials(s)) {
1472 struct object_id oid;
1473 if (repo_get_oid(the_repository, s, &oid))
1474 die(_("%s is not a valid object"), s);
1475 if (!has_object(the_repository, &oid, 0))
1476 die(_("the object %s does not exist"), s);
1477 oid_array_append(oids, &oid);
1478 continue;
1480 old_nr = oids->nr;
1481 for_each_glob_ref(add_oid, s, oids);
1482 if (old_nr == oids->nr)
1483 warning("ignoring --negotiation-tip=%s because it does not match any refs",
1486 smart_options->negotiation_tips = oids;
1489 static struct transport *prepare_transport(struct remote *remote, int deepen)
1491 struct transport *transport;
1493 transport = transport_get(remote, NULL);
1494 transport_set_verbosity(transport, verbosity, progress);
1495 transport->family = family;
1496 if (upload_pack)
1497 set_option(transport, TRANS_OPT_UPLOADPACK, upload_pack);
1498 if (keep)
1499 set_option(transport, TRANS_OPT_KEEP, "yes");
1500 if (depth)
1501 set_option(transport, TRANS_OPT_DEPTH, depth);
1502 if (deepen && deepen_since)
1503 set_option(transport, TRANS_OPT_DEEPEN_SINCE, deepen_since);
1504 if (deepen && deepen_not.nr)
1505 set_option(transport, TRANS_OPT_DEEPEN_NOT,
1506 (const char *)&deepen_not);
1507 if (deepen_relative)
1508 set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, "yes");
1509 if (update_shallow)
1510 set_option(transport, TRANS_OPT_UPDATE_SHALLOW, "yes");
1511 if (refetch)
1512 set_option(transport, TRANS_OPT_REFETCH, "yes");
1513 if (filter_options.choice) {
1514 const char *spec =
1515 expand_list_objects_filter_spec(&filter_options);
1516 set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER, spec);
1517 set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1519 if (negotiation_tip.nr) {
1520 if (transport->smart_options)
1521 add_negotiation_tips(transport->smart_options);
1522 else
1523 warning("ignoring --negotiation-tip because the protocol does not support it");
1525 return transport;
1528 static int backfill_tags(struct display_state *display_state,
1529 struct transport *transport,
1530 struct ref_transaction *transaction,
1531 struct ref *ref_map,
1532 struct fetch_head *fetch_head,
1533 const struct fetch_config *config)
1535 int retcode, cannot_reuse;
1538 * Once we have set TRANS_OPT_DEEPEN_SINCE, we can't unset it
1539 * when remote helper is used (setting it to an empty string
1540 * is not unsetting). We could extend the remote helper
1541 * protocol for that, but for now, just force a new connection
1542 * without deepen-since. Similar story for deepen-not.
1544 cannot_reuse = transport->cannot_reuse ||
1545 deepen_since || deepen_not.nr;
1546 if (cannot_reuse) {
1547 gsecondary = prepare_transport(transport->remote, 0);
1548 transport = gsecondary;
1551 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
1552 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
1553 transport_set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, NULL);
1554 retcode = fetch_and_consume_refs(display_state, transport, transaction, ref_map,
1555 fetch_head, config);
1557 if (gsecondary) {
1558 transport_disconnect(gsecondary);
1559 gsecondary = NULL;
1562 return retcode;
1565 static int do_fetch(struct transport *transport,
1566 struct refspec *rs,
1567 const struct fetch_config *config)
1569 struct ref_transaction *transaction = NULL;
1570 struct ref *ref_map = NULL;
1571 struct display_state display_state = { 0 };
1572 int autotags = (transport->remote->fetch_tags == 1);
1573 int retcode = 0;
1574 const struct ref *remote_refs;
1575 struct transport_ls_refs_options transport_ls_refs_options =
1576 TRANSPORT_LS_REFS_OPTIONS_INIT;
1577 int must_list_refs = 1;
1578 struct fetch_head fetch_head = { 0 };
1579 struct strbuf err = STRBUF_INIT;
1581 if (tags == TAGS_DEFAULT) {
1582 if (transport->remote->fetch_tags == 2)
1583 tags = TAGS_SET;
1584 if (transport->remote->fetch_tags == -1)
1585 tags = TAGS_UNSET;
1588 /* if not appending, truncate FETCH_HEAD */
1589 if (!append && write_fetch_head) {
1590 retcode = truncate_fetch_head();
1591 if (retcode)
1592 goto cleanup;
1595 if (rs->nr) {
1596 int i;
1598 refspec_ref_prefixes(rs, &transport_ls_refs_options.ref_prefixes);
1601 * We can avoid listing refs if all of them are exact
1602 * OIDs
1604 must_list_refs = 0;
1605 for (i = 0; i < rs->nr; i++) {
1606 if (!rs->items[i].exact_sha1) {
1607 must_list_refs = 1;
1608 break;
1611 } else {
1612 struct branch *branch = branch_get(NULL);
1614 if (transport->remote->fetch.nr)
1615 refspec_ref_prefixes(&transport->remote->fetch,
1616 &transport_ls_refs_options.ref_prefixes);
1617 if (branch_has_merge_config(branch) &&
1618 !strcmp(branch->remote_name, transport->remote->name)) {
1619 int i;
1620 for (i = 0; i < branch->merge_nr; i++) {
1621 strvec_push(&transport_ls_refs_options.ref_prefixes,
1622 branch->merge[i]->src);
1627 if (tags == TAGS_SET || tags == TAGS_DEFAULT) {
1628 must_list_refs = 1;
1629 if (transport_ls_refs_options.ref_prefixes.nr)
1630 strvec_push(&transport_ls_refs_options.ref_prefixes,
1631 "refs/tags/");
1634 if (must_list_refs) {
1635 trace2_region_enter("fetch", "remote_refs", the_repository);
1636 remote_refs = transport_get_remote_refs(transport,
1637 &transport_ls_refs_options);
1638 trace2_region_leave("fetch", "remote_refs", the_repository);
1639 } else
1640 remote_refs = NULL;
1642 transport_ls_refs_options_release(&transport_ls_refs_options);
1644 ref_map = get_ref_map(transport->remote, remote_refs, rs,
1645 tags, &autotags);
1646 if (!update_head_ok)
1647 check_not_current_branch(ref_map);
1649 retcode = open_fetch_head(&fetch_head);
1650 if (retcode)
1651 goto cleanup;
1653 display_state_init(&display_state, ref_map, transport->url,
1654 config->display_format);
1656 if (atomic_fetch) {
1657 transaction = ref_transaction_begin(&err);
1658 if (!transaction) {
1659 retcode = -1;
1660 goto cleanup;
1664 if (tags == TAGS_DEFAULT && autotags)
1665 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1666 if (prune) {
1668 * We only prune based on refspecs specified
1669 * explicitly (via command line or configuration); we
1670 * don't care whether --tags was specified.
1672 if (rs->nr) {
1673 retcode = prune_refs(&display_state, rs, transaction, ref_map);
1674 } else {
1675 retcode = prune_refs(&display_state, &transport->remote->fetch,
1676 transaction, ref_map);
1678 if (retcode != 0)
1679 retcode = 1;
1682 if (fetch_and_consume_refs(&display_state, transport, transaction, ref_map,
1683 &fetch_head, config)) {
1684 retcode = 1;
1685 goto cleanup;
1689 * If neither --no-tags nor --tags was specified, do automated tag
1690 * following.
1692 if (tags == TAGS_DEFAULT && autotags) {
1693 struct ref *tags_ref_map = NULL, **tail = &tags_ref_map;
1695 find_non_local_tags(remote_refs, transaction, &tags_ref_map, &tail);
1696 if (tags_ref_map) {
1698 * If backfilling of tags fails then we want to tell
1699 * the user so, but we have to continue regardless to
1700 * populate upstream information of the references we
1701 * have already fetched above. The exception though is
1702 * when `--atomic` is passed: in that case we'll abort
1703 * the transaction and don't commit anything.
1705 if (backfill_tags(&display_state, transport, transaction, tags_ref_map,
1706 &fetch_head, config))
1707 retcode = 1;
1710 free_refs(tags_ref_map);
1713 if (transaction) {
1714 if (retcode)
1715 goto cleanup;
1717 retcode = ref_transaction_commit(transaction, &err);
1718 if (retcode) {
1719 ref_transaction_free(transaction);
1720 transaction = NULL;
1721 goto cleanup;
1725 commit_fetch_head(&fetch_head);
1727 if (set_upstream) {
1728 struct branch *branch = branch_get("HEAD");
1729 struct ref *rm;
1730 struct ref *source_ref = NULL;
1733 * We're setting the upstream configuration for the
1734 * current branch. The relevant upstream is the
1735 * fetched branch that is meant to be merged with the
1736 * current one, i.e. the one fetched to FETCH_HEAD.
1738 * When there are several such branches, consider the
1739 * request ambiguous and err on the safe side by doing
1740 * nothing and just emit a warning.
1742 for (rm = ref_map; rm; rm = rm->next) {
1743 if (!rm->peer_ref) {
1744 if (source_ref) {
1745 warning(_("multiple branches detected, incompatible with --set-upstream"));
1746 goto cleanup;
1747 } else {
1748 source_ref = rm;
1752 if (source_ref) {
1753 if (!branch) {
1754 const char *shortname = source_ref->name;
1755 skip_prefix(shortname, "refs/heads/", &shortname);
1757 warning(_("could not set upstream of HEAD to '%s' from '%s' when "
1758 "it does not point to any branch."),
1759 shortname, transport->remote->name);
1760 goto cleanup;
1763 if (!strcmp(source_ref->name, "HEAD") ||
1764 starts_with(source_ref->name, "refs/heads/"))
1765 install_branch_config(0,
1766 branch->name,
1767 transport->remote->name,
1768 source_ref->name);
1769 else if (starts_with(source_ref->name, "refs/remotes/"))
1770 warning(_("not setting upstream for a remote remote-tracking branch"));
1771 else if (starts_with(source_ref->name, "refs/tags/"))
1772 warning(_("not setting upstream for a remote tag"));
1773 else
1774 warning(_("unknown branch type"));
1775 } else {
1776 warning(_("no source branch found;\n"
1777 "you need to specify exactly one branch with the --set-upstream option"));
1781 cleanup:
1782 if (retcode) {
1783 if (err.len) {
1784 error("%s", err.buf);
1785 strbuf_reset(&err);
1787 if (transaction && ref_transaction_abort(transaction, &err) &&
1788 err.len)
1789 error("%s", err.buf);
1792 display_state_release(&display_state);
1793 close_fetch_head(&fetch_head);
1794 strbuf_release(&err);
1795 free_refs(ref_map);
1796 return retcode;
1799 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
1801 struct string_list *list = priv;
1802 if (!remote->skip_default_update)
1803 string_list_append(list, remote->name);
1804 return 0;
1807 struct remote_group_data {
1808 const char *name;
1809 struct string_list *list;
1812 static int get_remote_group(const char *key, const char *value,
1813 const struct config_context *ctx UNUSED,
1814 void *priv)
1816 struct remote_group_data *g = priv;
1818 if (skip_prefix(key, "remotes.", &key) && !strcmp(key, g->name)) {
1819 /* split list by white space */
1820 while (*value) {
1821 size_t wordlen = strcspn(value, " \t\n");
1823 if (wordlen >= 1)
1824 string_list_append_nodup(g->list,
1825 xstrndup(value, wordlen));
1826 value += wordlen + (value[wordlen] != '\0');
1830 return 0;
1833 static int add_remote_or_group(const char *name, struct string_list *list)
1835 int prev_nr = list->nr;
1836 struct remote_group_data g;
1837 g.name = name; g.list = list;
1839 git_config(get_remote_group, &g);
1840 if (list->nr == prev_nr) {
1841 struct remote *remote = remote_get(name);
1842 if (!remote_is_configured(remote, 0))
1843 return 0;
1844 string_list_append(list, remote->name);
1846 return 1;
1849 static void add_options_to_argv(struct strvec *argv,
1850 const struct fetch_config *config)
1852 if (dry_run)
1853 strvec_push(argv, "--dry-run");
1854 if (prune != -1)
1855 strvec_push(argv, prune ? "--prune" : "--no-prune");
1856 if (prune_tags != -1)
1857 strvec_push(argv, prune_tags ? "--prune-tags" : "--no-prune-tags");
1858 if (update_head_ok)
1859 strvec_push(argv, "--update-head-ok");
1860 if (force)
1861 strvec_push(argv, "--force");
1862 if (keep)
1863 strvec_push(argv, "--keep");
1864 if (config->recurse_submodules == RECURSE_SUBMODULES_ON)
1865 strvec_push(argv, "--recurse-submodules");
1866 else if (config->recurse_submodules == RECURSE_SUBMODULES_OFF)
1867 strvec_push(argv, "--no-recurse-submodules");
1868 else if (config->recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND)
1869 strvec_push(argv, "--recurse-submodules=on-demand");
1870 if (tags == TAGS_SET)
1871 strvec_push(argv, "--tags");
1872 else if (tags == TAGS_UNSET)
1873 strvec_push(argv, "--no-tags");
1874 if (verbosity >= 2)
1875 strvec_push(argv, "-v");
1876 if (verbosity >= 1)
1877 strvec_push(argv, "-v");
1878 else if (verbosity < 0)
1879 strvec_push(argv, "-q");
1880 if (family == TRANSPORT_FAMILY_IPV4)
1881 strvec_push(argv, "--ipv4");
1882 else if (family == TRANSPORT_FAMILY_IPV6)
1883 strvec_push(argv, "--ipv6");
1884 if (!write_fetch_head)
1885 strvec_push(argv, "--no-write-fetch-head");
1886 if (config->display_format == DISPLAY_FORMAT_PORCELAIN)
1887 strvec_pushf(argv, "--porcelain");
1890 /* Fetch multiple remotes in parallel */
1892 struct parallel_fetch_state {
1893 const char **argv;
1894 struct string_list *remotes;
1895 int next, result;
1896 const struct fetch_config *config;
1899 static int fetch_next_remote(struct child_process *cp,
1900 struct strbuf *out UNUSED,
1901 void *cb, void **task_cb)
1903 struct parallel_fetch_state *state = cb;
1904 char *remote;
1906 if (state->next < 0 || state->next >= state->remotes->nr)
1907 return 0;
1909 remote = state->remotes->items[state->next++].string;
1910 *task_cb = remote;
1912 strvec_pushv(&cp->args, state->argv);
1913 strvec_push(&cp->args, remote);
1914 cp->git_cmd = 1;
1916 if (verbosity >= 0 && state->config->display_format != DISPLAY_FORMAT_PORCELAIN)
1917 printf(_("Fetching %s\n"), remote);
1919 return 1;
1922 static int fetch_failed_to_start(struct strbuf *out UNUSED,
1923 void *cb, void *task_cb)
1925 struct parallel_fetch_state *state = cb;
1926 const char *remote = task_cb;
1928 state->result = error(_("could not fetch %s"), remote);
1930 return 0;
1933 static int fetch_finished(int result, struct strbuf *out,
1934 void *cb, void *task_cb)
1936 struct parallel_fetch_state *state = cb;
1937 const char *remote = task_cb;
1939 if (result) {
1940 strbuf_addf(out, _("could not fetch '%s' (exit code: %d)\n"),
1941 remote, result);
1942 state->result = -1;
1945 return 0;
1948 static int fetch_multiple(struct string_list *list, int max_children,
1949 const struct fetch_config *config)
1951 int i, result = 0;
1952 struct strvec argv = STRVEC_INIT;
1954 if (!append && write_fetch_head) {
1955 int errcode = truncate_fetch_head();
1956 if (errcode)
1957 return errcode;
1961 * Cancel out the fetch.bundleURI config when running subprocesses,
1962 * to avoid fetching from the same bundle list multiple times.
1964 strvec_pushl(&argv, "-c", "fetch.bundleURI=",
1965 "fetch", "--append", "--no-auto-gc",
1966 "--no-write-commit-graph", NULL);
1967 add_options_to_argv(&argv, config);
1969 if (max_children != 1 && list->nr != 1) {
1970 struct parallel_fetch_state state = { argv.v, list, 0, 0, config };
1971 const struct run_process_parallel_opts opts = {
1972 .tr2_category = "fetch",
1973 .tr2_label = "parallel/fetch",
1975 .processes = max_children,
1977 .get_next_task = &fetch_next_remote,
1978 .start_failure = &fetch_failed_to_start,
1979 .task_finished = &fetch_finished,
1980 .data = &state,
1983 strvec_push(&argv, "--end-of-options");
1985 run_processes_parallel(&opts);
1986 result = state.result;
1987 } else
1988 for (i = 0; i < list->nr; i++) {
1989 const char *name = list->items[i].string;
1990 struct child_process cmd = CHILD_PROCESS_INIT;
1992 strvec_pushv(&cmd.args, argv.v);
1993 strvec_push(&cmd.args, name);
1994 if (verbosity >= 0 && config->display_format != DISPLAY_FORMAT_PORCELAIN)
1995 printf(_("Fetching %s\n"), name);
1996 cmd.git_cmd = 1;
1997 if (run_command(&cmd)) {
1998 error(_("could not fetch %s"), name);
1999 result = 1;
2003 strvec_clear(&argv);
2004 return !!result;
2008 * Fetching from the promisor remote should use the given filter-spec
2009 * or inherit the default filter-spec from the config.
2011 static inline void fetch_one_setup_partial(struct remote *remote)
2014 * Explicit --no-filter argument overrides everything, regardless
2015 * of any prior partial clones and fetches.
2017 if (filter_options.no_filter)
2018 return;
2021 * If no prior partial clone/fetch and the current fetch DID NOT
2022 * request a partial-fetch, do a normal fetch.
2024 if (!repo_has_promisor_remote(the_repository) && !filter_options.choice)
2025 return;
2028 * If this is a partial-fetch request, we enable partial on
2029 * this repo if not already enabled and remember the given
2030 * filter-spec as the default for subsequent fetches to this
2031 * remote if there is currently no default filter-spec.
2033 if (filter_options.choice) {
2034 partial_clone_register(remote->name, &filter_options);
2035 return;
2039 * Do a partial-fetch from the promisor remote using either the
2040 * explicitly given filter-spec or inherit the filter-spec from
2041 * the config.
2043 if (!filter_options.choice)
2044 partial_clone_get_default_filter_spec(&filter_options, remote->name);
2045 return;
2048 static int fetch_one(struct remote *remote, int argc, const char **argv,
2049 int prune_tags_ok, int use_stdin_refspecs,
2050 const struct fetch_config *config)
2052 struct refspec rs = REFSPEC_INIT_FETCH;
2053 int i;
2054 int exit_code;
2055 int maybe_prune_tags;
2056 int remote_via_config = remote_is_configured(remote, 0);
2058 if (!remote)
2059 die(_("no remote repository specified; please specify either a URL or a\n"
2060 "remote name from which new revisions should be fetched"));
2062 gtransport = prepare_transport(remote, 1);
2064 if (prune < 0) {
2065 /* no command line request */
2066 if (0 <= remote->prune)
2067 prune = remote->prune;
2068 else if (0 <= config->prune)
2069 prune = config->prune;
2070 else
2071 prune = PRUNE_BY_DEFAULT;
2074 if (prune_tags < 0) {
2075 /* no command line request */
2076 if (0 <= remote->prune_tags)
2077 prune_tags = remote->prune_tags;
2078 else if (0 <= config->prune_tags)
2079 prune_tags = config->prune_tags;
2080 else
2081 prune_tags = PRUNE_TAGS_BY_DEFAULT;
2084 maybe_prune_tags = prune_tags_ok && prune_tags;
2085 if (maybe_prune_tags && remote_via_config)
2086 refspec_append(&remote->fetch, TAG_REFSPEC);
2088 if (maybe_prune_tags && (argc || !remote_via_config))
2089 refspec_append(&rs, TAG_REFSPEC);
2091 for (i = 0; i < argc; i++) {
2092 if (!strcmp(argv[i], "tag")) {
2093 i++;
2094 if (i >= argc)
2095 die(_("you need to specify a tag name"));
2097 refspec_appendf(&rs, "refs/tags/%s:refs/tags/%s",
2098 argv[i], argv[i]);
2099 } else {
2100 refspec_append(&rs, argv[i]);
2104 if (use_stdin_refspecs) {
2105 struct strbuf line = STRBUF_INIT;
2106 while (strbuf_getline_lf(&line, stdin) != EOF)
2107 refspec_append(&rs, line.buf);
2108 strbuf_release(&line);
2111 if (server_options.nr)
2112 gtransport->server_options = &server_options;
2114 sigchain_push_common(unlock_pack_on_signal);
2115 atexit(unlock_pack_atexit);
2116 sigchain_push(SIGPIPE, SIG_IGN);
2117 exit_code = do_fetch(gtransport, &rs, config);
2118 sigchain_pop(SIGPIPE);
2119 refspec_clear(&rs);
2120 transport_disconnect(gtransport);
2121 gtransport = NULL;
2122 return exit_code;
2125 int cmd_fetch(int argc, const char **argv, const char *prefix)
2127 struct fetch_config config = {
2128 .display_format = DISPLAY_FORMAT_FULL,
2129 .prune = -1,
2130 .prune_tags = -1,
2131 .show_forced_updates = 1,
2132 .recurse_submodules = RECURSE_SUBMODULES_DEFAULT,
2133 .parallel = 1,
2134 .submodule_fetch_jobs = -1,
2136 const char *submodule_prefix = "";
2137 const char *bundle_uri;
2138 struct string_list list = STRING_LIST_INIT_DUP;
2139 struct remote *remote = NULL;
2140 int all = -1, multiple = 0;
2141 int result = 0;
2142 int prune_tags_ok = 1;
2143 int enable_auto_gc = 1;
2144 int unshallow = 0;
2145 int max_jobs = -1;
2146 int recurse_submodules_cli = RECURSE_SUBMODULES_DEFAULT;
2147 int recurse_submodules_default = RECURSE_SUBMODULES_ON_DEMAND;
2148 int fetch_write_commit_graph = -1;
2149 int stdin_refspecs = 0;
2150 int negotiate_only = 0;
2151 int porcelain = 0;
2152 int i;
2154 struct option builtin_fetch_options[] = {
2155 OPT__VERBOSITY(&verbosity),
2156 OPT_BOOL(0, "all", &all,
2157 N_("fetch from all remotes")),
2158 OPT_BOOL(0, "set-upstream", &set_upstream,
2159 N_("set upstream for git pull/fetch")),
2160 OPT_BOOL('a', "append", &append,
2161 N_("append to .git/FETCH_HEAD instead of overwriting")),
2162 OPT_BOOL(0, "atomic", &atomic_fetch,
2163 N_("use atomic transaction to update references")),
2164 OPT_STRING(0, "upload-pack", &upload_pack, N_("path"),
2165 N_("path to upload pack on remote end")),
2166 OPT__FORCE(&force, N_("force overwrite of local reference"), 0),
2167 OPT_BOOL('m', "multiple", &multiple,
2168 N_("fetch from multiple remotes")),
2169 OPT_SET_INT('t', "tags", &tags,
2170 N_("fetch all tags and associated objects"), TAGS_SET),
2171 OPT_SET_INT('n', NULL, &tags,
2172 N_("do not fetch all tags (--no-tags)"), TAGS_UNSET),
2173 OPT_INTEGER('j', "jobs", &max_jobs,
2174 N_("number of submodules fetched in parallel")),
2175 OPT_BOOL(0, "prefetch", &prefetch,
2176 N_("modify the refspec to place all refs within refs/prefetch/")),
2177 OPT_BOOL('p', "prune", &prune,
2178 N_("prune remote-tracking branches no longer on remote")),
2179 OPT_BOOL('P', "prune-tags", &prune_tags,
2180 N_("prune local tags no longer on remote and clobber changed tags")),
2181 OPT_CALLBACK_F(0, "recurse-submodules", &recurse_submodules_cli, N_("on-demand"),
2182 N_("control recursive fetching of submodules"),
2183 PARSE_OPT_OPTARG, option_fetch_parse_recurse_submodules),
2184 OPT_BOOL(0, "dry-run", &dry_run,
2185 N_("dry run")),
2186 OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
2187 OPT_BOOL(0, "write-fetch-head", &write_fetch_head,
2188 N_("write fetched references to the FETCH_HEAD file")),
2189 OPT_BOOL('k', "keep", &keep, N_("keep downloaded pack")),
2190 OPT_BOOL('u', "update-head-ok", &update_head_ok,
2191 N_("allow updating of HEAD ref")),
2192 OPT_BOOL(0, "progress", &progress, N_("force progress reporting")),
2193 OPT_STRING(0, "depth", &depth, N_("depth"),
2194 N_("deepen history of shallow clone")),
2195 OPT_STRING(0, "shallow-since", &deepen_since, N_("time"),
2196 N_("deepen history of shallow repository based on time")),
2197 OPT_STRING_LIST(0, "shallow-exclude", &deepen_not, N_("revision"),
2198 N_("deepen history of shallow clone, excluding rev")),
2199 OPT_INTEGER(0, "deepen", &deepen_relative,
2200 N_("deepen history of shallow clone")),
2201 OPT_SET_INT_F(0, "unshallow", &unshallow,
2202 N_("convert to a complete repository"),
2203 1, PARSE_OPT_NONEG),
2204 OPT_SET_INT_F(0, "refetch", &refetch,
2205 N_("re-fetch without negotiating common commits"),
2206 1, PARSE_OPT_NONEG),
2207 { OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, N_("dir"),
2208 N_("prepend this to submodule path output"), PARSE_OPT_HIDDEN },
2209 OPT_CALLBACK_F(0, "recurse-submodules-default",
2210 &recurse_submodules_default, N_("on-demand"),
2211 N_("default for recursive fetching of submodules "
2212 "(lower priority than config files)"),
2213 PARSE_OPT_HIDDEN, option_fetch_parse_recurse_submodules),
2214 OPT_BOOL(0, "update-shallow", &update_shallow,
2215 N_("accept refs that update .git/shallow")),
2216 OPT_CALLBACK_F(0, "refmap", &refmap, N_("refmap"),
2217 N_("specify fetch refmap"), PARSE_OPT_NONEG, parse_refmap_arg),
2218 OPT_STRING_LIST('o', "server-option", &server_options, N_("server-specific"), N_("option to transmit")),
2219 OPT_IPVERSION(&family),
2220 OPT_STRING_LIST(0, "negotiation-tip", &negotiation_tip, N_("revision"),
2221 N_("report that we have only objects reachable from this object")),
2222 OPT_BOOL(0, "negotiate-only", &negotiate_only,
2223 N_("do not fetch a packfile; instead, print ancestors of negotiation tips")),
2224 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
2225 OPT_BOOL(0, "auto-maintenance", &enable_auto_gc,
2226 N_("run 'maintenance --auto' after fetching")),
2227 OPT_BOOL(0, "auto-gc", &enable_auto_gc,
2228 N_("run 'maintenance --auto' after fetching")),
2229 OPT_BOOL(0, "show-forced-updates", &config.show_forced_updates,
2230 N_("check for forced-updates on all updated branches")),
2231 OPT_BOOL(0, "write-commit-graph", &fetch_write_commit_graph,
2232 N_("write the commit-graph after fetching")),
2233 OPT_BOOL(0, "stdin", &stdin_refspecs,
2234 N_("accept refspecs from stdin")),
2235 OPT_END()
2238 packet_trace_identity("fetch");
2240 /* Record the command line for the reflog */
2241 strbuf_addstr(&default_rla, "fetch");
2242 for (i = 1; i < argc; i++) {
2243 /* This handles non-URLs gracefully */
2244 char *anon = transport_anonymize_url(argv[i]);
2246 strbuf_addf(&default_rla, " %s", anon);
2247 free(anon);
2250 git_config(git_fetch_config, &config);
2251 if (the_repository->gitdir) {
2252 prepare_repo_settings(the_repository);
2253 the_repository->settings.command_requires_full_index = 0;
2256 argc = parse_options(argc, argv, prefix,
2257 builtin_fetch_options, builtin_fetch_usage, 0);
2259 if (recurse_submodules_cli != RECURSE_SUBMODULES_DEFAULT)
2260 config.recurse_submodules = recurse_submodules_cli;
2262 if (negotiate_only) {
2263 switch (recurse_submodules_cli) {
2264 case RECURSE_SUBMODULES_OFF:
2265 case RECURSE_SUBMODULES_DEFAULT:
2267 * --negotiate-only should never recurse into
2268 * submodules. Skip it by setting recurse_submodules to
2269 * RECURSE_SUBMODULES_OFF.
2271 config.recurse_submodules = RECURSE_SUBMODULES_OFF;
2272 break;
2274 default:
2275 die(_("options '%s' and '%s' cannot be used together"),
2276 "--negotiate-only", "--recurse-submodules");
2280 if (config.recurse_submodules != RECURSE_SUBMODULES_OFF) {
2281 int *sfjc = config.submodule_fetch_jobs == -1
2282 ? &config.submodule_fetch_jobs : NULL;
2283 int *rs = config.recurse_submodules == RECURSE_SUBMODULES_DEFAULT
2284 ? &config.recurse_submodules : NULL;
2286 fetch_config_from_gitmodules(sfjc, rs);
2290 if (porcelain) {
2291 switch (recurse_submodules_cli) {
2292 case RECURSE_SUBMODULES_OFF:
2293 case RECURSE_SUBMODULES_DEFAULT:
2295 * Reference updates in submodules would be ambiguous
2296 * in porcelain mode, so we reject this combination.
2298 config.recurse_submodules = RECURSE_SUBMODULES_OFF;
2299 break;
2301 default:
2302 die(_("options '%s' and '%s' cannot be used together"),
2303 "--porcelain", "--recurse-submodules");
2306 config.display_format = DISPLAY_FORMAT_PORCELAIN;
2309 if (negotiate_only && !negotiation_tip.nr)
2310 die(_("--negotiate-only needs one or more --negotiation-tip=*"));
2312 if (deepen_relative) {
2313 if (deepen_relative < 0)
2314 die(_("negative depth in --deepen is not supported"));
2315 if (depth)
2316 die(_("options '%s' and '%s' cannot be used together"), "--deepen", "--depth");
2317 depth = xstrfmt("%d", deepen_relative);
2319 if (unshallow) {
2320 if (depth)
2321 die(_("options '%s' and '%s' cannot be used together"), "--depth", "--unshallow");
2322 else if (!is_repository_shallow(the_repository))
2323 die(_("--unshallow on a complete repository does not make sense"));
2324 else
2325 depth = xstrfmt("%d", INFINITE_DEPTH);
2328 /* no need to be strict, transport_set_option() will validate it again */
2329 if (depth && atoi(depth) < 1)
2330 die(_("depth %s is not a positive number"), depth);
2331 if (depth || deepen_since || deepen_not.nr)
2332 deepen = 1;
2334 /* FETCH_HEAD never gets updated in --dry-run mode */
2335 if (dry_run)
2336 write_fetch_head = 0;
2338 if (!max_jobs)
2339 max_jobs = online_cpus();
2341 if (!git_config_get_string_tmp("fetch.bundleuri", &bundle_uri) &&
2342 fetch_bundle_uri(the_repository, bundle_uri, NULL))
2343 warning(_("failed to fetch bundles from '%s'"), bundle_uri);
2345 if (all < 0) {
2347 * no --[no-]all given;
2348 * only use config option if no remote was explicitly specified
2350 all = (!argc) ? config.all : 0;
2353 if (all) {
2354 if (argc == 1)
2355 die(_("fetch --all does not take a repository argument"));
2356 else if (argc > 1)
2357 die(_("fetch --all does not make sense with refspecs"));
2359 (void) for_each_remote(get_one_remote_for_fetch, &list);
2361 /* do not do fetch_multiple() of one */
2362 if (list.nr == 1)
2363 remote = remote_get(list.items[0].string);
2364 } else if (argc == 0) {
2365 /* No arguments -- use default remote */
2366 remote = remote_get(NULL);
2367 } else if (multiple) {
2368 /* All arguments are assumed to be remotes or groups */
2369 for (i = 0; i < argc; i++)
2370 if (!add_remote_or_group(argv[i], &list))
2371 die(_("no such remote or remote group: %s"),
2372 argv[i]);
2373 } else {
2374 /* Single remote or group */
2375 (void) add_remote_or_group(argv[0], &list);
2376 if (list.nr > 1) {
2377 /* More than one remote */
2378 if (argc > 1)
2379 die(_("fetching a group and specifying refspecs does not make sense"));
2380 } else {
2381 /* Zero or one remotes */
2382 remote = remote_get(argv[0]);
2383 prune_tags_ok = (argc == 1);
2384 argc--;
2385 argv++;
2388 string_list_remove_duplicates(&list, 0);
2390 if (negotiate_only) {
2391 struct oidset acked_commits = OIDSET_INIT;
2392 struct oidset_iter iter;
2393 const struct object_id *oid;
2395 if (!remote)
2396 die(_("must supply remote when using --negotiate-only"));
2397 gtransport = prepare_transport(remote, 1);
2398 if (gtransport->smart_options) {
2399 gtransport->smart_options->acked_commits = &acked_commits;
2400 } else {
2401 warning(_("protocol does not support --negotiate-only, exiting"));
2402 result = 1;
2403 goto cleanup;
2405 if (server_options.nr)
2406 gtransport->server_options = &server_options;
2407 result = transport_fetch_refs(gtransport, NULL);
2409 oidset_iter_init(&acked_commits, &iter);
2410 while ((oid = oidset_iter_next(&iter)))
2411 printf("%s\n", oid_to_hex(oid));
2412 oidset_clear(&acked_commits);
2413 } else if (remote) {
2414 if (filter_options.choice || repo_has_promisor_remote(the_repository))
2415 fetch_one_setup_partial(remote);
2416 result = fetch_one(remote, argc, argv, prune_tags_ok, stdin_refspecs,
2417 &config);
2418 } else {
2419 int max_children = max_jobs;
2421 if (filter_options.choice)
2422 die(_("--filter can only be used with the remote "
2423 "configured in extensions.partialclone"));
2425 if (atomic_fetch)
2426 die(_("--atomic can only be used when fetching "
2427 "from one remote"));
2429 if (stdin_refspecs)
2430 die(_("--stdin can only be used when fetching "
2431 "from one remote"));
2433 if (max_children < 0)
2434 max_children = config.parallel;
2436 /* TODO should this also die if we have a previous partial-clone? */
2437 result = fetch_multiple(&list, max_children, &config);
2441 * This is only needed after fetch_one(), which does not fetch
2442 * submodules by itself.
2444 * When we fetch from multiple remotes, fetch_multiple() has
2445 * already updated submodules to grab commits necessary for
2446 * the fetched history from each remote, so there is no need
2447 * to fetch submodules from here.
2449 if (!result && remote && (config.recurse_submodules != RECURSE_SUBMODULES_OFF)) {
2450 struct strvec options = STRVEC_INIT;
2451 int max_children = max_jobs;
2453 if (max_children < 0)
2454 max_children = config.submodule_fetch_jobs;
2455 if (max_children < 0)
2456 max_children = config.parallel;
2458 add_options_to_argv(&options, &config);
2459 result = fetch_submodules(the_repository,
2460 &options,
2461 submodule_prefix,
2462 config.recurse_submodules,
2463 recurse_submodules_default,
2464 verbosity < 0,
2465 max_children);
2466 strvec_clear(&options);
2470 * Skip irrelevant tasks because we know objects were not
2471 * fetched.
2473 * NEEDSWORK: as a future optimization, we can return early
2474 * whenever objects were not fetched e.g. if we already have all
2475 * of them.
2477 if (negotiate_only)
2478 goto cleanup;
2480 prepare_repo_settings(the_repository);
2481 if (fetch_write_commit_graph > 0 ||
2482 (fetch_write_commit_graph < 0 &&
2483 the_repository->settings.fetch_write_commit_graph)) {
2484 int commit_graph_flags = COMMIT_GRAPH_WRITE_SPLIT;
2486 if (progress)
2487 commit_graph_flags |= COMMIT_GRAPH_WRITE_PROGRESS;
2489 write_commit_graph_reachable(the_repository->objects->odb,
2490 commit_graph_flags,
2491 NULL);
2494 if (enable_auto_gc) {
2495 if (refetch) {
2497 * Hint auto-maintenance strongly to encourage repacking,
2498 * but respect config settings disabling it.
2500 int opt_val;
2501 if (git_config_get_int("gc.autopacklimit", &opt_val))
2502 opt_val = -1;
2503 if (opt_val != 0)
2504 git_config_push_parameter("gc.autoPackLimit=1");
2506 if (git_config_get_int("maintenance.incremental-repack.auto", &opt_val))
2507 opt_val = -1;
2508 if (opt_val != 0)
2509 git_config_push_parameter("maintenance.incremental-repack.auto=-1");
2511 run_auto_maintenance(verbosity < 0);
2514 cleanup:
2515 string_list_clear(&list, 0);
2516 return result;