Start the 2.48 cycle
[git/gitster.git] / builtin / fetch.c
blob80a64d0d269ed60708d7533977f9ba5c51a4b084
1 /*
2 * "git fetch"
3 */
4 #define USE_THE_REPOSITORY_VARIABLE
5 #include "builtin.h"
6 #include "advice.h"
7 #include "config.h"
8 #include "gettext.h"
9 #include "environment.h"
10 #include "hex.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);
459 free(rs->raw[i]);
461 for (j = i + 1; j < rs->nr; j++) {
462 rs->items[j - 1] = rs->items[j];
463 rs->raw[j - 1] = rs->raw[j];
465 rs->nr--;
466 i--;
467 continue;
470 old_dst = rs->items[i].dst;
471 strbuf_addstr(&new_dst, ref_namespace[NAMESPACE_PREFETCH].ref);
474 * If old_dst starts with "refs/", then place
475 * sub after that prefix. Otherwise, start at
476 * the beginning of the string.
478 if (!skip_prefix(old_dst, "refs/", &sub))
479 sub = old_dst;
480 strbuf_addstr(&new_dst, sub);
482 rs->items[i].dst = strbuf_detach(&new_dst, NULL);
483 rs->items[i].force = 1;
485 free(old_dst);
489 static struct ref *get_ref_map(struct remote *remote,
490 const struct ref *remote_refs,
491 struct refspec *rs,
492 int tags, int *autotags)
494 int i;
495 struct ref *rm;
496 struct ref *ref_map = NULL;
497 struct ref **tail = &ref_map;
499 /* opportunistically-updated references: */
500 struct ref *orefs = NULL, **oref_tail = &orefs;
502 struct hashmap existing_refs;
503 int existing_refs_populated = 0;
505 filter_prefetch_refspec(rs);
506 if (remote)
507 filter_prefetch_refspec(&remote->fetch);
509 if (rs->nr) {
510 struct refspec *fetch_refspec;
512 for (i = 0; i < rs->nr; i++) {
513 get_fetch_map(remote_refs, &rs->items[i], &tail, 0);
514 if (rs->items[i].dst && rs->items[i].dst[0])
515 *autotags = 1;
517 /* Merge everything on the command line (but not --tags) */
518 for (rm = ref_map; rm; rm = rm->next)
519 rm->fetch_head_status = FETCH_HEAD_MERGE;
522 * For any refs that we happen to be fetching via
523 * command-line arguments, the destination ref might
524 * have been missing or have been different than the
525 * remote-tracking ref that would be derived from the
526 * configured refspec. In these cases, we want to
527 * take the opportunity to update their configured
528 * remote-tracking reference. However, we do not want
529 * to mention these entries in FETCH_HEAD at all, as
530 * they would simply be duplicates of existing
531 * entries, so we set them FETCH_HEAD_IGNORE below.
533 * We compute these entries now, based only on the
534 * refspecs specified on the command line. But we add
535 * them to the list following the refspecs resulting
536 * from the tags option so that one of the latter,
537 * which has FETCH_HEAD_NOT_FOR_MERGE, is not removed
538 * by ref_remove_duplicates() in favor of one of these
539 * opportunistic entries with FETCH_HEAD_IGNORE.
541 if (refmap.nr)
542 fetch_refspec = &refmap;
543 else
544 fetch_refspec = &remote->fetch;
546 for (i = 0; i < fetch_refspec->nr; i++)
547 get_fetch_map(ref_map, &fetch_refspec->items[i], &oref_tail, 1);
548 } else if (refmap.nr) {
549 die("--refmap option is only meaningful with command-line refspec(s)");
550 } else {
551 /* Use the defaults */
552 struct branch *branch = branch_get(NULL);
553 int has_merge = branch_has_merge_config(branch);
554 if (remote &&
555 (remote->fetch.nr ||
556 /* Note: has_merge implies non-NULL branch->remote_name */
557 (has_merge && !strcmp(branch->remote_name, remote->name)))) {
558 for (i = 0; i < remote->fetch.nr; i++) {
559 get_fetch_map(remote_refs, &remote->fetch.items[i], &tail, 0);
560 if (remote->fetch.items[i].dst &&
561 remote->fetch.items[i].dst[0])
562 *autotags = 1;
563 if (!i && !has_merge && ref_map &&
564 !remote->fetch.items[0].pattern)
565 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
568 * if the remote we're fetching from is the same
569 * as given in branch.<name>.remote, we add the
570 * ref given in branch.<name>.merge, too.
572 * Note: has_merge implies non-NULL branch->remote_name
574 if (has_merge &&
575 !strcmp(branch->remote_name, remote->name))
576 add_merge_config(&ref_map, remote_refs, branch, &tail);
577 } else if (!prefetch) {
578 ref_map = get_remote_ref(remote_refs, "HEAD");
579 if (!ref_map)
580 die(_("couldn't find remote ref HEAD"));
581 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
582 tail = &ref_map->next;
586 if (tags == TAGS_SET) {
587 struct refspec_item tag_refspec;
589 /* also fetch all tags */
590 refspec_item_init(&tag_refspec, TAG_REFSPEC, 0);
591 get_fetch_map(remote_refs, &tag_refspec, &tail, 0);
592 refspec_item_clear(&tag_refspec);
593 } else if (tags == TAGS_DEFAULT && *autotags) {
594 find_non_local_tags(remote_refs, NULL, &ref_map, &tail);
597 /* Now append any refs to be updated opportunistically: */
598 *tail = orefs;
599 for (rm = orefs; rm; rm = rm->next) {
600 rm->fetch_head_status = FETCH_HEAD_IGNORE;
601 tail = &rm->next;
605 * apply negative refspecs first, before we remove duplicates. This is
606 * necessary as negative refspecs might remove an otherwise conflicting
607 * duplicate.
609 if (rs->nr)
610 ref_map = apply_negative_refspecs(ref_map, rs);
611 else
612 ref_map = apply_negative_refspecs(ref_map, &remote->fetch);
614 ref_map = ref_remove_duplicates(ref_map);
616 for (rm = ref_map; rm; rm = rm->next) {
617 if (rm->peer_ref) {
618 const char *refname = rm->peer_ref->name;
619 struct refname_hash_entry *peer_item;
620 unsigned int hash = strhash(refname);
622 if (!existing_refs_populated) {
623 refname_hash_init(&existing_refs);
624 refs_for_each_ref(get_main_ref_store(the_repository),
625 add_one_refname,
626 &existing_refs);
627 existing_refs_populated = 1;
630 peer_item = hashmap_get_entry_from_hash(&existing_refs,
631 hash, refname,
632 struct refname_hash_entry, ent);
633 if (peer_item) {
634 struct object_id *old_oid = &peer_item->oid;
635 oidcpy(&rm->peer_ref->old_oid, old_oid);
639 if (existing_refs_populated)
640 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
642 return ref_map;
645 #define STORE_REF_ERROR_OTHER 1
646 #define STORE_REF_ERROR_DF_CONFLICT 2
648 static int s_update_ref(const char *action,
649 struct ref *ref,
650 struct ref_transaction *transaction,
651 int check_old)
653 char *msg;
654 char *rla = getenv("GIT_REFLOG_ACTION");
655 struct ref_transaction *our_transaction = NULL;
656 struct strbuf err = STRBUF_INIT;
657 int ret;
659 if (dry_run)
660 return 0;
661 if (!rla)
662 rla = default_rla.buf;
663 msg = xstrfmt("%s: %s", rla, action);
666 * If no transaction was passed to us, we manage the transaction
667 * ourselves. Otherwise, we trust the caller to handle the transaction
668 * lifecycle.
670 if (!transaction) {
671 transaction = our_transaction = ref_store_transaction_begin(get_main_ref_store(the_repository),
672 &err);
673 if (!transaction) {
674 ret = STORE_REF_ERROR_OTHER;
675 goto out;
679 ret = ref_transaction_update(transaction, ref->name, &ref->new_oid,
680 check_old ? &ref->old_oid : NULL,
681 NULL, NULL, 0, msg, &err);
682 if (ret) {
683 ret = STORE_REF_ERROR_OTHER;
684 goto out;
687 if (our_transaction) {
688 switch (ref_transaction_commit(our_transaction, &err)) {
689 case 0:
690 break;
691 case TRANSACTION_NAME_CONFLICT:
692 ret = STORE_REF_ERROR_DF_CONFLICT;
693 goto out;
694 default:
695 ret = STORE_REF_ERROR_OTHER;
696 goto out;
700 out:
701 ref_transaction_free(our_transaction);
702 if (ret)
703 error("%s", err.buf);
704 strbuf_release(&err);
705 free(msg);
706 return ret;
709 static int refcol_width(const struct ref *ref_map, int compact_format)
711 const struct ref *ref;
712 int max, width = 10;
714 max = term_columns();
715 if (compact_format)
716 max = max * 2 / 3;
718 for (ref = ref_map; ref; ref = ref->next) {
719 int rlen, llen = 0, len;
721 if (ref->status == REF_STATUS_REJECT_SHALLOW ||
722 !ref->peer_ref ||
723 !strcmp(ref->name, "HEAD"))
724 continue;
726 /* uptodate lines are only shown on high verbosity level */
727 if (verbosity <= 0 && oideq(&ref->peer_ref->old_oid, &ref->old_oid))
728 continue;
730 rlen = utf8_strwidth(prettify_refname(ref->name));
731 if (!compact_format)
732 llen = utf8_strwidth(prettify_refname(ref->peer_ref->name));
735 * rough estimation to see if the output line is too long and
736 * should not be counted (we can't do precise calculation
737 * anyway because we don't know if the error explanation part
738 * will be printed in update_local_ref)
740 len = 21 /* flag and summary */ + rlen + 4 /* -> */ + llen;
741 if (len >= max)
742 continue;
744 if (width < rlen)
745 width = rlen;
748 return width;
751 static void display_state_init(struct display_state *display_state, struct ref *ref_map,
752 const char *raw_url, enum display_format format)
754 int i;
756 memset(display_state, 0, sizeof(*display_state));
757 strbuf_init(&display_state->buf, 0);
758 display_state->format = format;
760 if (raw_url)
761 display_state->url = transport_anonymize_url(raw_url);
762 else
763 display_state->url = xstrdup("foreign");
765 display_state->url_len = strlen(display_state->url);
766 for (i = display_state->url_len - 1; display_state->url[i] == '/' && 0 <= i; i--)
768 display_state->url_len = i + 1;
769 if (4 < i && !strncmp(".git", display_state->url + i - 3, 4))
770 display_state->url_len = i - 3;
772 if (verbosity < 0)
773 return;
775 switch (display_state->format) {
776 case DISPLAY_FORMAT_FULL:
777 case DISPLAY_FORMAT_COMPACT:
778 display_state->refcol_width = refcol_width(ref_map,
779 display_state->format == DISPLAY_FORMAT_COMPACT);
780 break;
781 case DISPLAY_FORMAT_PORCELAIN:
782 /* We don't need to precompute anything here. */
783 break;
784 default:
785 BUG("unexpected display format %d", display_state->format);
789 static void display_state_release(struct display_state *display_state)
791 strbuf_release(&display_state->buf);
792 free(display_state->url);
795 static void print_remote_to_local(struct display_state *display_state,
796 const char *remote, const char *local)
798 strbuf_addf(&display_state->buf, "%-*s -> %s",
799 display_state->refcol_width, remote, local);
802 static int find_and_replace(struct strbuf *haystack,
803 const char *needle,
804 const char *placeholder)
806 const char *p = NULL;
807 int plen, nlen;
809 nlen = strlen(needle);
810 if (ends_with(haystack->buf, needle))
811 p = haystack->buf + haystack->len - nlen;
812 else
813 p = strstr(haystack->buf, needle);
814 if (!p)
815 return 0;
817 if (p > haystack->buf && p[-1] != '/')
818 return 0;
820 plen = strlen(p);
821 if (plen > nlen && p[nlen] != '/')
822 return 0;
824 strbuf_splice(haystack, p - haystack->buf, nlen,
825 placeholder, strlen(placeholder));
826 return 1;
829 static void print_compact(struct display_state *display_state,
830 const char *remote, const char *local)
832 struct strbuf r = STRBUF_INIT;
833 struct strbuf l = STRBUF_INIT;
835 if (!strcmp(remote, local)) {
836 strbuf_addf(&display_state->buf, "%-*s -> *", display_state->refcol_width, remote);
837 return;
840 strbuf_addstr(&r, remote);
841 strbuf_addstr(&l, local);
843 if (!find_and_replace(&r, local, "*"))
844 find_and_replace(&l, remote, "*");
845 print_remote_to_local(display_state, r.buf, l.buf);
847 strbuf_release(&r);
848 strbuf_release(&l);
851 static void display_ref_update(struct display_state *display_state, char code,
852 const char *summary, const char *error,
853 const char *remote, const char *local,
854 const struct object_id *old_oid,
855 const struct object_id *new_oid,
856 int summary_width)
858 FILE *f = stderr;
860 if (verbosity < 0)
861 return;
863 strbuf_reset(&display_state->buf);
865 switch (display_state->format) {
866 case DISPLAY_FORMAT_FULL:
867 case DISPLAY_FORMAT_COMPACT: {
868 int width;
870 if (!display_state->shown_url) {
871 strbuf_addf(&display_state->buf, _("From %.*s\n"),
872 display_state->url_len, display_state->url);
873 display_state->shown_url = 1;
876 width = (summary_width + strlen(summary) - gettext_width(summary));
877 remote = prettify_refname(remote);
878 local = prettify_refname(local);
880 strbuf_addf(&display_state->buf, " %c %-*s ", code, width, summary);
882 if (display_state->format != DISPLAY_FORMAT_COMPACT)
883 print_remote_to_local(display_state, remote, local);
884 else
885 print_compact(display_state, remote, local);
887 if (error)
888 strbuf_addf(&display_state->buf, " (%s)", error);
890 break;
892 case DISPLAY_FORMAT_PORCELAIN:
893 strbuf_addf(&display_state->buf, "%c %s %s %s", code,
894 oid_to_hex(old_oid), oid_to_hex(new_oid), local);
895 f = stdout;
896 break;
897 default:
898 BUG("unexpected display format %d", display_state->format);
900 strbuf_addch(&display_state->buf, '\n');
902 fputs(display_state->buf.buf, f);
905 static int update_local_ref(struct ref *ref,
906 struct ref_transaction *transaction,
907 struct display_state *display_state,
908 const struct ref *remote_ref,
909 int summary_width,
910 const struct fetch_config *config)
912 struct commit *current = NULL, *updated;
913 int fast_forward = 0;
915 if (!repo_has_object_file(the_repository, &ref->new_oid))
916 die(_("object %s not found"), oid_to_hex(&ref->new_oid));
918 if (oideq(&ref->old_oid, &ref->new_oid)) {
919 if (verbosity > 0)
920 display_ref_update(display_state, '=', _("[up to date]"), NULL,
921 remote_ref->name, ref->name,
922 &ref->old_oid, &ref->new_oid, summary_width);
923 return 0;
926 if (!update_head_ok &&
927 !is_null_oid(&ref->old_oid) &&
928 branch_checked_out(ref->name)) {
930 * If this is the head, and it's not okay to update
931 * the head, and the old value of the head isn't empty...
933 display_ref_update(display_state, '!', _("[rejected]"),
934 _("can't fetch into checked-out branch"),
935 remote_ref->name, ref->name,
936 &ref->old_oid, &ref->new_oid, summary_width);
937 return 1;
940 if (!is_null_oid(&ref->old_oid) &&
941 starts_with(ref->name, "refs/tags/")) {
942 if (force || ref->force) {
943 int r;
944 r = s_update_ref("updating tag", ref, transaction, 0);
945 display_ref_update(display_state, r ? '!' : 't', _("[tag update]"),
946 r ? _("unable to update local ref") : NULL,
947 remote_ref->name, ref->name,
948 &ref->old_oid, &ref->new_oid, summary_width);
949 return r;
950 } else {
951 display_ref_update(display_state, '!', _("[rejected]"),
952 _("would clobber existing tag"),
953 remote_ref->name, ref->name,
954 &ref->old_oid, &ref->new_oid, summary_width);
955 return 1;
959 current = lookup_commit_reference_gently(the_repository,
960 &ref->old_oid, 1);
961 updated = lookup_commit_reference_gently(the_repository,
962 &ref->new_oid, 1);
963 if (!current || !updated) {
964 const char *msg;
965 const char *what;
966 int r;
968 * Nicely describe the new ref we're fetching.
969 * Base this on the remote's ref name, as it's
970 * more likely to follow a standard layout.
972 if (starts_with(remote_ref->name, "refs/tags/")) {
973 msg = "storing tag";
974 what = _("[new tag]");
975 } else if (starts_with(remote_ref->name, "refs/heads/")) {
976 msg = "storing head";
977 what = _("[new branch]");
978 } else {
979 msg = "storing ref";
980 what = _("[new ref]");
983 r = s_update_ref(msg, ref, transaction, 0);
984 display_ref_update(display_state, r ? '!' : '*', what,
985 r ? _("unable to update local ref") : NULL,
986 remote_ref->name, ref->name,
987 &ref->old_oid, &ref->new_oid, summary_width);
988 return r;
991 if (config->show_forced_updates) {
992 uint64_t t_before = getnanotime();
993 fast_forward = repo_in_merge_bases(the_repository, current,
994 updated);
995 if (fast_forward < 0)
996 exit(128);
997 forced_updates_ms += (getnanotime() - t_before) / 1000000;
998 } else {
999 fast_forward = 1;
1002 if (fast_forward) {
1003 struct strbuf quickref = STRBUF_INIT;
1004 int r;
1006 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
1007 strbuf_addstr(&quickref, "..");
1008 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
1009 r = s_update_ref("fast-forward", ref, transaction, 1);
1010 display_ref_update(display_state, r ? '!' : ' ', quickref.buf,
1011 r ? _("unable to update local ref") : NULL,
1012 remote_ref->name, ref->name,
1013 &ref->old_oid, &ref->new_oid, summary_width);
1014 strbuf_release(&quickref);
1015 return r;
1016 } else if (force || ref->force) {
1017 struct strbuf quickref = STRBUF_INIT;
1018 int r;
1019 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
1020 strbuf_addstr(&quickref, "...");
1021 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
1022 r = s_update_ref("forced-update", ref, transaction, 1);
1023 display_ref_update(display_state, r ? '!' : '+', quickref.buf,
1024 r ? _("unable to update local ref") : _("forced update"),
1025 remote_ref->name, ref->name,
1026 &ref->old_oid, &ref->new_oid, summary_width);
1027 strbuf_release(&quickref);
1028 return r;
1029 } else {
1030 display_ref_update(display_state, '!', _("[rejected]"), _("non-fast-forward"),
1031 remote_ref->name, ref->name,
1032 &ref->old_oid, &ref->new_oid, summary_width);
1033 return 1;
1037 static const struct object_id *iterate_ref_map(void *cb_data)
1039 struct ref **rm = cb_data;
1040 struct ref *ref = *rm;
1042 while (ref && ref->status == REF_STATUS_REJECT_SHALLOW)
1043 ref = ref->next;
1044 if (!ref)
1045 return NULL;
1046 *rm = ref->next;
1047 return &ref->old_oid;
1050 struct fetch_head {
1051 FILE *fp;
1052 struct strbuf buf;
1055 static int open_fetch_head(struct fetch_head *fetch_head)
1057 const char *filename = git_path_fetch_head(the_repository);
1059 if (write_fetch_head) {
1060 fetch_head->fp = fopen(filename, "a");
1061 if (!fetch_head->fp)
1062 return error_errno(_("cannot open '%s'"), filename);
1063 strbuf_init(&fetch_head->buf, 0);
1064 } else {
1065 fetch_head->fp = NULL;
1068 return 0;
1071 static void append_fetch_head(struct fetch_head *fetch_head,
1072 const struct object_id *old_oid,
1073 enum fetch_head_status fetch_head_status,
1074 const char *note,
1075 const char *url, size_t url_len)
1077 char old_oid_hex[GIT_MAX_HEXSZ + 1];
1078 const char *merge_status_marker;
1079 size_t i;
1081 if (!fetch_head->fp)
1082 return;
1084 switch (fetch_head_status) {
1085 case FETCH_HEAD_NOT_FOR_MERGE:
1086 merge_status_marker = "not-for-merge";
1087 break;
1088 case FETCH_HEAD_MERGE:
1089 merge_status_marker = "";
1090 break;
1091 default:
1092 /* do not write anything to FETCH_HEAD */
1093 return;
1096 strbuf_addf(&fetch_head->buf, "%s\t%s\t%s",
1097 oid_to_hex_r(old_oid_hex, old_oid), merge_status_marker, note);
1098 for (i = 0; i < url_len; ++i)
1099 if ('\n' == url[i])
1100 strbuf_addstr(&fetch_head->buf, "\\n");
1101 else
1102 strbuf_addch(&fetch_head->buf, url[i]);
1103 strbuf_addch(&fetch_head->buf, '\n');
1106 * When using an atomic fetch, we do not want to update FETCH_HEAD if
1107 * any of the reference updates fails. We thus have to write all
1108 * updates to a buffer first and only commit it as soon as all
1109 * references have been successfully updated.
1111 if (!atomic_fetch) {
1112 strbuf_write(&fetch_head->buf, fetch_head->fp);
1113 strbuf_reset(&fetch_head->buf);
1117 static void commit_fetch_head(struct fetch_head *fetch_head)
1119 if (!fetch_head->fp || !atomic_fetch)
1120 return;
1121 strbuf_write(&fetch_head->buf, fetch_head->fp);
1124 static void close_fetch_head(struct fetch_head *fetch_head)
1126 if (!fetch_head->fp)
1127 return;
1129 fclose(fetch_head->fp);
1130 strbuf_release(&fetch_head->buf);
1133 static const char warn_show_forced_updates[] =
1134 N_("fetch normally indicates which branches had a forced update,\n"
1135 "but that check has been disabled; to re-enable, use '--show-forced-updates'\n"
1136 "flag or run 'git config fetch.showForcedUpdates true'");
1137 static const char warn_time_show_forced_updates[] =
1138 N_("it took %.2f seconds to check forced updates; you can use\n"
1139 "'--no-show-forced-updates' or run 'git config fetch.showForcedUpdates false'\n"
1140 "to avoid this check\n");
1142 static int store_updated_refs(struct display_state *display_state,
1143 const char *remote_name,
1144 int connectivity_checked,
1145 struct ref_transaction *transaction, struct ref *ref_map,
1146 struct fetch_head *fetch_head,
1147 const struct fetch_config *config)
1149 int rc = 0;
1150 struct strbuf note = STRBUF_INIT;
1151 const char *what, *kind;
1152 struct ref *rm;
1153 int want_status;
1154 int summary_width = 0;
1156 if (verbosity >= 0)
1157 summary_width = transport_summary_width(ref_map);
1159 if (!connectivity_checked) {
1160 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1162 opt.exclude_hidden_refs_section = "fetch";
1163 rm = ref_map;
1164 if (check_connected(iterate_ref_map, &rm, &opt)) {
1165 rc = error(_("%s did not send all necessary objects"),
1166 display_state->url);
1167 goto abort;
1172 * We do a pass for each fetch_head_status type in their enum order, so
1173 * merged entries are written before not-for-merge. That lets readers
1174 * use FETCH_HEAD as a refname to refer to the ref to be merged.
1176 for (want_status = FETCH_HEAD_MERGE;
1177 want_status <= FETCH_HEAD_IGNORE;
1178 want_status++) {
1179 for (rm = ref_map; rm; rm = rm->next) {
1180 struct ref *ref = NULL;
1182 if (rm->status == REF_STATUS_REJECT_SHALLOW) {
1183 if (want_status == FETCH_HEAD_MERGE)
1184 warning(_("rejected %s because shallow roots are not allowed to be updated"),
1185 rm->peer_ref ? rm->peer_ref->name : rm->name);
1186 continue;
1190 * When writing FETCH_HEAD we need to determine whether
1191 * we already have the commit or not. If not, then the
1192 * reference is not for merge and needs to be written
1193 * to the reflog after other commits which we already
1194 * have. We're not interested in this property though
1195 * in case FETCH_HEAD is not to be updated, so we can
1196 * skip the classification in that case.
1198 if (fetch_head->fp) {
1199 struct commit *commit = NULL;
1202 * References in "refs/tags/" are often going to point
1203 * to annotated tags, which are not part of the
1204 * commit-graph. We thus only try to look up refs in
1205 * the graph which are not in that namespace to not
1206 * regress performance in repositories with many
1207 * annotated tags.
1209 if (!starts_with(rm->name, "refs/tags/"))
1210 commit = lookup_commit_in_graph(the_repository, &rm->old_oid);
1211 if (!commit) {
1212 commit = lookup_commit_reference_gently(the_repository,
1213 &rm->old_oid,
1215 if (!commit)
1216 rm->fetch_head_status = FETCH_HEAD_NOT_FOR_MERGE;
1220 if (rm->fetch_head_status != want_status)
1221 continue;
1223 if (rm->peer_ref) {
1224 ref = alloc_ref(rm->peer_ref->name);
1225 oidcpy(&ref->old_oid, &rm->peer_ref->old_oid);
1226 oidcpy(&ref->new_oid, &rm->old_oid);
1227 ref->force = rm->peer_ref->force;
1230 if (config->recurse_submodules != RECURSE_SUBMODULES_OFF &&
1231 (!rm->peer_ref || !oideq(&ref->old_oid, &ref->new_oid))) {
1232 check_for_new_submodule_commits(&rm->old_oid);
1235 if (!strcmp(rm->name, "HEAD")) {
1236 kind = "";
1237 what = "";
1238 } else if (skip_prefix(rm->name, "refs/heads/", &what)) {
1239 kind = "branch";
1240 } else if (skip_prefix(rm->name, "refs/tags/", &what)) {
1241 kind = "tag";
1242 } else if (skip_prefix(rm->name, "refs/remotes/", &what)) {
1243 kind = "remote-tracking branch";
1244 } else {
1245 kind = "";
1246 what = rm->name;
1249 strbuf_reset(&note);
1250 if (*what) {
1251 if (*kind)
1252 strbuf_addf(&note, "%s ", kind);
1253 strbuf_addf(&note, "'%s' of ", what);
1256 append_fetch_head(fetch_head, &rm->old_oid,
1257 rm->fetch_head_status,
1258 note.buf, display_state->url,
1259 display_state->url_len);
1261 if (ref) {
1262 rc |= update_local_ref(ref, transaction, display_state,
1263 rm, summary_width, config);
1264 free(ref);
1265 } else if (write_fetch_head || dry_run) {
1267 * Display fetches written to FETCH_HEAD (or
1268 * would be written to FETCH_HEAD, if --dry-run
1269 * is set).
1271 display_ref_update(display_state, '*',
1272 *kind ? kind : "branch", NULL,
1273 rm->name,
1274 "FETCH_HEAD",
1275 &rm->new_oid, &rm->old_oid,
1276 summary_width);
1281 if (rc & STORE_REF_ERROR_DF_CONFLICT)
1282 error(_("some local refs could not be updated; try running\n"
1283 " 'git remote prune %s' to remove any old, conflicting "
1284 "branches"), remote_name);
1286 if (advice_enabled(ADVICE_FETCH_SHOW_FORCED_UPDATES)) {
1287 if (!config->show_forced_updates) {
1288 warning(_(warn_show_forced_updates));
1289 } else if (forced_updates_ms > FORCED_UPDATES_DELAY_WARNING_IN_MS) {
1290 warning(_(warn_time_show_forced_updates),
1291 forced_updates_ms / 1000.0);
1295 abort:
1296 strbuf_release(&note);
1297 return rc;
1301 * We would want to bypass the object transfer altogether if
1302 * everything we are going to fetch already exists and is connected
1303 * locally.
1305 static int check_exist_and_connected(struct ref *ref_map)
1307 struct ref *rm = ref_map;
1308 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1309 struct ref *r;
1312 * If we are deepening a shallow clone we already have these
1313 * objects reachable. Running rev-list here will return with
1314 * a good (0) exit status and we'll bypass the fetch that we
1315 * really need to perform. Claiming failure now will ensure
1316 * we perform the network exchange to deepen our history.
1318 if (deepen)
1319 return -1;
1322 * Similarly, if we need to refetch, we always want to perform a full
1323 * fetch ignoring existing objects.
1325 if (refetch)
1326 return -1;
1330 * check_connected() allows objects to merely be promised, but
1331 * we need all direct targets to exist.
1333 for (r = rm; r; r = r->next) {
1334 if (!repo_has_object_file_with_flags(the_repository, &r->old_oid,
1335 OBJECT_INFO_SKIP_FETCH_OBJECT))
1336 return -1;
1339 opt.quiet = 1;
1340 opt.exclude_hidden_refs_section = "fetch";
1341 return check_connected(iterate_ref_map, &rm, &opt);
1344 static int fetch_and_consume_refs(struct display_state *display_state,
1345 struct transport *transport,
1346 struct ref_transaction *transaction,
1347 struct ref *ref_map,
1348 struct fetch_head *fetch_head,
1349 const struct fetch_config *config)
1351 int connectivity_checked = 1;
1352 int ret;
1355 * We don't need to perform a fetch in case we can already satisfy all
1356 * refs.
1358 ret = check_exist_and_connected(ref_map);
1359 if (ret) {
1360 trace2_region_enter("fetch", "fetch_refs", the_repository);
1361 ret = transport_fetch_refs(transport, ref_map);
1362 trace2_region_leave("fetch", "fetch_refs", the_repository);
1363 if (ret)
1364 goto out;
1365 connectivity_checked = transport->smart_options ?
1366 transport->smart_options->connectivity_checked : 0;
1369 trace2_region_enter("fetch", "consume_refs", the_repository);
1370 ret = store_updated_refs(display_state, transport->remote->name,
1371 connectivity_checked, transaction, ref_map,
1372 fetch_head, config);
1373 trace2_region_leave("fetch", "consume_refs", the_repository);
1375 out:
1376 transport_unlock_pack(transport, 0);
1377 return ret;
1380 static int prune_refs(struct display_state *display_state,
1381 struct refspec *rs,
1382 struct ref_transaction *transaction,
1383 struct ref *ref_map)
1385 int result = 0;
1386 struct ref *ref, *stale_refs = get_stale_heads(rs, ref_map);
1387 struct strbuf err = STRBUF_INIT;
1388 const char *dangling_msg = dry_run
1389 ? _(" (%s will become dangling)")
1390 : _(" (%s has become dangling)");
1392 if (!dry_run) {
1393 if (transaction) {
1394 for (ref = stale_refs; ref; ref = ref->next) {
1395 result = ref_transaction_delete(transaction, ref->name, NULL,
1396 NULL, 0, "fetch: prune", &err);
1397 if (result)
1398 goto cleanup;
1400 } else {
1401 struct string_list refnames = STRING_LIST_INIT_NODUP;
1403 for (ref = stale_refs; ref; ref = ref->next)
1404 string_list_append(&refnames, ref->name);
1406 result = refs_delete_refs(get_main_ref_store(the_repository),
1407 "fetch: prune", &refnames,
1409 string_list_clear(&refnames, 0);
1413 if (verbosity >= 0) {
1414 int summary_width = transport_summary_width(stale_refs);
1416 for (ref = stale_refs; ref; ref = ref->next) {
1417 display_ref_update(display_state, '-', _("[deleted]"), NULL,
1418 _("(none)"), ref->name,
1419 &ref->new_oid, &ref->old_oid,
1420 summary_width);
1421 refs_warn_dangling_symref(get_main_ref_store(the_repository),
1422 stderr, dangling_msg, ref->name);
1426 cleanup:
1427 strbuf_release(&err);
1428 free_refs(stale_refs);
1429 return result;
1432 static void check_not_current_branch(struct ref *ref_map)
1434 const char *path;
1435 for (; ref_map; ref_map = ref_map->next)
1436 if (ref_map->peer_ref &&
1437 starts_with(ref_map->peer_ref->name, "refs/heads/") &&
1438 (path = branch_checked_out(ref_map->peer_ref->name)))
1439 die(_("refusing to fetch into branch '%s' "
1440 "checked out at '%s'"),
1441 ref_map->peer_ref->name, path);
1444 static int truncate_fetch_head(void)
1446 const char *filename = git_path_fetch_head(the_repository);
1447 FILE *fp = fopen_for_writing(filename);
1449 if (!fp)
1450 return error_errno(_("cannot open '%s'"), filename);
1451 fclose(fp);
1452 return 0;
1455 static void set_option(struct transport *transport, const char *name, const char *value)
1457 int r = transport_set_option(transport, name, value);
1458 if (r < 0)
1459 die(_("option \"%s\" value \"%s\" is not valid for %s"),
1460 name, value, transport->url);
1461 if (r > 0)
1462 warning(_("option \"%s\" is ignored for %s"),
1463 name, transport->url);
1467 static int add_oid(const char *refname UNUSED,
1468 const char *referent UNUSED,
1469 const struct object_id *oid,
1470 int flags UNUSED, void *cb_data)
1472 struct oid_array *oids = cb_data;
1474 oid_array_append(oids, oid);
1475 return 0;
1478 static void add_negotiation_tips(struct git_transport_options *smart_options)
1480 struct oid_array *oids = xcalloc(1, sizeof(*oids));
1481 int i;
1483 for (i = 0; i < negotiation_tip.nr; i++) {
1484 const char *s = negotiation_tip.items[i].string;
1485 int old_nr;
1486 if (!has_glob_specials(s)) {
1487 struct object_id oid;
1488 if (repo_get_oid(the_repository, s, &oid))
1489 die(_("%s is not a valid object"), s);
1490 if (!has_object(the_repository, &oid, 0))
1491 die(_("the object %s does not exist"), s);
1492 oid_array_append(oids, &oid);
1493 continue;
1495 old_nr = oids->nr;
1496 refs_for_each_glob_ref(get_main_ref_store(the_repository),
1497 add_oid, s, oids);
1498 if (old_nr == oids->nr)
1499 warning("ignoring --negotiation-tip=%s because it does not match any refs",
1502 smart_options->negotiation_tips = oids;
1505 static struct transport *prepare_transport(struct remote *remote, int deepen)
1507 struct transport *transport;
1509 transport = transport_get(remote, NULL);
1510 transport_set_verbosity(transport, verbosity, progress);
1511 transport->family = family;
1512 if (upload_pack)
1513 set_option(transport, TRANS_OPT_UPLOADPACK, upload_pack);
1514 if (keep)
1515 set_option(transport, TRANS_OPT_KEEP, "yes");
1516 if (depth)
1517 set_option(transport, TRANS_OPT_DEPTH, depth);
1518 if (deepen && deepen_since)
1519 set_option(transport, TRANS_OPT_DEEPEN_SINCE, deepen_since);
1520 if (deepen && deepen_not.nr)
1521 set_option(transport, TRANS_OPT_DEEPEN_NOT,
1522 (const char *)&deepen_not);
1523 if (deepen_relative)
1524 set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, "yes");
1525 if (update_shallow)
1526 set_option(transport, TRANS_OPT_UPDATE_SHALLOW, "yes");
1527 if (refetch)
1528 set_option(transport, TRANS_OPT_REFETCH, "yes");
1529 if (filter_options.choice) {
1530 const char *spec =
1531 expand_list_objects_filter_spec(&filter_options);
1532 set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER, spec);
1533 set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1535 if (negotiation_tip.nr) {
1536 if (transport->smart_options)
1537 add_negotiation_tips(transport->smart_options);
1538 else
1539 warning("ignoring --negotiation-tip because the protocol does not support it");
1541 return transport;
1544 static int backfill_tags(struct display_state *display_state,
1545 struct transport *transport,
1546 struct ref_transaction *transaction,
1547 struct ref *ref_map,
1548 struct fetch_head *fetch_head,
1549 const struct fetch_config *config)
1551 int retcode, cannot_reuse;
1554 * Once we have set TRANS_OPT_DEEPEN_SINCE, we can't unset it
1555 * when remote helper is used (setting it to an empty string
1556 * is not unsetting). We could extend the remote helper
1557 * protocol for that, but for now, just force a new connection
1558 * without deepen-since. Similar story for deepen-not.
1560 cannot_reuse = transport->cannot_reuse ||
1561 deepen_since || deepen_not.nr;
1562 if (cannot_reuse) {
1563 gsecondary = prepare_transport(transport->remote, 0);
1564 transport = gsecondary;
1567 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
1568 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
1569 transport_set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, NULL);
1570 retcode = fetch_and_consume_refs(display_state, transport, transaction, ref_map,
1571 fetch_head, config);
1573 if (gsecondary) {
1574 transport_disconnect(gsecondary);
1575 gsecondary = NULL;
1578 return retcode;
1581 static int do_fetch(struct transport *transport,
1582 struct refspec *rs,
1583 const struct fetch_config *config)
1585 struct ref_transaction *transaction = NULL;
1586 struct ref *ref_map = NULL;
1587 struct display_state display_state = { 0 };
1588 int autotags = (transport->remote->fetch_tags == 1);
1589 int retcode = 0;
1590 const struct ref *remote_refs;
1591 struct transport_ls_refs_options transport_ls_refs_options =
1592 TRANSPORT_LS_REFS_OPTIONS_INIT;
1593 int must_list_refs = 1;
1594 struct fetch_head fetch_head = { 0 };
1595 struct strbuf err = STRBUF_INIT;
1597 if (tags == TAGS_DEFAULT) {
1598 if (transport->remote->fetch_tags == 2)
1599 tags = TAGS_SET;
1600 if (transport->remote->fetch_tags == -1)
1601 tags = TAGS_UNSET;
1604 /* if not appending, truncate FETCH_HEAD */
1605 if (!append && write_fetch_head) {
1606 retcode = truncate_fetch_head();
1607 if (retcode)
1608 goto cleanup;
1611 if (rs->nr) {
1612 int i;
1614 refspec_ref_prefixes(rs, &transport_ls_refs_options.ref_prefixes);
1617 * We can avoid listing refs if all of them are exact
1618 * OIDs
1620 must_list_refs = 0;
1621 for (i = 0; i < rs->nr; i++) {
1622 if (!rs->items[i].exact_sha1) {
1623 must_list_refs = 1;
1624 break;
1627 } else {
1628 struct branch *branch = branch_get(NULL);
1630 if (transport->remote->fetch.nr)
1631 refspec_ref_prefixes(&transport->remote->fetch,
1632 &transport_ls_refs_options.ref_prefixes);
1633 if (branch_has_merge_config(branch) &&
1634 !strcmp(branch->remote_name, transport->remote->name)) {
1635 int i;
1636 for (i = 0; i < branch->merge_nr; i++) {
1637 strvec_push(&transport_ls_refs_options.ref_prefixes,
1638 branch->merge[i]->src);
1643 if (tags == TAGS_SET || tags == TAGS_DEFAULT) {
1644 must_list_refs = 1;
1645 if (transport_ls_refs_options.ref_prefixes.nr)
1646 strvec_push(&transport_ls_refs_options.ref_prefixes,
1647 "refs/tags/");
1650 if (must_list_refs) {
1651 trace2_region_enter("fetch", "remote_refs", the_repository);
1652 remote_refs = transport_get_remote_refs(transport,
1653 &transport_ls_refs_options);
1654 trace2_region_leave("fetch", "remote_refs", the_repository);
1655 } else
1656 remote_refs = NULL;
1658 transport_ls_refs_options_release(&transport_ls_refs_options);
1660 ref_map = get_ref_map(transport->remote, remote_refs, rs,
1661 tags, &autotags);
1662 if (!update_head_ok)
1663 check_not_current_branch(ref_map);
1665 retcode = open_fetch_head(&fetch_head);
1666 if (retcode)
1667 goto cleanup;
1669 display_state_init(&display_state, ref_map, transport->url,
1670 config->display_format);
1672 if (atomic_fetch) {
1673 transaction = ref_store_transaction_begin(get_main_ref_store(the_repository),
1674 &err);
1675 if (!transaction) {
1676 retcode = -1;
1677 goto cleanup;
1681 if (tags == TAGS_DEFAULT && autotags)
1682 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1683 if (prune) {
1685 * We only prune based on refspecs specified
1686 * explicitly (via command line or configuration); we
1687 * don't care whether --tags was specified.
1689 if (rs->nr) {
1690 retcode = prune_refs(&display_state, rs, transaction, ref_map);
1691 } else {
1692 retcode = prune_refs(&display_state, &transport->remote->fetch,
1693 transaction, ref_map);
1695 if (retcode != 0)
1696 retcode = 1;
1699 if (fetch_and_consume_refs(&display_state, transport, transaction, ref_map,
1700 &fetch_head, config)) {
1701 retcode = 1;
1702 goto cleanup;
1706 * If neither --no-tags nor --tags was specified, do automated tag
1707 * following.
1709 if (tags == TAGS_DEFAULT && autotags) {
1710 struct ref *tags_ref_map = NULL, **tail = &tags_ref_map;
1712 find_non_local_tags(remote_refs, transaction, &tags_ref_map, &tail);
1713 if (tags_ref_map) {
1715 * If backfilling of tags fails then we want to tell
1716 * the user so, but we have to continue regardless to
1717 * populate upstream information of the references we
1718 * have already fetched above. The exception though is
1719 * when `--atomic` is passed: in that case we'll abort
1720 * the transaction and don't commit anything.
1722 if (backfill_tags(&display_state, transport, transaction, tags_ref_map,
1723 &fetch_head, config))
1724 retcode = 1;
1727 free_refs(tags_ref_map);
1730 if (transaction) {
1731 if (retcode)
1732 goto cleanup;
1734 retcode = ref_transaction_commit(transaction, &err);
1735 if (retcode)
1736 goto cleanup;
1739 commit_fetch_head(&fetch_head);
1741 if (set_upstream) {
1742 struct branch *branch = branch_get("HEAD");
1743 struct ref *rm;
1744 struct ref *source_ref = NULL;
1747 * We're setting the upstream configuration for the
1748 * current branch. The relevant upstream is the
1749 * fetched branch that is meant to be merged with the
1750 * current one, i.e. the one fetched to FETCH_HEAD.
1752 * When there are several such branches, consider the
1753 * request ambiguous and err on the safe side by doing
1754 * nothing and just emit a warning.
1756 for (rm = ref_map; rm; rm = rm->next) {
1757 if (!rm->peer_ref) {
1758 if (source_ref) {
1759 warning(_("multiple branches detected, incompatible with --set-upstream"));
1760 goto cleanup;
1761 } else {
1762 source_ref = rm;
1766 if (source_ref) {
1767 if (!branch) {
1768 const char *shortname = source_ref->name;
1769 skip_prefix(shortname, "refs/heads/", &shortname);
1771 warning(_("could not set upstream of HEAD to '%s' from '%s' when "
1772 "it does not point to any branch."),
1773 shortname, transport->remote->name);
1774 goto cleanup;
1777 if (!strcmp(source_ref->name, "HEAD") ||
1778 starts_with(source_ref->name, "refs/heads/"))
1779 install_branch_config(0,
1780 branch->name,
1781 transport->remote->name,
1782 source_ref->name);
1783 else if (starts_with(source_ref->name, "refs/remotes/"))
1784 warning(_("not setting upstream for a remote remote-tracking branch"));
1785 else if (starts_with(source_ref->name, "refs/tags/"))
1786 warning(_("not setting upstream for a remote tag"));
1787 else
1788 warning(_("unknown branch type"));
1789 } else {
1790 warning(_("no source branch found;\n"
1791 "you need to specify exactly one branch with the --set-upstream option"));
1795 cleanup:
1796 if (retcode) {
1797 if (err.len) {
1798 error("%s", err.buf);
1799 strbuf_reset(&err);
1801 if (transaction && ref_transaction_abort(transaction, &err) &&
1802 err.len)
1803 error("%s", err.buf);
1804 transaction = NULL;
1807 if (transaction)
1808 ref_transaction_free(transaction);
1809 display_state_release(&display_state);
1810 close_fetch_head(&fetch_head);
1811 strbuf_release(&err);
1812 free_refs(ref_map);
1813 return retcode;
1816 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
1818 struct string_list *list = priv;
1819 if (!remote->skip_default_update)
1820 string_list_append(list, remote->name);
1821 return 0;
1824 struct remote_group_data {
1825 const char *name;
1826 struct string_list *list;
1829 static int get_remote_group(const char *key, const char *value,
1830 const struct config_context *ctx UNUSED,
1831 void *priv)
1833 struct remote_group_data *g = priv;
1835 if (skip_prefix(key, "remotes.", &key) && !strcmp(key, g->name)) {
1836 /* split list by white space */
1837 while (*value) {
1838 size_t wordlen = strcspn(value, " \t\n");
1840 if (wordlen >= 1)
1841 string_list_append_nodup(g->list,
1842 xstrndup(value, wordlen));
1843 value += wordlen + (value[wordlen] != '\0');
1847 return 0;
1850 static int add_remote_or_group(const char *name, struct string_list *list)
1852 int prev_nr = list->nr;
1853 struct remote_group_data g;
1854 g.name = name; g.list = list;
1856 git_config(get_remote_group, &g);
1857 if (list->nr == prev_nr) {
1858 struct remote *remote = remote_get(name);
1859 if (!remote_is_configured(remote, 0))
1860 return 0;
1861 string_list_append(list, remote->name);
1863 return 1;
1866 static void add_options_to_argv(struct strvec *argv,
1867 const struct fetch_config *config)
1869 if (dry_run)
1870 strvec_push(argv, "--dry-run");
1871 if (prune != -1)
1872 strvec_push(argv, prune ? "--prune" : "--no-prune");
1873 if (prune_tags != -1)
1874 strvec_push(argv, prune_tags ? "--prune-tags" : "--no-prune-tags");
1875 if (update_head_ok)
1876 strvec_push(argv, "--update-head-ok");
1877 if (force)
1878 strvec_push(argv, "--force");
1879 if (keep)
1880 strvec_push(argv, "--keep");
1881 if (config->recurse_submodules == RECURSE_SUBMODULES_ON)
1882 strvec_push(argv, "--recurse-submodules");
1883 else if (config->recurse_submodules == RECURSE_SUBMODULES_OFF)
1884 strvec_push(argv, "--no-recurse-submodules");
1885 else if (config->recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND)
1886 strvec_push(argv, "--recurse-submodules=on-demand");
1887 if (tags == TAGS_SET)
1888 strvec_push(argv, "--tags");
1889 else if (tags == TAGS_UNSET)
1890 strvec_push(argv, "--no-tags");
1891 if (verbosity >= 2)
1892 strvec_push(argv, "-v");
1893 if (verbosity >= 1)
1894 strvec_push(argv, "-v");
1895 else if (verbosity < 0)
1896 strvec_push(argv, "-q");
1897 if (family == TRANSPORT_FAMILY_IPV4)
1898 strvec_push(argv, "--ipv4");
1899 else if (family == TRANSPORT_FAMILY_IPV6)
1900 strvec_push(argv, "--ipv6");
1901 if (!write_fetch_head)
1902 strvec_push(argv, "--no-write-fetch-head");
1903 if (config->display_format == DISPLAY_FORMAT_PORCELAIN)
1904 strvec_pushf(argv, "--porcelain");
1907 /* Fetch multiple remotes in parallel */
1909 struct parallel_fetch_state {
1910 const char **argv;
1911 struct string_list *remotes;
1912 int next, result;
1913 const struct fetch_config *config;
1916 static int fetch_next_remote(struct child_process *cp,
1917 struct strbuf *out UNUSED,
1918 void *cb, void **task_cb)
1920 struct parallel_fetch_state *state = cb;
1921 char *remote;
1923 if (state->next < 0 || state->next >= state->remotes->nr)
1924 return 0;
1926 remote = state->remotes->items[state->next++].string;
1927 *task_cb = remote;
1929 strvec_pushv(&cp->args, state->argv);
1930 strvec_push(&cp->args, remote);
1931 cp->git_cmd = 1;
1933 if (verbosity >= 0 && state->config->display_format != DISPLAY_FORMAT_PORCELAIN)
1934 printf(_("Fetching %s\n"), remote);
1936 return 1;
1939 static int fetch_failed_to_start(struct strbuf *out UNUSED,
1940 void *cb, void *task_cb)
1942 struct parallel_fetch_state *state = cb;
1943 const char *remote = task_cb;
1945 state->result = error(_("could not fetch %s"), remote);
1947 return 0;
1950 static int fetch_finished(int result, struct strbuf *out,
1951 void *cb, void *task_cb)
1953 struct parallel_fetch_state *state = cb;
1954 const char *remote = task_cb;
1956 if (result) {
1957 strbuf_addf(out, _("could not fetch '%s' (exit code: %d)\n"),
1958 remote, result);
1959 state->result = -1;
1962 return 0;
1965 static int fetch_multiple(struct string_list *list, int max_children,
1966 const struct fetch_config *config)
1968 int i, result = 0;
1969 struct strvec argv = STRVEC_INIT;
1971 if (!append && write_fetch_head) {
1972 int errcode = truncate_fetch_head();
1973 if (errcode)
1974 return errcode;
1978 * Cancel out the fetch.bundleURI config when running subprocesses,
1979 * to avoid fetching from the same bundle list multiple times.
1981 strvec_pushl(&argv, "-c", "fetch.bundleURI=",
1982 "fetch", "--append", "--no-auto-gc",
1983 "--no-write-commit-graph", NULL);
1984 add_options_to_argv(&argv, config);
1986 if (max_children != 1 && list->nr != 1) {
1987 struct parallel_fetch_state state = { argv.v, list, 0, 0, config };
1988 const struct run_process_parallel_opts opts = {
1989 .tr2_category = "fetch",
1990 .tr2_label = "parallel/fetch",
1992 .processes = max_children,
1994 .get_next_task = &fetch_next_remote,
1995 .start_failure = &fetch_failed_to_start,
1996 .task_finished = &fetch_finished,
1997 .data = &state,
2000 strvec_push(&argv, "--end-of-options");
2002 run_processes_parallel(&opts);
2003 result = state.result;
2004 } else
2005 for (i = 0; i < list->nr; i++) {
2006 const char *name = list->items[i].string;
2007 struct child_process cmd = CHILD_PROCESS_INIT;
2009 strvec_pushv(&cmd.args, argv.v);
2010 strvec_push(&cmd.args, name);
2011 if (verbosity >= 0 && config->display_format != DISPLAY_FORMAT_PORCELAIN)
2012 printf(_("Fetching %s\n"), name);
2013 cmd.git_cmd = 1;
2014 if (run_command(&cmd)) {
2015 error(_("could not fetch %s"), name);
2016 result = 1;
2020 strvec_clear(&argv);
2021 return !!result;
2025 * Fetching from the promisor remote should use the given filter-spec
2026 * or inherit the default filter-spec from the config.
2028 static inline void fetch_one_setup_partial(struct remote *remote)
2031 * Explicit --no-filter argument overrides everything, regardless
2032 * of any prior partial clones and fetches.
2034 if (filter_options.no_filter)
2035 return;
2038 * If no prior partial clone/fetch and the current fetch DID NOT
2039 * request a partial-fetch, do a normal fetch.
2041 if (!repo_has_promisor_remote(the_repository) && !filter_options.choice)
2042 return;
2045 * If this is a partial-fetch request, we enable partial on
2046 * this repo if not already enabled and remember the given
2047 * filter-spec as the default for subsequent fetches to this
2048 * remote if there is currently no default filter-spec.
2050 if (filter_options.choice) {
2051 partial_clone_register(remote->name, &filter_options);
2052 return;
2056 * Do a partial-fetch from the promisor remote using either the
2057 * explicitly given filter-spec or inherit the filter-spec from
2058 * the config.
2060 if (!filter_options.choice)
2061 partial_clone_get_default_filter_spec(&filter_options, remote->name);
2062 return;
2065 static int fetch_one(struct remote *remote, int argc, const char **argv,
2066 int prune_tags_ok, int use_stdin_refspecs,
2067 const struct fetch_config *config)
2069 struct refspec rs = REFSPEC_INIT_FETCH;
2070 int i;
2071 int exit_code;
2072 int maybe_prune_tags;
2073 int remote_via_config = remote_is_configured(remote, 0);
2075 if (!remote)
2076 die(_("no remote repository specified; please specify either a URL or a\n"
2077 "remote name from which new revisions should be fetched"));
2079 gtransport = prepare_transport(remote, 1);
2081 if (prune < 0) {
2082 /* no command line request */
2083 if (0 <= remote->prune)
2084 prune = remote->prune;
2085 else if (0 <= config->prune)
2086 prune = config->prune;
2087 else
2088 prune = PRUNE_BY_DEFAULT;
2091 if (prune_tags < 0) {
2092 /* no command line request */
2093 if (0 <= remote->prune_tags)
2094 prune_tags = remote->prune_tags;
2095 else if (0 <= config->prune_tags)
2096 prune_tags = config->prune_tags;
2097 else
2098 prune_tags = PRUNE_TAGS_BY_DEFAULT;
2101 maybe_prune_tags = prune_tags_ok && prune_tags;
2102 if (maybe_prune_tags && remote_via_config)
2103 refspec_append(&remote->fetch, TAG_REFSPEC);
2105 if (maybe_prune_tags && (argc || !remote_via_config))
2106 refspec_append(&rs, TAG_REFSPEC);
2108 for (i = 0; i < argc; i++) {
2109 if (!strcmp(argv[i], "tag")) {
2110 i++;
2111 if (i >= argc)
2112 die(_("you need to specify a tag name"));
2114 refspec_appendf(&rs, "refs/tags/%s:refs/tags/%s",
2115 argv[i], argv[i]);
2116 } else {
2117 refspec_append(&rs, argv[i]);
2121 if (use_stdin_refspecs) {
2122 struct strbuf line = STRBUF_INIT;
2123 while (strbuf_getline_lf(&line, stdin) != EOF)
2124 refspec_append(&rs, line.buf);
2125 strbuf_release(&line);
2128 if (server_options.nr)
2129 gtransport->server_options = &server_options;
2131 sigchain_push_common(unlock_pack_on_signal);
2132 atexit(unlock_pack_atexit);
2133 sigchain_push(SIGPIPE, SIG_IGN);
2134 exit_code = do_fetch(gtransport, &rs, config);
2135 sigchain_pop(SIGPIPE);
2136 refspec_clear(&rs);
2137 transport_disconnect(gtransport);
2138 gtransport = NULL;
2139 return exit_code;
2142 int cmd_fetch(int argc,
2143 const char **argv,
2144 const char *prefix,
2145 struct repository *repo UNUSED)
2147 struct fetch_config config = {
2148 .display_format = DISPLAY_FORMAT_FULL,
2149 .prune = -1,
2150 .prune_tags = -1,
2151 .show_forced_updates = 1,
2152 .recurse_submodules = RECURSE_SUBMODULES_DEFAULT,
2153 .parallel = 1,
2154 .submodule_fetch_jobs = -1,
2156 const char *submodule_prefix = "";
2157 const char *bundle_uri;
2158 struct string_list list = STRING_LIST_INIT_DUP;
2159 struct remote *remote = NULL;
2160 int all = -1, multiple = 0;
2161 int result = 0;
2162 int prune_tags_ok = 1;
2163 int enable_auto_gc = 1;
2164 int unshallow = 0;
2165 int max_jobs = -1;
2166 int recurse_submodules_cli = RECURSE_SUBMODULES_DEFAULT;
2167 int recurse_submodules_default = RECURSE_SUBMODULES_ON_DEMAND;
2168 int fetch_write_commit_graph = -1;
2169 int stdin_refspecs = 0;
2170 int negotiate_only = 0;
2171 int porcelain = 0;
2172 int i;
2174 struct option builtin_fetch_options[] = {
2175 OPT__VERBOSITY(&verbosity),
2176 OPT_BOOL(0, "all", &all,
2177 N_("fetch from all remotes")),
2178 OPT_BOOL(0, "set-upstream", &set_upstream,
2179 N_("set upstream for git pull/fetch")),
2180 OPT_BOOL('a', "append", &append,
2181 N_("append to .git/FETCH_HEAD instead of overwriting")),
2182 OPT_BOOL(0, "atomic", &atomic_fetch,
2183 N_("use atomic transaction to update references")),
2184 OPT_STRING(0, "upload-pack", &upload_pack, N_("path"),
2185 N_("path to upload pack on remote end")),
2186 OPT__FORCE(&force, N_("force overwrite of local reference"), 0),
2187 OPT_BOOL('m', "multiple", &multiple,
2188 N_("fetch from multiple remotes")),
2189 OPT_SET_INT('t', "tags", &tags,
2190 N_("fetch all tags and associated objects"), TAGS_SET),
2191 OPT_SET_INT('n', NULL, &tags,
2192 N_("do not fetch all tags (--no-tags)"), TAGS_UNSET),
2193 OPT_INTEGER('j', "jobs", &max_jobs,
2194 N_("number of submodules fetched in parallel")),
2195 OPT_BOOL(0, "prefetch", &prefetch,
2196 N_("modify the refspec to place all refs within refs/prefetch/")),
2197 OPT_BOOL('p', "prune", &prune,
2198 N_("prune remote-tracking branches no longer on remote")),
2199 OPT_BOOL('P', "prune-tags", &prune_tags,
2200 N_("prune local tags no longer on remote and clobber changed tags")),
2201 OPT_CALLBACK_F(0, "recurse-submodules", &recurse_submodules_cli, N_("on-demand"),
2202 N_("control recursive fetching of submodules"),
2203 PARSE_OPT_OPTARG, option_fetch_parse_recurse_submodules),
2204 OPT_BOOL(0, "dry-run", &dry_run,
2205 N_("dry run")),
2206 OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
2207 OPT_BOOL(0, "write-fetch-head", &write_fetch_head,
2208 N_("write fetched references to the FETCH_HEAD file")),
2209 OPT_BOOL('k', "keep", &keep, N_("keep downloaded pack")),
2210 OPT_BOOL('u', "update-head-ok", &update_head_ok,
2211 N_("allow updating of HEAD ref")),
2212 OPT_BOOL(0, "progress", &progress, N_("force progress reporting")),
2213 OPT_STRING(0, "depth", &depth, N_("depth"),
2214 N_("deepen history of shallow clone")),
2215 OPT_STRING(0, "shallow-since", &deepen_since, N_("time"),
2216 N_("deepen history of shallow repository based on time")),
2217 OPT_STRING_LIST(0, "shallow-exclude", &deepen_not, N_("revision"),
2218 N_("deepen history of shallow clone, excluding rev")),
2219 OPT_INTEGER(0, "deepen", &deepen_relative,
2220 N_("deepen history of shallow clone")),
2221 OPT_SET_INT_F(0, "unshallow", &unshallow,
2222 N_("convert to a complete repository"),
2223 1, PARSE_OPT_NONEG),
2224 OPT_SET_INT_F(0, "refetch", &refetch,
2225 N_("re-fetch without negotiating common commits"),
2226 1, PARSE_OPT_NONEG),
2227 { OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, N_("dir"),
2228 N_("prepend this to submodule path output"), PARSE_OPT_HIDDEN },
2229 OPT_CALLBACK_F(0, "recurse-submodules-default",
2230 &recurse_submodules_default, N_("on-demand"),
2231 N_("default for recursive fetching of submodules "
2232 "(lower priority than config files)"),
2233 PARSE_OPT_HIDDEN, option_fetch_parse_recurse_submodules),
2234 OPT_BOOL(0, "update-shallow", &update_shallow,
2235 N_("accept refs that update .git/shallow")),
2236 OPT_CALLBACK_F(0, "refmap", &refmap, N_("refmap"),
2237 N_("specify fetch refmap"), PARSE_OPT_NONEG, parse_refmap_arg),
2238 OPT_STRING_LIST('o', "server-option", &server_options, N_("server-specific"), N_("option to transmit")),
2239 OPT_IPVERSION(&family),
2240 OPT_STRING_LIST(0, "negotiation-tip", &negotiation_tip, N_("revision"),
2241 N_("report that we have only objects reachable from this object")),
2242 OPT_BOOL(0, "negotiate-only", &negotiate_only,
2243 N_("do not fetch a packfile; instead, print ancestors of negotiation tips")),
2244 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
2245 OPT_BOOL(0, "auto-maintenance", &enable_auto_gc,
2246 N_("run 'maintenance --auto' after fetching")),
2247 OPT_BOOL(0, "auto-gc", &enable_auto_gc,
2248 N_("run 'maintenance --auto' after fetching")),
2249 OPT_BOOL(0, "show-forced-updates", &config.show_forced_updates,
2250 N_("check for forced-updates on all updated branches")),
2251 OPT_BOOL(0, "write-commit-graph", &fetch_write_commit_graph,
2252 N_("write the commit-graph after fetching")),
2253 OPT_BOOL(0, "stdin", &stdin_refspecs,
2254 N_("accept refspecs from stdin")),
2255 OPT_END()
2258 packet_trace_identity("fetch");
2260 /* Record the command line for the reflog */
2261 strbuf_addstr(&default_rla, "fetch");
2262 for (i = 1; i < argc; i++) {
2263 /* This handles non-URLs gracefully */
2264 char *anon = transport_anonymize_url(argv[i]);
2266 strbuf_addf(&default_rla, " %s", anon);
2267 free(anon);
2270 git_config(git_fetch_config, &config);
2271 if (the_repository->gitdir) {
2272 prepare_repo_settings(the_repository);
2273 the_repository->settings.command_requires_full_index = 0;
2276 argc = parse_options(argc, argv, prefix,
2277 builtin_fetch_options, builtin_fetch_usage, 0);
2279 if (recurse_submodules_cli != RECURSE_SUBMODULES_DEFAULT)
2280 config.recurse_submodules = recurse_submodules_cli;
2282 if (negotiate_only) {
2283 switch (recurse_submodules_cli) {
2284 case RECURSE_SUBMODULES_OFF:
2285 case RECURSE_SUBMODULES_DEFAULT:
2287 * --negotiate-only should never recurse into
2288 * submodules. Skip it by setting recurse_submodules to
2289 * RECURSE_SUBMODULES_OFF.
2291 config.recurse_submodules = RECURSE_SUBMODULES_OFF;
2292 break;
2294 default:
2295 die(_("options '%s' and '%s' cannot be used together"),
2296 "--negotiate-only", "--recurse-submodules");
2300 if (config.recurse_submodules != RECURSE_SUBMODULES_OFF) {
2301 int *sfjc = config.submodule_fetch_jobs == -1
2302 ? &config.submodule_fetch_jobs : NULL;
2303 int *rs = config.recurse_submodules == RECURSE_SUBMODULES_DEFAULT
2304 ? &config.recurse_submodules : NULL;
2306 fetch_config_from_gitmodules(sfjc, rs);
2310 if (porcelain) {
2311 switch (recurse_submodules_cli) {
2312 case RECURSE_SUBMODULES_OFF:
2313 case RECURSE_SUBMODULES_DEFAULT:
2315 * Reference updates in submodules would be ambiguous
2316 * in porcelain mode, so we reject this combination.
2318 config.recurse_submodules = RECURSE_SUBMODULES_OFF;
2319 break;
2321 default:
2322 die(_("options '%s' and '%s' cannot be used together"),
2323 "--porcelain", "--recurse-submodules");
2326 config.display_format = DISPLAY_FORMAT_PORCELAIN;
2329 if (negotiate_only && !negotiation_tip.nr)
2330 die(_("--negotiate-only needs one or more --negotiation-tip=*"));
2332 if (deepen_relative) {
2333 if (deepen_relative < 0)
2334 die(_("negative depth in --deepen is not supported"));
2335 if (depth)
2336 die(_("options '%s' and '%s' cannot be used together"), "--deepen", "--depth");
2337 depth = xstrfmt("%d", deepen_relative);
2339 if (unshallow) {
2340 if (depth)
2341 die(_("options '%s' and '%s' cannot be used together"), "--depth", "--unshallow");
2342 else if (!is_repository_shallow(the_repository))
2343 die(_("--unshallow on a complete repository does not make sense"));
2344 else
2345 depth = xstrfmt("%d", INFINITE_DEPTH);
2348 /* no need to be strict, transport_set_option() will validate it again */
2349 if (depth && atoi(depth) < 1)
2350 die(_("depth %s is not a positive number"), depth);
2351 if (depth || deepen_since || deepen_not.nr)
2352 deepen = 1;
2354 /* FETCH_HEAD never gets updated in --dry-run mode */
2355 if (dry_run)
2356 write_fetch_head = 0;
2358 if (!max_jobs)
2359 max_jobs = online_cpus();
2361 if (!git_config_get_string_tmp("fetch.bundleuri", &bundle_uri) &&
2362 fetch_bundle_uri(the_repository, bundle_uri, NULL))
2363 warning(_("failed to fetch bundles from '%s'"), bundle_uri);
2365 if (all < 0) {
2367 * no --[no-]all given;
2368 * only use config option if no remote was explicitly specified
2370 all = (!argc) ? config.all : 0;
2373 if (all) {
2374 if (argc == 1)
2375 die(_("fetch --all does not take a repository argument"));
2376 else if (argc > 1)
2377 die(_("fetch --all does not make sense with refspecs"));
2379 (void) for_each_remote(get_one_remote_for_fetch, &list);
2381 /* do not do fetch_multiple() of one */
2382 if (list.nr == 1)
2383 remote = remote_get(list.items[0].string);
2384 } else if (argc == 0) {
2385 /* No arguments -- use default remote */
2386 remote = remote_get(NULL);
2387 } else if (multiple) {
2388 /* All arguments are assumed to be remotes or groups */
2389 for (i = 0; i < argc; i++)
2390 if (!add_remote_or_group(argv[i], &list))
2391 die(_("no such remote or remote group: %s"),
2392 argv[i]);
2393 } else {
2394 /* Single remote or group */
2395 (void) add_remote_or_group(argv[0], &list);
2396 if (list.nr > 1) {
2397 /* More than one remote */
2398 if (argc > 1)
2399 die(_("fetching a group and specifying refspecs does not make sense"));
2400 } else {
2401 /* Zero or one remotes */
2402 remote = remote_get(argv[0]);
2403 prune_tags_ok = (argc == 1);
2404 argc--;
2405 argv++;
2408 string_list_remove_duplicates(&list, 0);
2410 if (negotiate_only) {
2411 struct oidset acked_commits = OIDSET_INIT;
2412 struct oidset_iter iter;
2413 const struct object_id *oid;
2415 trace2_region_enter("fetch", "negotiate-only", the_repository);
2416 if (!remote)
2417 die(_("must supply remote when using --negotiate-only"));
2418 gtransport = prepare_transport(remote, 1);
2419 if (gtransport->smart_options) {
2420 gtransport->smart_options->acked_commits = &acked_commits;
2421 } else {
2422 warning(_("protocol does not support --negotiate-only, exiting"));
2423 result = 1;
2424 trace2_region_leave("fetch", "negotiate-only", the_repository);
2425 goto cleanup;
2427 if (server_options.nr)
2428 gtransport->server_options = &server_options;
2429 result = transport_fetch_refs(gtransport, NULL);
2431 oidset_iter_init(&acked_commits, &iter);
2432 while ((oid = oidset_iter_next(&iter)))
2433 printf("%s\n", oid_to_hex(oid));
2434 oidset_clear(&acked_commits);
2435 trace2_region_leave("fetch", "negotiate-only", the_repository);
2436 } else if (remote) {
2437 if (filter_options.choice || repo_has_promisor_remote(the_repository)) {
2438 trace2_region_enter("fetch", "setup-partial", the_repository);
2439 fetch_one_setup_partial(remote);
2440 trace2_region_leave("fetch", "setup-partial", the_repository);
2442 trace2_region_enter("fetch", "fetch-one", the_repository);
2443 result = fetch_one(remote, argc, argv, prune_tags_ok, stdin_refspecs,
2444 &config);
2445 trace2_region_leave("fetch", "fetch-one", the_repository);
2446 } else {
2447 int max_children = max_jobs;
2449 if (filter_options.choice)
2450 die(_("--filter can only be used with the remote "
2451 "configured in extensions.partialclone"));
2453 if (atomic_fetch)
2454 die(_("--atomic can only be used when fetching "
2455 "from one remote"));
2457 if (stdin_refspecs)
2458 die(_("--stdin can only be used when fetching "
2459 "from one remote"));
2461 if (max_children < 0)
2462 max_children = config.parallel;
2464 /* TODO should this also die if we have a previous partial-clone? */
2465 trace2_region_enter("fetch", "fetch-multiple", the_repository);
2466 result = fetch_multiple(&list, max_children, &config);
2467 trace2_region_leave("fetch", "fetch-multiple", the_repository);
2471 * This is only needed after fetch_one(), which does not fetch
2472 * submodules by itself.
2474 * When we fetch from multiple remotes, fetch_multiple() has
2475 * already updated submodules to grab commits necessary for
2476 * the fetched history from each remote, so there is no need
2477 * to fetch submodules from here.
2479 if (!result && remote && (config.recurse_submodules != RECURSE_SUBMODULES_OFF)) {
2480 struct strvec options = STRVEC_INIT;
2481 int max_children = max_jobs;
2483 if (max_children < 0)
2484 max_children = config.submodule_fetch_jobs;
2485 if (max_children < 0)
2486 max_children = config.parallel;
2488 add_options_to_argv(&options, &config);
2489 trace2_region_enter_printf("fetch", "recurse-submodule", the_repository, "%s", submodule_prefix);
2490 result = fetch_submodules(the_repository,
2491 &options,
2492 submodule_prefix,
2493 config.recurse_submodules,
2494 recurse_submodules_default,
2495 verbosity < 0,
2496 max_children);
2497 trace2_region_leave_printf("fetch", "recurse-submodule", the_repository, "%s", submodule_prefix);
2498 strvec_clear(&options);
2502 * Skip irrelevant tasks because we know objects were not
2503 * fetched.
2505 * NEEDSWORK: as a future optimization, we can return early
2506 * whenever objects were not fetched e.g. if we already have all
2507 * of them.
2509 if (negotiate_only)
2510 goto cleanup;
2512 prepare_repo_settings(the_repository);
2513 if (fetch_write_commit_graph > 0 ||
2514 (fetch_write_commit_graph < 0 &&
2515 the_repository->settings.fetch_write_commit_graph)) {
2516 int commit_graph_flags = COMMIT_GRAPH_WRITE_SPLIT;
2518 if (progress)
2519 commit_graph_flags |= COMMIT_GRAPH_WRITE_PROGRESS;
2521 trace2_region_enter("fetch", "write-commit-graph", the_repository);
2522 write_commit_graph_reachable(the_repository->objects->odb,
2523 commit_graph_flags,
2524 NULL);
2525 trace2_region_leave("fetch", "write-commit-graph", the_repository);
2528 if (enable_auto_gc) {
2529 if (refetch) {
2531 * Hint auto-maintenance strongly to encourage repacking,
2532 * but respect config settings disabling it.
2534 int opt_val;
2535 if (git_config_get_int("gc.autopacklimit", &opt_val))
2536 opt_val = -1;
2537 if (opt_val != 0)
2538 git_config_push_parameter("gc.autoPackLimit=1");
2540 if (git_config_get_int("maintenance.incremental-repack.auto", &opt_val))
2541 opt_val = -1;
2542 if (opt_val != 0)
2543 git_config_push_parameter("maintenance.incremental-repack.auto=-1");
2545 run_auto_maintenance(verbosity < 0);
2548 cleanup:
2549 string_list_clear(&list, 0);
2550 return result;