Merge branch 'kn/ref-transaction-symref'
[git.git] / builtin / fetch.c
blob75255dc600adffc19ffa9c4ec48867e328eebdc3
1 /*
2 * "git fetch"
3 */
4 #include "builtin.h"
5 #include "advice.h"
6 #include "config.h"
7 #include "gettext.h"
8 #include "environment.h"
9 #include "hex.h"
10 #include "repository.h"
11 #include "refs.h"
12 #include "refspec.h"
13 #include "object-name.h"
14 #include "object-store-ll.h"
15 #include "oidset.h"
16 #include "oid-array.h"
17 #include "commit.h"
18 #include "string-list.h"
19 #include "remote.h"
20 #include "transport.h"
21 #include "run-command.h"
22 #include "parse-options.h"
23 #include "sigchain.h"
24 #include "submodule-config.h"
25 #include "submodule.h"
26 #include "connected.h"
27 #include "strvec.h"
28 #include "utf8.h"
29 #include "pager.h"
30 #include "path.h"
31 #include "pkt-line.h"
32 #include "list-objects-filter-options.h"
33 #include "commit-reach.h"
34 #include "branch.h"
35 #include "promisor-remote.h"
36 #include "commit-graph.h"
37 #include "shallow.h"
38 #include "trace.h"
39 #include "trace2.h"
40 #include "bundle-uri.h"
42 #define FORCED_UPDATES_DELAY_WARNING_IN_MS (10 * 1000)
44 static const char * const builtin_fetch_usage[] = {
45 N_("git fetch [<options>] [<repository> [<refspec>...]]"),
46 N_("git fetch [<options>] <group>"),
47 N_("git fetch --multiple [<options>] [(<repository> | <group>)...]"),
48 N_("git fetch --all [<options>]"),
49 NULL
52 enum {
53 TAGS_UNSET = 0,
54 TAGS_DEFAULT = 1,
55 TAGS_SET = 2
58 enum display_format {
59 DISPLAY_FORMAT_FULL,
60 DISPLAY_FORMAT_COMPACT,
61 DISPLAY_FORMAT_PORCELAIN,
64 struct display_state {
65 struct strbuf buf;
67 int refcol_width;
68 enum display_format format;
70 char *url;
71 int url_len, shown_url;
74 static uint64_t forced_updates_ms = 0;
75 static int prefetch = 0;
76 static int prune = -1; /* unspecified */
77 #define PRUNE_BY_DEFAULT 0 /* do we prune by default? */
79 static int prune_tags = -1; /* unspecified */
80 #define PRUNE_TAGS_BY_DEFAULT 0 /* do we prune tags by default? */
82 static int append, dry_run, force, keep, update_head_ok;
83 static int write_fetch_head = 1;
84 static int verbosity, deepen_relative, set_upstream, refetch;
85 static int progress = -1;
86 static int tags = TAGS_DEFAULT, update_shallow, deepen;
87 static int atomic_fetch;
88 static enum transport_family family;
89 static const char *depth;
90 static const char *deepen_since;
91 static const char *upload_pack;
92 static struct string_list deepen_not = STRING_LIST_INIT_NODUP;
93 static struct strbuf default_rla = STRBUF_INIT;
94 static struct transport *gtransport;
95 static struct transport *gsecondary;
96 static struct refspec refmap = REFSPEC_INIT_FETCH;
97 static struct list_objects_filter_options filter_options = LIST_OBJECTS_FILTER_INIT;
98 static struct string_list server_options = STRING_LIST_INIT_DUP;
99 static struct string_list negotiation_tip = STRING_LIST_INIT_NODUP;
101 struct fetch_config {
102 enum display_format display_format;
103 int all;
104 int prune;
105 int prune_tags;
106 int show_forced_updates;
107 int recurse_submodules;
108 int parallel;
109 int submodule_fetch_jobs;
112 static int git_fetch_config(const char *k, const char *v,
113 const struct config_context *ctx, void *cb)
115 struct fetch_config *fetch_config = cb;
117 if (!strcmp(k, "fetch.all")) {
118 fetch_config->all = git_config_bool(k, v);
119 return 0;
122 if (!strcmp(k, "fetch.prune")) {
123 fetch_config->prune = git_config_bool(k, v);
124 return 0;
127 if (!strcmp(k, "fetch.prunetags")) {
128 fetch_config->prune_tags = git_config_bool(k, v);
129 return 0;
132 if (!strcmp(k, "fetch.showforcedupdates")) {
133 fetch_config->show_forced_updates = git_config_bool(k, v);
134 return 0;
137 if (!strcmp(k, "submodule.recurse")) {
138 int r = git_config_bool(k, v) ?
139 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
140 fetch_config->recurse_submodules = r;
141 return 0;
144 if (!strcmp(k, "submodule.fetchjobs")) {
145 fetch_config->submodule_fetch_jobs = parse_submodule_fetchjobs(k, v, ctx->kvi);
146 return 0;
147 } else if (!strcmp(k, "fetch.recursesubmodules")) {
148 fetch_config->recurse_submodules = parse_fetch_recurse_submodules_arg(k, v);
149 return 0;
152 if (!strcmp(k, "fetch.parallel")) {
153 fetch_config->parallel = git_config_int(k, v, ctx->kvi);
154 if (fetch_config->parallel < 0)
155 die(_("fetch.parallel cannot be negative"));
156 if (!fetch_config->parallel)
157 fetch_config->parallel = online_cpus();
158 return 0;
161 if (!strcmp(k, "fetch.output")) {
162 if (!v)
163 return config_error_nonbool(k);
164 else if (!strcasecmp(v, "full"))
165 fetch_config->display_format = DISPLAY_FORMAT_FULL;
166 else if (!strcasecmp(v, "compact"))
167 fetch_config->display_format = DISPLAY_FORMAT_COMPACT;
168 else
169 die(_("invalid value for '%s': '%s'"),
170 "fetch.output", v);
173 return git_default_config(k, v, ctx, cb);
176 static int parse_refmap_arg(const struct option *opt, const char *arg, int unset)
178 BUG_ON_OPT_NEG(unset);
181 * "git fetch --refmap='' origin foo"
182 * can be used to tell the command not to store anywhere
184 refspec_append(opt->value, arg);
186 return 0;
189 static void unlock_pack(unsigned int flags)
191 if (gtransport)
192 transport_unlock_pack(gtransport, flags);
193 if (gsecondary)
194 transport_unlock_pack(gsecondary, flags);
197 static void unlock_pack_atexit(void)
199 unlock_pack(0);
202 static void unlock_pack_on_signal(int signo)
204 unlock_pack(TRANSPORT_UNLOCK_PACK_IN_SIGNAL_HANDLER);
205 sigchain_pop(signo);
206 raise(signo);
209 static void add_merge_config(struct ref **head,
210 const struct ref *remote_refs,
211 struct branch *branch,
212 struct ref ***tail)
214 int i;
216 for (i = 0; i < branch->merge_nr; i++) {
217 struct ref *rm, **old_tail = *tail;
218 struct refspec_item refspec;
220 for (rm = *head; rm; rm = rm->next) {
221 if (branch_merge_matches(branch, i, rm->name)) {
222 rm->fetch_head_status = FETCH_HEAD_MERGE;
223 break;
226 if (rm)
227 continue;
230 * Not fetched to a remote-tracking branch? We need to fetch
231 * it anyway to allow this branch's "branch.$name.merge"
232 * to be honored by 'git pull', but we do not have to
233 * fail if branch.$name.merge is misconfigured to point
234 * at a nonexisting branch. If we were indeed called by
235 * 'git pull', it will notice the misconfiguration because
236 * there is no entry in the resulting FETCH_HEAD marked
237 * for merging.
239 memset(&refspec, 0, sizeof(refspec));
240 refspec.src = branch->merge[i]->src;
241 get_fetch_map(remote_refs, &refspec, tail, 1);
242 for (rm = *old_tail; rm; rm = rm->next)
243 rm->fetch_head_status = FETCH_HEAD_MERGE;
247 static void create_fetch_oidset(struct ref **head, struct oidset *out)
249 struct ref *rm = *head;
250 while (rm) {
251 oidset_insert(out, &rm->old_oid);
252 rm = rm->next;
256 struct refname_hash_entry {
257 struct hashmap_entry ent;
258 struct object_id oid;
259 int ignore;
260 char refname[FLEX_ARRAY];
263 static int refname_hash_entry_cmp(const void *hashmap_cmp_fn_data UNUSED,
264 const struct hashmap_entry *eptr,
265 const struct hashmap_entry *entry_or_key,
266 const void *keydata)
268 const struct refname_hash_entry *e1, *e2;
270 e1 = container_of(eptr, const struct refname_hash_entry, ent);
271 e2 = container_of(entry_or_key, const struct refname_hash_entry, ent);
272 return strcmp(e1->refname, keydata ? keydata : e2->refname);
275 static struct refname_hash_entry *refname_hash_add(struct hashmap *map,
276 const char *refname,
277 const struct object_id *oid)
279 struct refname_hash_entry *ent;
280 size_t len = strlen(refname);
282 FLEX_ALLOC_MEM(ent, refname, refname, len);
283 hashmap_entry_init(&ent->ent, strhash(refname));
284 oidcpy(&ent->oid, oid);
285 hashmap_add(map, &ent->ent);
286 return ent;
289 static int add_one_refname(const char *refname,
290 const struct object_id *oid,
291 int flag UNUSED, void *cbdata)
293 struct hashmap *refname_map = cbdata;
295 (void) refname_hash_add(refname_map, refname, oid);
296 return 0;
299 static void refname_hash_init(struct hashmap *map)
301 hashmap_init(map, refname_hash_entry_cmp, NULL, 0);
304 static int refname_hash_exists(struct hashmap *map, const char *refname)
306 return !!hashmap_get_from_hash(map, strhash(refname), refname);
309 static void clear_item(struct refname_hash_entry *item)
311 item->ignore = 1;
315 static void add_already_queued_tags(const char *refname,
316 const struct object_id *old_oid UNUSED,
317 const struct object_id *new_oid,
318 void *cb_data)
320 struct hashmap *queued_tags = cb_data;
321 if (starts_with(refname, "refs/tags/") && new_oid)
322 (void) refname_hash_add(queued_tags, refname, new_oid);
325 static void find_non_local_tags(const struct ref *refs,
326 struct ref_transaction *transaction,
327 struct ref **head,
328 struct ref ***tail)
330 struct hashmap existing_refs;
331 struct hashmap remote_refs;
332 struct oidset fetch_oids = OIDSET_INIT;
333 struct string_list remote_refs_list = STRING_LIST_INIT_NODUP;
334 struct string_list_item *remote_ref_item;
335 const struct ref *ref;
336 struct refname_hash_entry *item = NULL;
337 const int quick_flags = OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT;
339 refname_hash_init(&existing_refs);
340 refname_hash_init(&remote_refs);
341 create_fetch_oidset(head, &fetch_oids);
343 refs_for_each_ref(get_main_ref_store(the_repository), add_one_refname,
344 &existing_refs);
347 * If we already have a transaction, then we need to filter out all
348 * tags which have already been queued up.
350 if (transaction)
351 ref_transaction_for_each_queued_update(transaction,
352 add_already_queued_tags,
353 &existing_refs);
355 for (ref = refs; ref; ref = ref->next) {
356 if (!starts_with(ref->name, "refs/tags/"))
357 continue;
360 * The peeled ref always follows the matching base
361 * ref, so if we see a peeled ref that we don't want
362 * to fetch then we can mark the ref entry in the list
363 * as one to ignore by setting util to NULL.
365 if (ends_with(ref->name, "^{}")) {
366 if (item &&
367 !repo_has_object_file_with_flags(the_repository, &ref->old_oid, quick_flags) &&
368 !oidset_contains(&fetch_oids, &ref->old_oid) &&
369 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
370 !oidset_contains(&fetch_oids, &item->oid))
371 clear_item(item);
372 item = NULL;
373 continue;
377 * If item is non-NULL here, then we previously saw a
378 * ref not followed by a peeled reference, so we need
379 * to check if it is a lightweight tag that we want to
380 * fetch.
382 if (item &&
383 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
384 !oidset_contains(&fetch_oids, &item->oid))
385 clear_item(item);
387 item = NULL;
389 /* skip duplicates and refs that we already have */
390 if (refname_hash_exists(&remote_refs, ref->name) ||
391 refname_hash_exists(&existing_refs, ref->name))
392 continue;
394 item = refname_hash_add(&remote_refs, ref->name, &ref->old_oid);
395 string_list_insert(&remote_refs_list, ref->name);
397 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
400 * We may have a final lightweight tag that needs to be
401 * checked to see if it needs fetching.
403 if (item &&
404 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
405 !oidset_contains(&fetch_oids, &item->oid))
406 clear_item(item);
409 * For all the tags in the remote_refs_list,
410 * add them to the list of refs to be fetched
412 for_each_string_list_item(remote_ref_item, &remote_refs_list) {
413 const char *refname = remote_ref_item->string;
414 struct ref *rm;
415 unsigned int hash = strhash(refname);
417 item = hashmap_get_entry_from_hash(&remote_refs, hash, refname,
418 struct refname_hash_entry, ent);
419 if (!item)
420 BUG("unseen remote ref?");
422 /* Unless we have already decided to ignore this item... */
423 if (item->ignore)
424 continue;
426 rm = alloc_ref(item->refname);
427 rm->peer_ref = alloc_ref(item->refname);
428 oidcpy(&rm->old_oid, &item->oid);
429 **tail = rm;
430 *tail = &rm->next;
432 hashmap_clear_and_free(&remote_refs, struct refname_hash_entry, ent);
433 string_list_clear(&remote_refs_list, 0);
434 oidset_clear(&fetch_oids);
437 static void filter_prefetch_refspec(struct refspec *rs)
439 int i;
441 if (!prefetch)
442 return;
444 for (i = 0; i < rs->nr; i++) {
445 struct strbuf new_dst = STRBUF_INIT;
446 char *old_dst;
447 const char *sub = NULL;
449 if (rs->items[i].negative)
450 continue;
451 if (!rs->items[i].dst ||
452 (rs->items[i].src &&
453 starts_with(rs->items[i].src,
454 ref_namespace[NAMESPACE_TAGS].ref))) {
455 int j;
457 free(rs->items[i].src);
458 free(rs->items[i].dst);
460 for (j = i + 1; j < rs->nr; j++) {
461 rs->items[j - 1] = rs->items[j];
462 rs->raw[j - 1] = rs->raw[j];
464 rs->nr--;
465 i--;
466 continue;
469 old_dst = rs->items[i].dst;
470 strbuf_addstr(&new_dst, ref_namespace[NAMESPACE_PREFETCH].ref);
473 * If old_dst starts with "refs/", then place
474 * sub after that prefix. Otherwise, start at
475 * the beginning of the string.
477 if (!skip_prefix(old_dst, "refs/", &sub))
478 sub = old_dst;
479 strbuf_addstr(&new_dst, sub);
481 rs->items[i].dst = strbuf_detach(&new_dst, NULL);
482 rs->items[i].force = 1;
484 free(old_dst);
488 static struct ref *get_ref_map(struct remote *remote,
489 const struct ref *remote_refs,
490 struct refspec *rs,
491 int tags, int *autotags)
493 int i;
494 struct ref *rm;
495 struct ref *ref_map = NULL;
496 struct ref **tail = &ref_map;
498 /* opportunistically-updated references: */
499 struct ref *orefs = NULL, **oref_tail = &orefs;
501 struct hashmap existing_refs;
502 int existing_refs_populated = 0;
504 filter_prefetch_refspec(rs);
505 if (remote)
506 filter_prefetch_refspec(&remote->fetch);
508 if (rs->nr) {
509 struct refspec *fetch_refspec;
511 for (i = 0; i < rs->nr; i++) {
512 get_fetch_map(remote_refs, &rs->items[i], &tail, 0);
513 if (rs->items[i].dst && rs->items[i].dst[0])
514 *autotags = 1;
516 /* Merge everything on the command line (but not --tags) */
517 for (rm = ref_map; rm; rm = rm->next)
518 rm->fetch_head_status = FETCH_HEAD_MERGE;
521 * For any refs that we happen to be fetching via
522 * command-line arguments, the destination ref might
523 * have been missing or have been different than the
524 * remote-tracking ref that would be derived from the
525 * configured refspec. In these cases, we want to
526 * take the opportunity to update their configured
527 * remote-tracking reference. However, we do not want
528 * to mention these entries in FETCH_HEAD at all, as
529 * they would simply be duplicates of existing
530 * entries, so we set them FETCH_HEAD_IGNORE below.
532 * We compute these entries now, based only on the
533 * refspecs specified on the command line. But we add
534 * them to the list following the refspecs resulting
535 * from the tags option so that one of the latter,
536 * which has FETCH_HEAD_NOT_FOR_MERGE, is not removed
537 * by ref_remove_duplicates() in favor of one of these
538 * opportunistic entries with FETCH_HEAD_IGNORE.
540 if (refmap.nr)
541 fetch_refspec = &refmap;
542 else
543 fetch_refspec = &remote->fetch;
545 for (i = 0; i < fetch_refspec->nr; i++)
546 get_fetch_map(ref_map, &fetch_refspec->items[i], &oref_tail, 1);
547 } else if (refmap.nr) {
548 die("--refmap option is only meaningful with command-line refspec(s)");
549 } else {
550 /* Use the defaults */
551 struct branch *branch = branch_get(NULL);
552 int has_merge = branch_has_merge_config(branch);
553 if (remote &&
554 (remote->fetch.nr ||
555 /* Note: has_merge implies non-NULL branch->remote_name */
556 (has_merge && !strcmp(branch->remote_name, remote->name)))) {
557 for (i = 0; i < remote->fetch.nr; i++) {
558 get_fetch_map(remote_refs, &remote->fetch.items[i], &tail, 0);
559 if (remote->fetch.items[i].dst &&
560 remote->fetch.items[i].dst[0])
561 *autotags = 1;
562 if (!i && !has_merge && ref_map &&
563 !remote->fetch.items[0].pattern)
564 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
567 * if the remote we're fetching from is the same
568 * as given in branch.<name>.remote, we add the
569 * ref given in branch.<name>.merge, too.
571 * Note: has_merge implies non-NULL branch->remote_name
573 if (has_merge &&
574 !strcmp(branch->remote_name, remote->name))
575 add_merge_config(&ref_map, remote_refs, branch, &tail);
576 } else if (!prefetch) {
577 ref_map = get_remote_ref(remote_refs, "HEAD");
578 if (!ref_map)
579 die(_("couldn't find remote ref HEAD"));
580 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
581 tail = &ref_map->next;
585 if (tags == TAGS_SET)
586 /* also fetch all tags */
587 get_fetch_map(remote_refs, tag_refspec, &tail, 0);
588 else if (tags == TAGS_DEFAULT && *autotags)
589 find_non_local_tags(remote_refs, NULL, &ref_map, &tail);
591 /* Now append any refs to be updated opportunistically: */
592 *tail = orefs;
593 for (rm = orefs; rm; rm = rm->next) {
594 rm->fetch_head_status = FETCH_HEAD_IGNORE;
595 tail = &rm->next;
599 * apply negative refspecs first, before we remove duplicates. This is
600 * necessary as negative refspecs might remove an otherwise conflicting
601 * duplicate.
603 if (rs->nr)
604 ref_map = apply_negative_refspecs(ref_map, rs);
605 else
606 ref_map = apply_negative_refspecs(ref_map, &remote->fetch);
608 ref_map = ref_remove_duplicates(ref_map);
610 for (rm = ref_map; rm; rm = rm->next) {
611 if (rm->peer_ref) {
612 const char *refname = rm->peer_ref->name;
613 struct refname_hash_entry *peer_item;
614 unsigned int hash = strhash(refname);
616 if (!existing_refs_populated) {
617 refname_hash_init(&existing_refs);
618 refs_for_each_ref(get_main_ref_store(the_repository),
619 add_one_refname,
620 &existing_refs);
621 existing_refs_populated = 1;
624 peer_item = hashmap_get_entry_from_hash(&existing_refs,
625 hash, refname,
626 struct refname_hash_entry, ent);
627 if (peer_item) {
628 struct object_id *old_oid = &peer_item->oid;
629 oidcpy(&rm->peer_ref->old_oid, old_oid);
633 if (existing_refs_populated)
634 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
636 return ref_map;
639 #define STORE_REF_ERROR_OTHER 1
640 #define STORE_REF_ERROR_DF_CONFLICT 2
642 static int s_update_ref(const char *action,
643 struct ref *ref,
644 struct ref_transaction *transaction,
645 int check_old)
647 char *msg;
648 char *rla = getenv("GIT_REFLOG_ACTION");
649 struct ref_transaction *our_transaction = NULL;
650 struct strbuf err = STRBUF_INIT;
651 int ret;
653 if (dry_run)
654 return 0;
655 if (!rla)
656 rla = default_rla.buf;
657 msg = xstrfmt("%s: %s", rla, action);
660 * If no transaction was passed to us, we manage the transaction
661 * ourselves. Otherwise, we trust the caller to handle the transaction
662 * lifecycle.
664 if (!transaction) {
665 transaction = our_transaction = ref_store_transaction_begin(get_main_ref_store(the_repository),
666 &err);
667 if (!transaction) {
668 ret = STORE_REF_ERROR_OTHER;
669 goto out;
673 ret = ref_transaction_update(transaction, ref->name, &ref->new_oid,
674 check_old ? &ref->old_oid : NULL,
675 NULL, NULL, 0, msg, &err);
676 if (ret) {
677 ret = STORE_REF_ERROR_OTHER;
678 goto out;
681 if (our_transaction) {
682 switch (ref_transaction_commit(our_transaction, &err)) {
683 case 0:
684 break;
685 case TRANSACTION_NAME_CONFLICT:
686 ret = STORE_REF_ERROR_DF_CONFLICT;
687 goto out;
688 default:
689 ret = STORE_REF_ERROR_OTHER;
690 goto out;
694 out:
695 ref_transaction_free(our_transaction);
696 if (ret)
697 error("%s", err.buf);
698 strbuf_release(&err);
699 free(msg);
700 return ret;
703 static int refcol_width(const struct ref *ref_map, int compact_format)
705 const struct ref *ref;
706 int max, width = 10;
708 max = term_columns();
709 if (compact_format)
710 max = max * 2 / 3;
712 for (ref = ref_map; ref; ref = ref->next) {
713 int rlen, llen = 0, len;
715 if (ref->status == REF_STATUS_REJECT_SHALLOW ||
716 !ref->peer_ref ||
717 !strcmp(ref->name, "HEAD"))
718 continue;
720 /* uptodate lines are only shown on high verbosity level */
721 if (verbosity <= 0 && oideq(&ref->peer_ref->old_oid, &ref->old_oid))
722 continue;
724 rlen = utf8_strwidth(prettify_refname(ref->name));
725 if (!compact_format)
726 llen = utf8_strwidth(prettify_refname(ref->peer_ref->name));
729 * rough estimation to see if the output line is too long and
730 * should not be counted (we can't do precise calculation
731 * anyway because we don't know if the error explanation part
732 * will be printed in update_local_ref)
734 len = 21 /* flag and summary */ + rlen + 4 /* -> */ + llen;
735 if (len >= max)
736 continue;
738 if (width < rlen)
739 width = rlen;
742 return width;
745 static void display_state_init(struct display_state *display_state, struct ref *ref_map,
746 const char *raw_url, enum display_format format)
748 int i;
750 memset(display_state, 0, sizeof(*display_state));
751 strbuf_init(&display_state->buf, 0);
752 display_state->format = format;
754 if (raw_url)
755 display_state->url = transport_anonymize_url(raw_url);
756 else
757 display_state->url = xstrdup("foreign");
759 display_state->url_len = strlen(display_state->url);
760 for (i = display_state->url_len - 1; display_state->url[i] == '/' && 0 <= i; i--)
762 display_state->url_len = i + 1;
763 if (4 < i && !strncmp(".git", display_state->url + i - 3, 4))
764 display_state->url_len = i - 3;
766 if (verbosity < 0)
767 return;
769 switch (display_state->format) {
770 case DISPLAY_FORMAT_FULL:
771 case DISPLAY_FORMAT_COMPACT:
772 display_state->refcol_width = refcol_width(ref_map,
773 display_state->format == DISPLAY_FORMAT_COMPACT);
774 break;
775 case DISPLAY_FORMAT_PORCELAIN:
776 /* We don't need to precompute anything here. */
777 break;
778 default:
779 BUG("unexpected display format %d", display_state->format);
783 static void display_state_release(struct display_state *display_state)
785 strbuf_release(&display_state->buf);
786 free(display_state->url);
789 static void print_remote_to_local(struct display_state *display_state,
790 const char *remote, const char *local)
792 strbuf_addf(&display_state->buf, "%-*s -> %s",
793 display_state->refcol_width, remote, local);
796 static int find_and_replace(struct strbuf *haystack,
797 const char *needle,
798 const char *placeholder)
800 const char *p = NULL;
801 int plen, nlen;
803 nlen = strlen(needle);
804 if (ends_with(haystack->buf, needle))
805 p = haystack->buf + haystack->len - nlen;
806 else
807 p = strstr(haystack->buf, needle);
808 if (!p)
809 return 0;
811 if (p > haystack->buf && p[-1] != '/')
812 return 0;
814 plen = strlen(p);
815 if (plen > nlen && p[nlen] != '/')
816 return 0;
818 strbuf_splice(haystack, p - haystack->buf, nlen,
819 placeholder, strlen(placeholder));
820 return 1;
823 static void print_compact(struct display_state *display_state,
824 const char *remote, const char *local)
826 struct strbuf r = STRBUF_INIT;
827 struct strbuf l = STRBUF_INIT;
829 if (!strcmp(remote, local)) {
830 strbuf_addf(&display_state->buf, "%-*s -> *", display_state->refcol_width, remote);
831 return;
834 strbuf_addstr(&r, remote);
835 strbuf_addstr(&l, local);
837 if (!find_and_replace(&r, local, "*"))
838 find_and_replace(&l, remote, "*");
839 print_remote_to_local(display_state, r.buf, l.buf);
841 strbuf_release(&r);
842 strbuf_release(&l);
845 static void display_ref_update(struct display_state *display_state, char code,
846 const char *summary, const char *error,
847 const char *remote, const char *local,
848 const struct object_id *old_oid,
849 const struct object_id *new_oid,
850 int summary_width)
852 FILE *f = stderr;
854 if (verbosity < 0)
855 return;
857 strbuf_reset(&display_state->buf);
859 switch (display_state->format) {
860 case DISPLAY_FORMAT_FULL:
861 case DISPLAY_FORMAT_COMPACT: {
862 int width;
864 if (!display_state->shown_url) {
865 strbuf_addf(&display_state->buf, _("From %.*s\n"),
866 display_state->url_len, display_state->url);
867 display_state->shown_url = 1;
870 width = (summary_width + strlen(summary) - gettext_width(summary));
871 remote = prettify_refname(remote);
872 local = prettify_refname(local);
874 strbuf_addf(&display_state->buf, " %c %-*s ", code, width, summary);
876 if (display_state->format != DISPLAY_FORMAT_COMPACT)
877 print_remote_to_local(display_state, remote, local);
878 else
879 print_compact(display_state, remote, local);
881 if (error)
882 strbuf_addf(&display_state->buf, " (%s)", error);
884 break;
886 case DISPLAY_FORMAT_PORCELAIN:
887 strbuf_addf(&display_state->buf, "%c %s %s %s", code,
888 oid_to_hex(old_oid), oid_to_hex(new_oid), local);
889 f = stdout;
890 break;
891 default:
892 BUG("unexpected display format %d", display_state->format);
894 strbuf_addch(&display_state->buf, '\n');
896 fputs(display_state->buf.buf, f);
899 static int update_local_ref(struct ref *ref,
900 struct ref_transaction *transaction,
901 struct display_state *display_state,
902 const struct ref *remote_ref,
903 int summary_width,
904 const struct fetch_config *config)
906 struct commit *current = NULL, *updated;
907 int fast_forward = 0;
909 if (!repo_has_object_file(the_repository, &ref->new_oid))
910 die(_("object %s not found"), oid_to_hex(&ref->new_oid));
912 if (oideq(&ref->old_oid, &ref->new_oid)) {
913 if (verbosity > 0)
914 display_ref_update(display_state, '=', _("[up to date]"), NULL,
915 remote_ref->name, ref->name,
916 &ref->old_oid, &ref->new_oid, summary_width);
917 return 0;
920 if (!update_head_ok &&
921 !is_null_oid(&ref->old_oid) &&
922 branch_checked_out(ref->name)) {
924 * If this is the head, and it's not okay to update
925 * the head, and the old value of the head isn't empty...
927 display_ref_update(display_state, '!', _("[rejected]"),
928 _("can't fetch into checked-out branch"),
929 remote_ref->name, ref->name,
930 &ref->old_oid, &ref->new_oid, summary_width);
931 return 1;
934 if (!is_null_oid(&ref->old_oid) &&
935 starts_with(ref->name, "refs/tags/")) {
936 if (force || ref->force) {
937 int r;
938 r = s_update_ref("updating tag", ref, transaction, 0);
939 display_ref_update(display_state, r ? '!' : 't', _("[tag update]"),
940 r ? _("unable to update local ref") : NULL,
941 remote_ref->name, ref->name,
942 &ref->old_oid, &ref->new_oid, summary_width);
943 return r;
944 } else {
945 display_ref_update(display_state, '!', _("[rejected]"),
946 _("would clobber existing tag"),
947 remote_ref->name, ref->name,
948 &ref->old_oid, &ref->new_oid, summary_width);
949 return 1;
953 current = lookup_commit_reference_gently(the_repository,
954 &ref->old_oid, 1);
955 updated = lookup_commit_reference_gently(the_repository,
956 &ref->new_oid, 1);
957 if (!current || !updated) {
958 const char *msg;
959 const char *what;
960 int r;
962 * Nicely describe the new ref we're fetching.
963 * Base this on the remote's ref name, as it's
964 * more likely to follow a standard layout.
966 if (starts_with(remote_ref->name, "refs/tags/")) {
967 msg = "storing tag";
968 what = _("[new tag]");
969 } else if (starts_with(remote_ref->name, "refs/heads/")) {
970 msg = "storing head";
971 what = _("[new branch]");
972 } else {
973 msg = "storing ref";
974 what = _("[new ref]");
977 r = s_update_ref(msg, ref, transaction, 0);
978 display_ref_update(display_state, r ? '!' : '*', what,
979 r ? _("unable to update local ref") : NULL,
980 remote_ref->name, ref->name,
981 &ref->old_oid, &ref->new_oid, summary_width);
982 return r;
985 if (config->show_forced_updates) {
986 uint64_t t_before = getnanotime();
987 fast_forward = repo_in_merge_bases(the_repository, current,
988 updated);
989 if (fast_forward < 0)
990 exit(128);
991 forced_updates_ms += (getnanotime() - t_before) / 1000000;
992 } else {
993 fast_forward = 1;
996 if (fast_forward) {
997 struct strbuf quickref = STRBUF_INIT;
998 int r;
1000 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
1001 strbuf_addstr(&quickref, "..");
1002 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
1003 r = s_update_ref("fast-forward", ref, transaction, 1);
1004 display_ref_update(display_state, r ? '!' : ' ', quickref.buf,
1005 r ? _("unable to update local ref") : NULL,
1006 remote_ref->name, ref->name,
1007 &ref->old_oid, &ref->new_oid, summary_width);
1008 strbuf_release(&quickref);
1009 return r;
1010 } else if (force || ref->force) {
1011 struct strbuf quickref = STRBUF_INIT;
1012 int r;
1013 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
1014 strbuf_addstr(&quickref, "...");
1015 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
1016 r = s_update_ref("forced-update", ref, transaction, 1);
1017 display_ref_update(display_state, r ? '!' : '+', quickref.buf,
1018 r ? _("unable to update local ref") : _("forced update"),
1019 remote_ref->name, ref->name,
1020 &ref->old_oid, &ref->new_oid, summary_width);
1021 strbuf_release(&quickref);
1022 return r;
1023 } else {
1024 display_ref_update(display_state, '!', _("[rejected]"), _("non-fast-forward"),
1025 remote_ref->name, ref->name,
1026 &ref->old_oid, &ref->new_oid, summary_width);
1027 return 1;
1031 static const struct object_id *iterate_ref_map(void *cb_data)
1033 struct ref **rm = cb_data;
1034 struct ref *ref = *rm;
1036 while (ref && ref->status == REF_STATUS_REJECT_SHALLOW)
1037 ref = ref->next;
1038 if (!ref)
1039 return NULL;
1040 *rm = ref->next;
1041 return &ref->old_oid;
1044 struct fetch_head {
1045 FILE *fp;
1046 struct strbuf buf;
1049 static int open_fetch_head(struct fetch_head *fetch_head)
1051 const char *filename = git_path_fetch_head(the_repository);
1053 if (write_fetch_head) {
1054 fetch_head->fp = fopen(filename, "a");
1055 if (!fetch_head->fp)
1056 return error_errno(_("cannot open '%s'"), filename);
1057 strbuf_init(&fetch_head->buf, 0);
1058 } else {
1059 fetch_head->fp = NULL;
1062 return 0;
1065 static void append_fetch_head(struct fetch_head *fetch_head,
1066 const struct object_id *old_oid,
1067 enum fetch_head_status fetch_head_status,
1068 const char *note,
1069 const char *url, size_t url_len)
1071 char old_oid_hex[GIT_MAX_HEXSZ + 1];
1072 const char *merge_status_marker;
1073 size_t i;
1075 if (!fetch_head->fp)
1076 return;
1078 switch (fetch_head_status) {
1079 case FETCH_HEAD_NOT_FOR_MERGE:
1080 merge_status_marker = "not-for-merge";
1081 break;
1082 case FETCH_HEAD_MERGE:
1083 merge_status_marker = "";
1084 break;
1085 default:
1086 /* do not write anything to FETCH_HEAD */
1087 return;
1090 strbuf_addf(&fetch_head->buf, "%s\t%s\t%s",
1091 oid_to_hex_r(old_oid_hex, old_oid), merge_status_marker, note);
1092 for (i = 0; i < url_len; ++i)
1093 if ('\n' == url[i])
1094 strbuf_addstr(&fetch_head->buf, "\\n");
1095 else
1096 strbuf_addch(&fetch_head->buf, url[i]);
1097 strbuf_addch(&fetch_head->buf, '\n');
1100 * When using an atomic fetch, we do not want to update FETCH_HEAD if
1101 * any of the reference updates fails. We thus have to write all
1102 * updates to a buffer first and only commit it as soon as all
1103 * references have been successfully updated.
1105 if (!atomic_fetch) {
1106 strbuf_write(&fetch_head->buf, fetch_head->fp);
1107 strbuf_reset(&fetch_head->buf);
1111 static void commit_fetch_head(struct fetch_head *fetch_head)
1113 if (!fetch_head->fp || !atomic_fetch)
1114 return;
1115 strbuf_write(&fetch_head->buf, fetch_head->fp);
1118 static void close_fetch_head(struct fetch_head *fetch_head)
1120 if (!fetch_head->fp)
1121 return;
1123 fclose(fetch_head->fp);
1124 strbuf_release(&fetch_head->buf);
1127 static const char warn_show_forced_updates[] =
1128 N_("fetch normally indicates which branches had a forced update,\n"
1129 "but that check has been disabled; to re-enable, use '--show-forced-updates'\n"
1130 "flag or run 'git config fetch.showForcedUpdates true'");
1131 static const char warn_time_show_forced_updates[] =
1132 N_("it took %.2f seconds to check forced updates; you can use\n"
1133 "'--no-show-forced-updates' or run 'git config fetch.showForcedUpdates false'\n"
1134 "to avoid this check\n");
1136 static int store_updated_refs(struct display_state *display_state,
1137 const char *remote_name,
1138 int connectivity_checked,
1139 struct ref_transaction *transaction, struct ref *ref_map,
1140 struct fetch_head *fetch_head,
1141 const struct fetch_config *config)
1143 int rc = 0;
1144 struct strbuf note = STRBUF_INIT;
1145 const char *what, *kind;
1146 struct ref *rm;
1147 int want_status;
1148 int summary_width = 0;
1150 if (verbosity >= 0)
1151 summary_width = transport_summary_width(ref_map);
1153 if (!connectivity_checked) {
1154 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1156 opt.exclude_hidden_refs_section = "fetch";
1157 rm = ref_map;
1158 if (check_connected(iterate_ref_map, &rm, &opt)) {
1159 rc = error(_("%s did not send all necessary objects\n"),
1160 display_state->url);
1161 goto abort;
1166 * We do a pass for each fetch_head_status type in their enum order, so
1167 * merged entries are written before not-for-merge. That lets readers
1168 * use FETCH_HEAD as a refname to refer to the ref to be merged.
1170 for (want_status = FETCH_HEAD_MERGE;
1171 want_status <= FETCH_HEAD_IGNORE;
1172 want_status++) {
1173 for (rm = ref_map; rm; rm = rm->next) {
1174 struct ref *ref = NULL;
1176 if (rm->status == REF_STATUS_REJECT_SHALLOW) {
1177 if (want_status == FETCH_HEAD_MERGE)
1178 warning(_("rejected %s because shallow roots are not allowed to be updated"),
1179 rm->peer_ref ? rm->peer_ref->name : rm->name);
1180 continue;
1184 * When writing FETCH_HEAD we need to determine whether
1185 * we already have the commit or not. If not, then the
1186 * reference is not for merge and needs to be written
1187 * to the reflog after other commits which we already
1188 * have. We're not interested in this property though
1189 * in case FETCH_HEAD is not to be updated, so we can
1190 * skip the classification in that case.
1192 if (fetch_head->fp) {
1193 struct commit *commit = NULL;
1196 * References in "refs/tags/" are often going to point
1197 * to annotated tags, which are not part of the
1198 * commit-graph. We thus only try to look up refs in
1199 * the graph which are not in that namespace to not
1200 * regress performance in repositories with many
1201 * annotated tags.
1203 if (!starts_with(rm->name, "refs/tags/"))
1204 commit = lookup_commit_in_graph(the_repository, &rm->old_oid);
1205 if (!commit) {
1206 commit = lookup_commit_reference_gently(the_repository,
1207 &rm->old_oid,
1209 if (!commit)
1210 rm->fetch_head_status = FETCH_HEAD_NOT_FOR_MERGE;
1214 if (rm->fetch_head_status != want_status)
1215 continue;
1217 if (rm->peer_ref) {
1218 ref = alloc_ref(rm->peer_ref->name);
1219 oidcpy(&ref->old_oid, &rm->peer_ref->old_oid);
1220 oidcpy(&ref->new_oid, &rm->old_oid);
1221 ref->force = rm->peer_ref->force;
1224 if (config->recurse_submodules != RECURSE_SUBMODULES_OFF &&
1225 (!rm->peer_ref || !oideq(&ref->old_oid, &ref->new_oid))) {
1226 check_for_new_submodule_commits(&rm->old_oid);
1229 if (!strcmp(rm->name, "HEAD")) {
1230 kind = "";
1231 what = "";
1232 } else if (skip_prefix(rm->name, "refs/heads/", &what)) {
1233 kind = "branch";
1234 } else if (skip_prefix(rm->name, "refs/tags/", &what)) {
1235 kind = "tag";
1236 } else if (skip_prefix(rm->name, "refs/remotes/", &what)) {
1237 kind = "remote-tracking branch";
1238 } else {
1239 kind = "";
1240 what = rm->name;
1243 strbuf_reset(&note);
1244 if (*what) {
1245 if (*kind)
1246 strbuf_addf(&note, "%s ", kind);
1247 strbuf_addf(&note, "'%s' of ", what);
1250 append_fetch_head(fetch_head, &rm->old_oid,
1251 rm->fetch_head_status,
1252 note.buf, display_state->url,
1253 display_state->url_len);
1255 if (ref) {
1256 rc |= update_local_ref(ref, transaction, display_state,
1257 rm, summary_width, config);
1258 free(ref);
1259 } else if (write_fetch_head || dry_run) {
1261 * Display fetches written to FETCH_HEAD (or
1262 * would be written to FETCH_HEAD, if --dry-run
1263 * is set).
1265 display_ref_update(display_state, '*',
1266 *kind ? kind : "branch", NULL,
1267 rm->name,
1268 "FETCH_HEAD",
1269 &rm->new_oid, &rm->old_oid,
1270 summary_width);
1275 if (rc & STORE_REF_ERROR_DF_CONFLICT)
1276 error(_("some local refs could not be updated; try running\n"
1277 " 'git remote prune %s' to remove any old, conflicting "
1278 "branches"), remote_name);
1280 if (advice_enabled(ADVICE_FETCH_SHOW_FORCED_UPDATES)) {
1281 if (!config->show_forced_updates) {
1282 warning(_(warn_show_forced_updates));
1283 } else if (forced_updates_ms > FORCED_UPDATES_DELAY_WARNING_IN_MS) {
1284 warning(_(warn_time_show_forced_updates),
1285 forced_updates_ms / 1000.0);
1289 abort:
1290 strbuf_release(&note);
1291 return rc;
1295 * We would want to bypass the object transfer altogether if
1296 * everything we are going to fetch already exists and is connected
1297 * locally.
1299 static int check_exist_and_connected(struct ref *ref_map)
1301 struct ref *rm = ref_map;
1302 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1303 struct ref *r;
1306 * If we are deepening a shallow clone we already have these
1307 * objects reachable. Running rev-list here will return with
1308 * a good (0) exit status and we'll bypass the fetch that we
1309 * really need to perform. Claiming failure now will ensure
1310 * we perform the network exchange to deepen our history.
1312 if (deepen)
1313 return -1;
1316 * Similarly, if we need to refetch, we always want to perform a full
1317 * fetch ignoring existing objects.
1319 if (refetch)
1320 return -1;
1324 * check_connected() allows objects to merely be promised, but
1325 * we need all direct targets to exist.
1327 for (r = rm; r; r = r->next) {
1328 if (!repo_has_object_file_with_flags(the_repository, &r->old_oid,
1329 OBJECT_INFO_SKIP_FETCH_OBJECT))
1330 return -1;
1333 opt.quiet = 1;
1334 opt.exclude_hidden_refs_section = "fetch";
1335 return check_connected(iterate_ref_map, &rm, &opt);
1338 static int fetch_and_consume_refs(struct display_state *display_state,
1339 struct transport *transport,
1340 struct ref_transaction *transaction,
1341 struct ref *ref_map,
1342 struct fetch_head *fetch_head,
1343 const struct fetch_config *config)
1345 int connectivity_checked = 1;
1346 int ret;
1349 * We don't need to perform a fetch in case we can already satisfy all
1350 * refs.
1352 ret = check_exist_and_connected(ref_map);
1353 if (ret) {
1354 trace2_region_enter("fetch", "fetch_refs", the_repository);
1355 ret = transport_fetch_refs(transport, ref_map);
1356 trace2_region_leave("fetch", "fetch_refs", the_repository);
1357 if (ret)
1358 goto out;
1359 connectivity_checked = transport->smart_options ?
1360 transport->smart_options->connectivity_checked : 0;
1363 trace2_region_enter("fetch", "consume_refs", the_repository);
1364 ret = store_updated_refs(display_state, transport->remote->name,
1365 connectivity_checked, transaction, ref_map,
1366 fetch_head, config);
1367 trace2_region_leave("fetch", "consume_refs", the_repository);
1369 out:
1370 transport_unlock_pack(transport, 0);
1371 return ret;
1374 static int prune_refs(struct display_state *display_state,
1375 struct refspec *rs,
1376 struct ref_transaction *transaction,
1377 struct ref *ref_map)
1379 int result = 0;
1380 struct ref *ref, *stale_refs = get_stale_heads(rs, ref_map);
1381 struct strbuf err = STRBUF_INIT;
1382 const char *dangling_msg = dry_run
1383 ? _(" (%s will become dangling)")
1384 : _(" (%s has become dangling)");
1386 if (!dry_run) {
1387 if (transaction) {
1388 for (ref = stale_refs; ref; ref = ref->next) {
1389 result = ref_transaction_delete(transaction, ref->name, NULL, 0,
1390 "fetch: prune", &err);
1391 if (result)
1392 goto cleanup;
1394 } else {
1395 struct string_list refnames = STRING_LIST_INIT_NODUP;
1397 for (ref = stale_refs; ref; ref = ref->next)
1398 string_list_append(&refnames, ref->name);
1400 result = refs_delete_refs(get_main_ref_store(the_repository),
1401 "fetch: prune", &refnames,
1403 string_list_clear(&refnames, 0);
1407 if (verbosity >= 0) {
1408 int summary_width = transport_summary_width(stale_refs);
1410 for (ref = stale_refs; ref; ref = ref->next) {
1411 display_ref_update(display_state, '-', _("[deleted]"), NULL,
1412 _("(none)"), ref->name,
1413 &ref->new_oid, &ref->old_oid,
1414 summary_width);
1415 warn_dangling_symref(stderr, dangling_msg, ref->name);
1419 cleanup:
1420 strbuf_release(&err);
1421 free_refs(stale_refs);
1422 return result;
1425 static void check_not_current_branch(struct ref *ref_map)
1427 const char *path;
1428 for (; ref_map; ref_map = ref_map->next)
1429 if (ref_map->peer_ref &&
1430 starts_with(ref_map->peer_ref->name, "refs/heads/") &&
1431 (path = branch_checked_out(ref_map->peer_ref->name)))
1432 die(_("refusing to fetch into branch '%s' "
1433 "checked out at '%s'"),
1434 ref_map->peer_ref->name, path);
1437 static int truncate_fetch_head(void)
1439 const char *filename = git_path_fetch_head(the_repository);
1440 FILE *fp = fopen_for_writing(filename);
1442 if (!fp)
1443 return error_errno(_("cannot open '%s'"), filename);
1444 fclose(fp);
1445 return 0;
1448 static void set_option(struct transport *transport, const char *name, const char *value)
1450 int r = transport_set_option(transport, name, value);
1451 if (r < 0)
1452 die(_("option \"%s\" value \"%s\" is not valid for %s"),
1453 name, value, transport->url);
1454 if (r > 0)
1455 warning(_("option \"%s\" is ignored for %s\n"),
1456 name, transport->url);
1460 static int add_oid(const char *refname UNUSED,
1461 const struct object_id *oid,
1462 int flags UNUSED, void *cb_data)
1464 struct oid_array *oids = cb_data;
1466 oid_array_append(oids, oid);
1467 return 0;
1470 static void add_negotiation_tips(struct git_transport_options *smart_options)
1472 struct oid_array *oids = xcalloc(1, sizeof(*oids));
1473 int i;
1475 for (i = 0; i < negotiation_tip.nr; i++) {
1476 const char *s = negotiation_tip.items[i].string;
1477 int old_nr;
1478 if (!has_glob_specials(s)) {
1479 struct object_id oid;
1480 if (repo_get_oid(the_repository, s, &oid))
1481 die(_("%s is not a valid object"), s);
1482 if (!has_object(the_repository, &oid, 0))
1483 die(_("the object %s does not exist"), s);
1484 oid_array_append(oids, &oid);
1485 continue;
1487 old_nr = oids->nr;
1488 refs_for_each_glob_ref(get_main_ref_store(the_repository),
1489 add_oid, s, oids);
1490 if (old_nr == oids->nr)
1491 warning("ignoring --negotiation-tip=%s because it does not match any refs",
1494 smart_options->negotiation_tips = oids;
1497 static struct transport *prepare_transport(struct remote *remote, int deepen)
1499 struct transport *transport;
1501 transport = transport_get(remote, NULL);
1502 transport_set_verbosity(transport, verbosity, progress);
1503 transport->family = family;
1504 if (upload_pack)
1505 set_option(transport, TRANS_OPT_UPLOADPACK, upload_pack);
1506 if (keep)
1507 set_option(transport, TRANS_OPT_KEEP, "yes");
1508 if (depth)
1509 set_option(transport, TRANS_OPT_DEPTH, depth);
1510 if (deepen && deepen_since)
1511 set_option(transport, TRANS_OPT_DEEPEN_SINCE, deepen_since);
1512 if (deepen && deepen_not.nr)
1513 set_option(transport, TRANS_OPT_DEEPEN_NOT,
1514 (const char *)&deepen_not);
1515 if (deepen_relative)
1516 set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, "yes");
1517 if (update_shallow)
1518 set_option(transport, TRANS_OPT_UPDATE_SHALLOW, "yes");
1519 if (refetch)
1520 set_option(transport, TRANS_OPT_REFETCH, "yes");
1521 if (filter_options.choice) {
1522 const char *spec =
1523 expand_list_objects_filter_spec(&filter_options);
1524 set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER, spec);
1525 set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1527 if (negotiation_tip.nr) {
1528 if (transport->smart_options)
1529 add_negotiation_tips(transport->smart_options);
1530 else
1531 warning("ignoring --negotiation-tip because the protocol does not support it");
1533 return transport;
1536 static int backfill_tags(struct display_state *display_state,
1537 struct transport *transport,
1538 struct ref_transaction *transaction,
1539 struct ref *ref_map,
1540 struct fetch_head *fetch_head,
1541 const struct fetch_config *config)
1543 int retcode, cannot_reuse;
1546 * Once we have set TRANS_OPT_DEEPEN_SINCE, we can't unset it
1547 * when remote helper is used (setting it to an empty string
1548 * is not unsetting). We could extend the remote helper
1549 * protocol for that, but for now, just force a new connection
1550 * without deepen-since. Similar story for deepen-not.
1552 cannot_reuse = transport->cannot_reuse ||
1553 deepen_since || deepen_not.nr;
1554 if (cannot_reuse) {
1555 gsecondary = prepare_transport(transport->remote, 0);
1556 transport = gsecondary;
1559 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
1560 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
1561 transport_set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, NULL);
1562 retcode = fetch_and_consume_refs(display_state, transport, transaction, ref_map,
1563 fetch_head, config);
1565 if (gsecondary) {
1566 transport_disconnect(gsecondary);
1567 gsecondary = NULL;
1570 return retcode;
1573 static int do_fetch(struct transport *transport,
1574 struct refspec *rs,
1575 const struct fetch_config *config)
1577 struct ref_transaction *transaction = NULL;
1578 struct ref *ref_map = NULL;
1579 struct display_state display_state = { 0 };
1580 int autotags = (transport->remote->fetch_tags == 1);
1581 int retcode = 0;
1582 const struct ref *remote_refs;
1583 struct transport_ls_refs_options transport_ls_refs_options =
1584 TRANSPORT_LS_REFS_OPTIONS_INIT;
1585 int must_list_refs = 1;
1586 struct fetch_head fetch_head = { 0 };
1587 struct strbuf err = STRBUF_INIT;
1589 if (tags == TAGS_DEFAULT) {
1590 if (transport->remote->fetch_tags == 2)
1591 tags = TAGS_SET;
1592 if (transport->remote->fetch_tags == -1)
1593 tags = TAGS_UNSET;
1596 /* if not appending, truncate FETCH_HEAD */
1597 if (!append && write_fetch_head) {
1598 retcode = truncate_fetch_head();
1599 if (retcode)
1600 goto cleanup;
1603 if (rs->nr) {
1604 int i;
1606 refspec_ref_prefixes(rs, &transport_ls_refs_options.ref_prefixes);
1609 * We can avoid listing refs if all of them are exact
1610 * OIDs
1612 must_list_refs = 0;
1613 for (i = 0; i < rs->nr; i++) {
1614 if (!rs->items[i].exact_sha1) {
1615 must_list_refs = 1;
1616 break;
1619 } else {
1620 struct branch *branch = branch_get(NULL);
1622 if (transport->remote->fetch.nr)
1623 refspec_ref_prefixes(&transport->remote->fetch,
1624 &transport_ls_refs_options.ref_prefixes);
1625 if (branch_has_merge_config(branch) &&
1626 !strcmp(branch->remote_name, transport->remote->name)) {
1627 int i;
1628 for (i = 0; i < branch->merge_nr; i++) {
1629 strvec_push(&transport_ls_refs_options.ref_prefixes,
1630 branch->merge[i]->src);
1635 if (tags == TAGS_SET || tags == TAGS_DEFAULT) {
1636 must_list_refs = 1;
1637 if (transport_ls_refs_options.ref_prefixes.nr)
1638 strvec_push(&transport_ls_refs_options.ref_prefixes,
1639 "refs/tags/");
1642 if (must_list_refs) {
1643 trace2_region_enter("fetch", "remote_refs", the_repository);
1644 remote_refs = transport_get_remote_refs(transport,
1645 &transport_ls_refs_options);
1646 trace2_region_leave("fetch", "remote_refs", the_repository);
1647 } else
1648 remote_refs = NULL;
1650 transport_ls_refs_options_release(&transport_ls_refs_options);
1652 ref_map = get_ref_map(transport->remote, remote_refs, rs,
1653 tags, &autotags);
1654 if (!update_head_ok)
1655 check_not_current_branch(ref_map);
1657 retcode = open_fetch_head(&fetch_head);
1658 if (retcode)
1659 goto cleanup;
1661 display_state_init(&display_state, ref_map, transport->url,
1662 config->display_format);
1664 if (atomic_fetch) {
1665 transaction = ref_store_transaction_begin(get_main_ref_store(the_repository),
1666 &err);
1667 if (!transaction) {
1668 retcode = -1;
1669 goto cleanup;
1673 if (tags == TAGS_DEFAULT && autotags)
1674 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1675 if (prune) {
1677 * We only prune based on refspecs specified
1678 * explicitly (via command line or configuration); we
1679 * don't care whether --tags was specified.
1681 if (rs->nr) {
1682 retcode = prune_refs(&display_state, rs, transaction, ref_map);
1683 } else {
1684 retcode = prune_refs(&display_state, &transport->remote->fetch,
1685 transaction, ref_map);
1687 if (retcode != 0)
1688 retcode = 1;
1691 if (fetch_and_consume_refs(&display_state, transport, transaction, ref_map,
1692 &fetch_head, config)) {
1693 retcode = 1;
1694 goto cleanup;
1698 * If neither --no-tags nor --tags was specified, do automated tag
1699 * following.
1701 if (tags == TAGS_DEFAULT && autotags) {
1702 struct ref *tags_ref_map = NULL, **tail = &tags_ref_map;
1704 find_non_local_tags(remote_refs, transaction, &tags_ref_map, &tail);
1705 if (tags_ref_map) {
1707 * If backfilling of tags fails then we want to tell
1708 * the user so, but we have to continue regardless to
1709 * populate upstream information of the references we
1710 * have already fetched above. The exception though is
1711 * when `--atomic` is passed: in that case we'll abort
1712 * the transaction and don't commit anything.
1714 if (backfill_tags(&display_state, transport, transaction, tags_ref_map,
1715 &fetch_head, config))
1716 retcode = 1;
1719 free_refs(tags_ref_map);
1722 if (transaction) {
1723 if (retcode)
1724 goto cleanup;
1726 retcode = ref_transaction_commit(transaction, &err);
1727 if (retcode) {
1728 ref_transaction_free(transaction);
1729 transaction = NULL;
1730 goto cleanup;
1734 commit_fetch_head(&fetch_head);
1736 if (set_upstream) {
1737 struct branch *branch = branch_get("HEAD");
1738 struct ref *rm;
1739 struct ref *source_ref = NULL;
1742 * We're setting the upstream configuration for the
1743 * current branch. The relevant upstream is the
1744 * fetched branch that is meant to be merged with the
1745 * current one, i.e. the one fetched to FETCH_HEAD.
1747 * When there are several such branches, consider the
1748 * request ambiguous and err on the safe side by doing
1749 * nothing and just emit a warning.
1751 for (rm = ref_map; rm; rm = rm->next) {
1752 if (!rm->peer_ref) {
1753 if (source_ref) {
1754 warning(_("multiple branches detected, incompatible with --set-upstream"));
1755 goto cleanup;
1756 } else {
1757 source_ref = rm;
1761 if (source_ref) {
1762 if (!branch) {
1763 const char *shortname = source_ref->name;
1764 skip_prefix(shortname, "refs/heads/", &shortname);
1766 warning(_("could not set upstream of HEAD to '%s' from '%s' when "
1767 "it does not point to any branch."),
1768 shortname, transport->remote->name);
1769 goto cleanup;
1772 if (!strcmp(source_ref->name, "HEAD") ||
1773 starts_with(source_ref->name, "refs/heads/"))
1774 install_branch_config(0,
1775 branch->name,
1776 transport->remote->name,
1777 source_ref->name);
1778 else if (starts_with(source_ref->name, "refs/remotes/"))
1779 warning(_("not setting upstream for a remote remote-tracking branch"));
1780 else if (starts_with(source_ref->name, "refs/tags/"))
1781 warning(_("not setting upstream for a remote tag"));
1782 else
1783 warning(_("unknown branch type"));
1784 } else {
1785 warning(_("no source branch found;\n"
1786 "you need to specify exactly one branch with the --set-upstream option"));
1790 cleanup:
1791 if (retcode) {
1792 if (err.len) {
1793 error("%s", err.buf);
1794 strbuf_reset(&err);
1796 if (transaction && ref_transaction_abort(transaction, &err) &&
1797 err.len)
1798 error("%s", err.buf);
1801 display_state_release(&display_state);
1802 close_fetch_head(&fetch_head);
1803 strbuf_release(&err);
1804 free_refs(ref_map);
1805 return retcode;
1808 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
1810 struct string_list *list = priv;
1811 if (!remote->skip_default_update)
1812 string_list_append(list, remote->name);
1813 return 0;
1816 struct remote_group_data {
1817 const char *name;
1818 struct string_list *list;
1821 static int get_remote_group(const char *key, const char *value,
1822 const struct config_context *ctx UNUSED,
1823 void *priv)
1825 struct remote_group_data *g = priv;
1827 if (skip_prefix(key, "remotes.", &key) && !strcmp(key, g->name)) {
1828 /* split list by white space */
1829 while (*value) {
1830 size_t wordlen = strcspn(value, " \t\n");
1832 if (wordlen >= 1)
1833 string_list_append_nodup(g->list,
1834 xstrndup(value, wordlen));
1835 value += wordlen + (value[wordlen] != '\0');
1839 return 0;
1842 static int add_remote_or_group(const char *name, struct string_list *list)
1844 int prev_nr = list->nr;
1845 struct remote_group_data g;
1846 g.name = name; g.list = list;
1848 git_config(get_remote_group, &g);
1849 if (list->nr == prev_nr) {
1850 struct remote *remote = remote_get(name);
1851 if (!remote_is_configured(remote, 0))
1852 return 0;
1853 string_list_append(list, remote->name);
1855 return 1;
1858 static void add_options_to_argv(struct strvec *argv,
1859 const struct fetch_config *config)
1861 if (dry_run)
1862 strvec_push(argv, "--dry-run");
1863 if (prune != -1)
1864 strvec_push(argv, prune ? "--prune" : "--no-prune");
1865 if (prune_tags != -1)
1866 strvec_push(argv, prune_tags ? "--prune-tags" : "--no-prune-tags");
1867 if (update_head_ok)
1868 strvec_push(argv, "--update-head-ok");
1869 if (force)
1870 strvec_push(argv, "--force");
1871 if (keep)
1872 strvec_push(argv, "--keep");
1873 if (config->recurse_submodules == RECURSE_SUBMODULES_ON)
1874 strvec_push(argv, "--recurse-submodules");
1875 else if (config->recurse_submodules == RECURSE_SUBMODULES_OFF)
1876 strvec_push(argv, "--no-recurse-submodules");
1877 else if (config->recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND)
1878 strvec_push(argv, "--recurse-submodules=on-demand");
1879 if (tags == TAGS_SET)
1880 strvec_push(argv, "--tags");
1881 else if (tags == TAGS_UNSET)
1882 strvec_push(argv, "--no-tags");
1883 if (verbosity >= 2)
1884 strvec_push(argv, "-v");
1885 if (verbosity >= 1)
1886 strvec_push(argv, "-v");
1887 else if (verbosity < 0)
1888 strvec_push(argv, "-q");
1889 if (family == TRANSPORT_FAMILY_IPV4)
1890 strvec_push(argv, "--ipv4");
1891 else if (family == TRANSPORT_FAMILY_IPV6)
1892 strvec_push(argv, "--ipv6");
1893 if (!write_fetch_head)
1894 strvec_push(argv, "--no-write-fetch-head");
1895 if (config->display_format == DISPLAY_FORMAT_PORCELAIN)
1896 strvec_pushf(argv, "--porcelain");
1899 /* Fetch multiple remotes in parallel */
1901 struct parallel_fetch_state {
1902 const char **argv;
1903 struct string_list *remotes;
1904 int next, result;
1905 const struct fetch_config *config;
1908 static int fetch_next_remote(struct child_process *cp,
1909 struct strbuf *out UNUSED,
1910 void *cb, void **task_cb)
1912 struct parallel_fetch_state *state = cb;
1913 char *remote;
1915 if (state->next < 0 || state->next >= state->remotes->nr)
1916 return 0;
1918 remote = state->remotes->items[state->next++].string;
1919 *task_cb = remote;
1921 strvec_pushv(&cp->args, state->argv);
1922 strvec_push(&cp->args, remote);
1923 cp->git_cmd = 1;
1925 if (verbosity >= 0 && state->config->display_format != DISPLAY_FORMAT_PORCELAIN)
1926 printf(_("Fetching %s\n"), remote);
1928 return 1;
1931 static int fetch_failed_to_start(struct strbuf *out UNUSED,
1932 void *cb, void *task_cb)
1934 struct parallel_fetch_state *state = cb;
1935 const char *remote = task_cb;
1937 state->result = error(_("could not fetch %s"), remote);
1939 return 0;
1942 static int fetch_finished(int result, struct strbuf *out,
1943 void *cb, void *task_cb)
1945 struct parallel_fetch_state *state = cb;
1946 const char *remote = task_cb;
1948 if (result) {
1949 strbuf_addf(out, _("could not fetch '%s' (exit code: %d)\n"),
1950 remote, result);
1951 state->result = -1;
1954 return 0;
1957 static int fetch_multiple(struct string_list *list, int max_children,
1958 const struct fetch_config *config)
1960 int i, result = 0;
1961 struct strvec argv = STRVEC_INIT;
1963 if (!append && write_fetch_head) {
1964 int errcode = truncate_fetch_head();
1965 if (errcode)
1966 return errcode;
1970 * Cancel out the fetch.bundleURI config when running subprocesses,
1971 * to avoid fetching from the same bundle list multiple times.
1973 strvec_pushl(&argv, "-c", "fetch.bundleURI=",
1974 "fetch", "--append", "--no-auto-gc",
1975 "--no-write-commit-graph", NULL);
1976 add_options_to_argv(&argv, config);
1978 if (max_children != 1 && list->nr != 1) {
1979 struct parallel_fetch_state state = { argv.v, list, 0, 0, config };
1980 const struct run_process_parallel_opts opts = {
1981 .tr2_category = "fetch",
1982 .tr2_label = "parallel/fetch",
1984 .processes = max_children,
1986 .get_next_task = &fetch_next_remote,
1987 .start_failure = &fetch_failed_to_start,
1988 .task_finished = &fetch_finished,
1989 .data = &state,
1992 strvec_push(&argv, "--end-of-options");
1994 run_processes_parallel(&opts);
1995 result = state.result;
1996 } else
1997 for (i = 0; i < list->nr; i++) {
1998 const char *name = list->items[i].string;
1999 struct child_process cmd = CHILD_PROCESS_INIT;
2001 strvec_pushv(&cmd.args, argv.v);
2002 strvec_push(&cmd.args, name);
2003 if (verbosity >= 0 && config->display_format != DISPLAY_FORMAT_PORCELAIN)
2004 printf(_("Fetching %s\n"), name);
2005 cmd.git_cmd = 1;
2006 if (run_command(&cmd)) {
2007 error(_("could not fetch %s"), name);
2008 result = 1;
2012 strvec_clear(&argv);
2013 return !!result;
2017 * Fetching from the promisor remote should use the given filter-spec
2018 * or inherit the default filter-spec from the config.
2020 static inline void fetch_one_setup_partial(struct remote *remote)
2023 * Explicit --no-filter argument overrides everything, regardless
2024 * of any prior partial clones and fetches.
2026 if (filter_options.no_filter)
2027 return;
2030 * If no prior partial clone/fetch and the current fetch DID NOT
2031 * request a partial-fetch, do a normal fetch.
2033 if (!repo_has_promisor_remote(the_repository) && !filter_options.choice)
2034 return;
2037 * If this is a partial-fetch request, we enable partial on
2038 * this repo if not already enabled and remember the given
2039 * filter-spec as the default for subsequent fetches to this
2040 * remote if there is currently no default filter-spec.
2042 if (filter_options.choice) {
2043 partial_clone_register(remote->name, &filter_options);
2044 return;
2048 * Do a partial-fetch from the promisor remote using either the
2049 * explicitly given filter-spec or inherit the filter-spec from
2050 * the config.
2052 if (!filter_options.choice)
2053 partial_clone_get_default_filter_spec(&filter_options, remote->name);
2054 return;
2057 static int fetch_one(struct remote *remote, int argc, const char **argv,
2058 int prune_tags_ok, int use_stdin_refspecs,
2059 const struct fetch_config *config)
2061 struct refspec rs = REFSPEC_INIT_FETCH;
2062 int i;
2063 int exit_code;
2064 int maybe_prune_tags;
2065 int remote_via_config = remote_is_configured(remote, 0);
2067 if (!remote)
2068 die(_("no remote repository specified; please specify either a URL or a\n"
2069 "remote name from which new revisions should be fetched"));
2071 gtransport = prepare_transport(remote, 1);
2073 if (prune < 0) {
2074 /* no command line request */
2075 if (0 <= remote->prune)
2076 prune = remote->prune;
2077 else if (0 <= config->prune)
2078 prune = config->prune;
2079 else
2080 prune = PRUNE_BY_DEFAULT;
2083 if (prune_tags < 0) {
2084 /* no command line request */
2085 if (0 <= remote->prune_tags)
2086 prune_tags = remote->prune_tags;
2087 else if (0 <= config->prune_tags)
2088 prune_tags = config->prune_tags;
2089 else
2090 prune_tags = PRUNE_TAGS_BY_DEFAULT;
2093 maybe_prune_tags = prune_tags_ok && prune_tags;
2094 if (maybe_prune_tags && remote_via_config)
2095 refspec_append(&remote->fetch, TAG_REFSPEC);
2097 if (maybe_prune_tags && (argc || !remote_via_config))
2098 refspec_append(&rs, TAG_REFSPEC);
2100 for (i = 0; i < argc; i++) {
2101 if (!strcmp(argv[i], "tag")) {
2102 i++;
2103 if (i >= argc)
2104 die(_("you need to specify a tag name"));
2106 refspec_appendf(&rs, "refs/tags/%s:refs/tags/%s",
2107 argv[i], argv[i]);
2108 } else {
2109 refspec_append(&rs, argv[i]);
2113 if (use_stdin_refspecs) {
2114 struct strbuf line = STRBUF_INIT;
2115 while (strbuf_getline_lf(&line, stdin) != EOF)
2116 refspec_append(&rs, line.buf);
2117 strbuf_release(&line);
2120 if (server_options.nr)
2121 gtransport->server_options = &server_options;
2123 sigchain_push_common(unlock_pack_on_signal);
2124 atexit(unlock_pack_atexit);
2125 sigchain_push(SIGPIPE, SIG_IGN);
2126 exit_code = do_fetch(gtransport, &rs, config);
2127 sigchain_pop(SIGPIPE);
2128 refspec_clear(&rs);
2129 transport_disconnect(gtransport);
2130 gtransport = NULL;
2131 return exit_code;
2134 int cmd_fetch(int argc, const char **argv, const char *prefix)
2136 struct fetch_config config = {
2137 .display_format = DISPLAY_FORMAT_FULL,
2138 .prune = -1,
2139 .prune_tags = -1,
2140 .show_forced_updates = 1,
2141 .recurse_submodules = RECURSE_SUBMODULES_DEFAULT,
2142 .parallel = 1,
2143 .submodule_fetch_jobs = -1,
2145 const char *submodule_prefix = "";
2146 const char *bundle_uri;
2147 struct string_list list = STRING_LIST_INIT_DUP;
2148 struct remote *remote = NULL;
2149 int all = -1, multiple = 0;
2150 int result = 0;
2151 int prune_tags_ok = 1;
2152 int enable_auto_gc = 1;
2153 int unshallow = 0;
2154 int max_jobs = -1;
2155 int recurse_submodules_cli = RECURSE_SUBMODULES_DEFAULT;
2156 int recurse_submodules_default = RECURSE_SUBMODULES_ON_DEMAND;
2157 int fetch_write_commit_graph = -1;
2158 int stdin_refspecs = 0;
2159 int negotiate_only = 0;
2160 int porcelain = 0;
2161 int i;
2163 struct option builtin_fetch_options[] = {
2164 OPT__VERBOSITY(&verbosity),
2165 OPT_BOOL(0, "all", &all,
2166 N_("fetch from all remotes")),
2167 OPT_BOOL(0, "set-upstream", &set_upstream,
2168 N_("set upstream for git pull/fetch")),
2169 OPT_BOOL('a', "append", &append,
2170 N_("append to .git/FETCH_HEAD instead of overwriting")),
2171 OPT_BOOL(0, "atomic", &atomic_fetch,
2172 N_("use atomic transaction to update references")),
2173 OPT_STRING(0, "upload-pack", &upload_pack, N_("path"),
2174 N_("path to upload pack on remote end")),
2175 OPT__FORCE(&force, N_("force overwrite of local reference"), 0),
2176 OPT_BOOL('m', "multiple", &multiple,
2177 N_("fetch from multiple remotes")),
2178 OPT_SET_INT('t', "tags", &tags,
2179 N_("fetch all tags and associated objects"), TAGS_SET),
2180 OPT_SET_INT('n', NULL, &tags,
2181 N_("do not fetch all tags (--no-tags)"), TAGS_UNSET),
2182 OPT_INTEGER('j', "jobs", &max_jobs,
2183 N_("number of submodules fetched in parallel")),
2184 OPT_BOOL(0, "prefetch", &prefetch,
2185 N_("modify the refspec to place all refs within refs/prefetch/")),
2186 OPT_BOOL('p', "prune", &prune,
2187 N_("prune remote-tracking branches no longer on remote")),
2188 OPT_BOOL('P', "prune-tags", &prune_tags,
2189 N_("prune local tags no longer on remote and clobber changed tags")),
2190 OPT_CALLBACK_F(0, "recurse-submodules", &recurse_submodules_cli, N_("on-demand"),
2191 N_("control recursive fetching of submodules"),
2192 PARSE_OPT_OPTARG, option_fetch_parse_recurse_submodules),
2193 OPT_BOOL(0, "dry-run", &dry_run,
2194 N_("dry run")),
2195 OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
2196 OPT_BOOL(0, "write-fetch-head", &write_fetch_head,
2197 N_("write fetched references to the FETCH_HEAD file")),
2198 OPT_BOOL('k', "keep", &keep, N_("keep downloaded pack")),
2199 OPT_BOOL('u', "update-head-ok", &update_head_ok,
2200 N_("allow updating of HEAD ref")),
2201 OPT_BOOL(0, "progress", &progress, N_("force progress reporting")),
2202 OPT_STRING(0, "depth", &depth, N_("depth"),
2203 N_("deepen history of shallow clone")),
2204 OPT_STRING(0, "shallow-since", &deepen_since, N_("time"),
2205 N_("deepen history of shallow repository based on time")),
2206 OPT_STRING_LIST(0, "shallow-exclude", &deepen_not, N_("revision"),
2207 N_("deepen history of shallow clone, excluding rev")),
2208 OPT_INTEGER(0, "deepen", &deepen_relative,
2209 N_("deepen history of shallow clone")),
2210 OPT_SET_INT_F(0, "unshallow", &unshallow,
2211 N_("convert to a complete repository"),
2212 1, PARSE_OPT_NONEG),
2213 OPT_SET_INT_F(0, "refetch", &refetch,
2214 N_("re-fetch without negotiating common commits"),
2215 1, PARSE_OPT_NONEG),
2216 { OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, N_("dir"),
2217 N_("prepend this to submodule path output"), PARSE_OPT_HIDDEN },
2218 OPT_CALLBACK_F(0, "recurse-submodules-default",
2219 &recurse_submodules_default, N_("on-demand"),
2220 N_("default for recursive fetching of submodules "
2221 "(lower priority than config files)"),
2222 PARSE_OPT_HIDDEN, option_fetch_parse_recurse_submodules),
2223 OPT_BOOL(0, "update-shallow", &update_shallow,
2224 N_("accept refs that update .git/shallow")),
2225 OPT_CALLBACK_F(0, "refmap", &refmap, N_("refmap"),
2226 N_("specify fetch refmap"), PARSE_OPT_NONEG, parse_refmap_arg),
2227 OPT_STRING_LIST('o', "server-option", &server_options, N_("server-specific"), N_("option to transmit")),
2228 OPT_IPVERSION(&family),
2229 OPT_STRING_LIST(0, "negotiation-tip", &negotiation_tip, N_("revision"),
2230 N_("report that we have only objects reachable from this object")),
2231 OPT_BOOL(0, "negotiate-only", &negotiate_only,
2232 N_("do not fetch a packfile; instead, print ancestors of negotiation tips")),
2233 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
2234 OPT_BOOL(0, "auto-maintenance", &enable_auto_gc,
2235 N_("run 'maintenance --auto' after fetching")),
2236 OPT_BOOL(0, "auto-gc", &enable_auto_gc,
2237 N_("run 'maintenance --auto' after fetching")),
2238 OPT_BOOL(0, "show-forced-updates", &config.show_forced_updates,
2239 N_("check for forced-updates on all updated branches")),
2240 OPT_BOOL(0, "write-commit-graph", &fetch_write_commit_graph,
2241 N_("write the commit-graph after fetching")),
2242 OPT_BOOL(0, "stdin", &stdin_refspecs,
2243 N_("accept refspecs from stdin")),
2244 OPT_END()
2247 packet_trace_identity("fetch");
2249 /* Record the command line for the reflog */
2250 strbuf_addstr(&default_rla, "fetch");
2251 for (i = 1; i < argc; i++) {
2252 /* This handles non-URLs gracefully */
2253 char *anon = transport_anonymize_url(argv[i]);
2255 strbuf_addf(&default_rla, " %s", anon);
2256 free(anon);
2259 git_config(git_fetch_config, &config);
2260 if (the_repository->gitdir) {
2261 prepare_repo_settings(the_repository);
2262 the_repository->settings.command_requires_full_index = 0;
2265 argc = parse_options(argc, argv, prefix,
2266 builtin_fetch_options, builtin_fetch_usage, 0);
2268 if (recurse_submodules_cli != RECURSE_SUBMODULES_DEFAULT)
2269 config.recurse_submodules = recurse_submodules_cli;
2271 if (negotiate_only) {
2272 switch (recurse_submodules_cli) {
2273 case RECURSE_SUBMODULES_OFF:
2274 case RECURSE_SUBMODULES_DEFAULT:
2276 * --negotiate-only should never recurse into
2277 * submodules. Skip it by setting recurse_submodules to
2278 * RECURSE_SUBMODULES_OFF.
2280 config.recurse_submodules = RECURSE_SUBMODULES_OFF;
2281 break;
2283 default:
2284 die(_("options '%s' and '%s' cannot be used together"),
2285 "--negotiate-only", "--recurse-submodules");
2289 if (config.recurse_submodules != RECURSE_SUBMODULES_OFF) {
2290 int *sfjc = config.submodule_fetch_jobs == -1
2291 ? &config.submodule_fetch_jobs : NULL;
2292 int *rs = config.recurse_submodules == RECURSE_SUBMODULES_DEFAULT
2293 ? &config.recurse_submodules : NULL;
2295 fetch_config_from_gitmodules(sfjc, rs);
2299 if (porcelain) {
2300 switch (recurse_submodules_cli) {
2301 case RECURSE_SUBMODULES_OFF:
2302 case RECURSE_SUBMODULES_DEFAULT:
2304 * Reference updates in submodules would be ambiguous
2305 * in porcelain mode, so we reject this combination.
2307 config.recurse_submodules = RECURSE_SUBMODULES_OFF;
2308 break;
2310 default:
2311 die(_("options '%s' and '%s' cannot be used together"),
2312 "--porcelain", "--recurse-submodules");
2315 config.display_format = DISPLAY_FORMAT_PORCELAIN;
2318 if (negotiate_only && !negotiation_tip.nr)
2319 die(_("--negotiate-only needs one or more --negotiation-tip=*"));
2321 if (deepen_relative) {
2322 if (deepen_relative < 0)
2323 die(_("negative depth in --deepen is not supported"));
2324 if (depth)
2325 die(_("options '%s' and '%s' cannot be used together"), "--deepen", "--depth");
2326 depth = xstrfmt("%d", deepen_relative);
2328 if (unshallow) {
2329 if (depth)
2330 die(_("options '%s' and '%s' cannot be used together"), "--depth", "--unshallow");
2331 else if (!is_repository_shallow(the_repository))
2332 die(_("--unshallow on a complete repository does not make sense"));
2333 else
2334 depth = xstrfmt("%d", INFINITE_DEPTH);
2337 /* no need to be strict, transport_set_option() will validate it again */
2338 if (depth && atoi(depth) < 1)
2339 die(_("depth %s is not a positive number"), depth);
2340 if (depth || deepen_since || deepen_not.nr)
2341 deepen = 1;
2343 /* FETCH_HEAD never gets updated in --dry-run mode */
2344 if (dry_run)
2345 write_fetch_head = 0;
2347 if (!max_jobs)
2348 max_jobs = online_cpus();
2350 if (!git_config_get_string_tmp("fetch.bundleuri", &bundle_uri) &&
2351 fetch_bundle_uri(the_repository, bundle_uri, NULL))
2352 warning(_("failed to fetch bundles from '%s'"), bundle_uri);
2354 if (all < 0) {
2356 * no --[no-]all given;
2357 * only use config option if no remote was explicitly specified
2359 all = (!argc) ? config.all : 0;
2362 if (all) {
2363 if (argc == 1)
2364 die(_("fetch --all does not take a repository argument"));
2365 else if (argc > 1)
2366 die(_("fetch --all does not make sense with refspecs"));
2368 (void) for_each_remote(get_one_remote_for_fetch, &list);
2370 /* do not do fetch_multiple() of one */
2371 if (list.nr == 1)
2372 remote = remote_get(list.items[0].string);
2373 } else if (argc == 0) {
2374 /* No arguments -- use default remote */
2375 remote = remote_get(NULL);
2376 } else if (multiple) {
2377 /* All arguments are assumed to be remotes or groups */
2378 for (i = 0; i < argc; i++)
2379 if (!add_remote_or_group(argv[i], &list))
2380 die(_("no such remote or remote group: %s"),
2381 argv[i]);
2382 } else {
2383 /* Single remote or group */
2384 (void) add_remote_or_group(argv[0], &list);
2385 if (list.nr > 1) {
2386 /* More than one remote */
2387 if (argc > 1)
2388 die(_("fetching a group and specifying refspecs does not make sense"));
2389 } else {
2390 /* Zero or one remotes */
2391 remote = remote_get(argv[0]);
2392 prune_tags_ok = (argc == 1);
2393 argc--;
2394 argv++;
2397 string_list_remove_duplicates(&list, 0);
2399 if (negotiate_only) {
2400 struct oidset acked_commits = OIDSET_INIT;
2401 struct oidset_iter iter;
2402 const struct object_id *oid;
2404 if (!remote)
2405 die(_("must supply remote when using --negotiate-only"));
2406 gtransport = prepare_transport(remote, 1);
2407 if (gtransport->smart_options) {
2408 gtransport->smart_options->acked_commits = &acked_commits;
2409 } else {
2410 warning(_("protocol does not support --negotiate-only, exiting"));
2411 result = 1;
2412 goto cleanup;
2414 if (server_options.nr)
2415 gtransport->server_options = &server_options;
2416 result = transport_fetch_refs(gtransport, NULL);
2418 oidset_iter_init(&acked_commits, &iter);
2419 while ((oid = oidset_iter_next(&iter)))
2420 printf("%s\n", oid_to_hex(oid));
2421 oidset_clear(&acked_commits);
2422 } else if (remote) {
2423 if (filter_options.choice || repo_has_promisor_remote(the_repository))
2424 fetch_one_setup_partial(remote);
2425 result = fetch_one(remote, argc, argv, prune_tags_ok, stdin_refspecs,
2426 &config);
2427 } else {
2428 int max_children = max_jobs;
2430 if (filter_options.choice)
2431 die(_("--filter can only be used with the remote "
2432 "configured in extensions.partialclone"));
2434 if (atomic_fetch)
2435 die(_("--atomic can only be used when fetching "
2436 "from one remote"));
2438 if (stdin_refspecs)
2439 die(_("--stdin can only be used when fetching "
2440 "from one remote"));
2442 if (max_children < 0)
2443 max_children = config.parallel;
2445 /* TODO should this also die if we have a previous partial-clone? */
2446 result = fetch_multiple(&list, max_children, &config);
2450 * This is only needed after fetch_one(), which does not fetch
2451 * submodules by itself.
2453 * When we fetch from multiple remotes, fetch_multiple() has
2454 * already updated submodules to grab commits necessary for
2455 * the fetched history from each remote, so there is no need
2456 * to fetch submodules from here.
2458 if (!result && remote && (config.recurse_submodules != RECURSE_SUBMODULES_OFF)) {
2459 struct strvec options = STRVEC_INIT;
2460 int max_children = max_jobs;
2462 if (max_children < 0)
2463 max_children = config.submodule_fetch_jobs;
2464 if (max_children < 0)
2465 max_children = config.parallel;
2467 add_options_to_argv(&options, &config);
2468 result = fetch_submodules(the_repository,
2469 &options,
2470 submodule_prefix,
2471 config.recurse_submodules,
2472 recurse_submodules_default,
2473 verbosity < 0,
2474 max_children);
2475 strvec_clear(&options);
2479 * Skip irrelevant tasks because we know objects were not
2480 * fetched.
2482 * NEEDSWORK: as a future optimization, we can return early
2483 * whenever objects were not fetched e.g. if we already have all
2484 * of them.
2486 if (negotiate_only)
2487 goto cleanup;
2489 prepare_repo_settings(the_repository);
2490 if (fetch_write_commit_graph > 0 ||
2491 (fetch_write_commit_graph < 0 &&
2492 the_repository->settings.fetch_write_commit_graph)) {
2493 int commit_graph_flags = COMMIT_GRAPH_WRITE_SPLIT;
2495 if (progress)
2496 commit_graph_flags |= COMMIT_GRAPH_WRITE_PROGRESS;
2498 write_commit_graph_reachable(the_repository->objects->odb,
2499 commit_graph_flags,
2500 NULL);
2503 if (enable_auto_gc) {
2504 if (refetch) {
2506 * Hint auto-maintenance strongly to encourage repacking,
2507 * but respect config settings disabling it.
2509 int opt_val;
2510 if (git_config_get_int("gc.autopacklimit", &opt_val))
2511 opt_val = -1;
2512 if (opt_val != 0)
2513 git_config_push_parameter("gc.autoPackLimit=1");
2515 if (git_config_get_int("maintenance.incremental-repack.auto", &opt_val))
2516 opt_val = -1;
2517 if (opt_val != 0)
2518 git_config_push_parameter("maintenance.incremental-repack.auto=-1");
2520 run_auto_maintenance(verbosity < 0);
2523 cleanup:
2524 string_list_clear(&list, 0);
2525 return result;