object-store-ll.h: split this header out of object-store.h
[git/debian.git] / builtin / fetch.c
blob951a23d73310b98b093f9d572c306c402b4f250d
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 "packfile.h"
30 #include "pager.h"
31 #include "path.h"
32 #include "pkt-line.h"
33 #include "list-objects-filter-options.h"
34 #include "commit-reach.h"
35 #include "branch.h"
36 #include "promisor-remote.h"
37 #include "commit-graph.h"
38 #include "shallow.h"
39 #include "trace.h"
40 #include "trace2.h"
41 #include "worktree.h"
42 #include "bundle-uri.h"
44 #define FORCED_UPDATES_DELAY_WARNING_IN_MS (10 * 1000)
46 static const char * const builtin_fetch_usage[] = {
47 N_("git fetch [<options>] [<repository> [<refspec>...]]"),
48 N_("git fetch [<options>] <group>"),
49 N_("git fetch --multiple [<options>] [(<repository> | <group>)...]"),
50 N_("git fetch --all [<options>]"),
51 NULL
54 enum {
55 TAGS_UNSET = 0,
56 TAGS_DEFAULT = 1,
57 TAGS_SET = 2
60 enum display_format {
61 DISPLAY_FORMAT_FULL,
62 DISPLAY_FORMAT_COMPACT,
63 DISPLAY_FORMAT_PORCELAIN,
66 struct display_state {
67 struct strbuf buf;
69 int refcol_width;
70 enum display_format format;
72 char *url;
73 int url_len, shown_url;
76 static uint64_t forced_updates_ms = 0;
77 static int prefetch = 0;
78 static int prune = -1; /* unspecified */
79 #define PRUNE_BY_DEFAULT 0 /* do we prune by default? */
81 static int prune_tags = -1; /* unspecified */
82 #define PRUNE_TAGS_BY_DEFAULT 0 /* do we prune tags by default? */
84 static int append, dry_run, force, keep, update_head_ok;
85 static int write_fetch_head = 1;
86 static int verbosity, deepen_relative, set_upstream, refetch;
87 static int progress = -1;
88 static int tags = TAGS_DEFAULT, update_shallow, deepen;
89 static int atomic_fetch;
90 static enum transport_family family;
91 static const char *depth;
92 static const char *deepen_since;
93 static const char *upload_pack;
94 static struct string_list deepen_not = STRING_LIST_INIT_NODUP;
95 static struct strbuf default_rla = STRBUF_INIT;
96 static struct transport *gtransport;
97 static struct transport *gsecondary;
98 static struct refspec refmap = REFSPEC_INIT_FETCH;
99 static struct list_objects_filter_options filter_options = LIST_OBJECTS_FILTER_INIT;
100 static struct string_list server_options = STRING_LIST_INIT_DUP;
101 static struct string_list negotiation_tip = STRING_LIST_INIT_NODUP;
103 struct fetch_config {
104 enum display_format display_format;
105 int prune;
106 int prune_tags;
107 int show_forced_updates;
108 int recurse_submodules;
109 int parallel;
110 int submodule_fetch_jobs;
113 static int git_fetch_config(const char *k, const char *v, void *cb)
115 struct fetch_config *fetch_config = cb;
117 if (!strcmp(k, "fetch.prune")) {
118 fetch_config->prune = git_config_bool(k, v);
119 return 0;
122 if (!strcmp(k, "fetch.prunetags")) {
123 fetch_config->prune_tags = git_config_bool(k, v);
124 return 0;
127 if (!strcmp(k, "fetch.showforcedupdates")) {
128 fetch_config->show_forced_updates = git_config_bool(k, v);
129 return 0;
132 if (!strcmp(k, "submodule.recurse")) {
133 int r = git_config_bool(k, v) ?
134 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
135 fetch_config->recurse_submodules = r;
138 if (!strcmp(k, "submodule.fetchjobs")) {
139 fetch_config->submodule_fetch_jobs = parse_submodule_fetchjobs(k, v);
140 return 0;
141 } else if (!strcmp(k, "fetch.recursesubmodules")) {
142 fetch_config->recurse_submodules = parse_fetch_recurse_submodules_arg(k, v);
143 return 0;
146 if (!strcmp(k, "fetch.parallel")) {
147 fetch_config->parallel = git_config_int(k, v);
148 if (fetch_config->parallel < 0)
149 die(_("fetch.parallel cannot be negative"));
150 if (!fetch_config->parallel)
151 fetch_config->parallel = online_cpus();
152 return 0;
155 if (!strcmp(k, "fetch.output")) {
156 if (!v)
157 return config_error_nonbool(k);
158 else if (!strcasecmp(v, "full"))
159 fetch_config->display_format = DISPLAY_FORMAT_FULL;
160 else if (!strcasecmp(v, "compact"))
161 fetch_config->display_format = DISPLAY_FORMAT_COMPACT;
162 else
163 die(_("invalid value for '%s': '%s'"),
164 "fetch.output", v);
167 return git_default_config(k, v, cb);
170 static int parse_refmap_arg(const struct option *opt, const char *arg, int unset)
172 BUG_ON_OPT_NEG(unset);
175 * "git fetch --refmap='' origin foo"
176 * can be used to tell the command not to store anywhere
178 refspec_append(&refmap, arg);
180 return 0;
183 static void unlock_pack(unsigned int flags)
185 if (gtransport)
186 transport_unlock_pack(gtransport, flags);
187 if (gsecondary)
188 transport_unlock_pack(gsecondary, flags);
191 static void unlock_pack_atexit(void)
193 unlock_pack(0);
196 static void unlock_pack_on_signal(int signo)
198 unlock_pack(TRANSPORT_UNLOCK_PACK_IN_SIGNAL_HANDLER);
199 sigchain_pop(signo);
200 raise(signo);
203 static void add_merge_config(struct ref **head,
204 const struct ref *remote_refs,
205 struct branch *branch,
206 struct ref ***tail)
208 int i;
210 for (i = 0; i < branch->merge_nr; i++) {
211 struct ref *rm, **old_tail = *tail;
212 struct refspec_item refspec;
214 for (rm = *head; rm; rm = rm->next) {
215 if (branch_merge_matches(branch, i, rm->name)) {
216 rm->fetch_head_status = FETCH_HEAD_MERGE;
217 break;
220 if (rm)
221 continue;
224 * Not fetched to a remote-tracking branch? We need to fetch
225 * it anyway to allow this branch's "branch.$name.merge"
226 * to be honored by 'git pull', but we do not have to
227 * fail if branch.$name.merge is misconfigured to point
228 * at a nonexisting branch. If we were indeed called by
229 * 'git pull', it will notice the misconfiguration because
230 * there is no entry in the resulting FETCH_HEAD marked
231 * for merging.
233 memset(&refspec, 0, sizeof(refspec));
234 refspec.src = branch->merge[i]->src;
235 get_fetch_map(remote_refs, &refspec, tail, 1);
236 for (rm = *old_tail; rm; rm = rm->next)
237 rm->fetch_head_status = FETCH_HEAD_MERGE;
241 static void create_fetch_oidset(struct ref **head, struct oidset *out)
243 struct ref *rm = *head;
244 while (rm) {
245 oidset_insert(out, &rm->old_oid);
246 rm = rm->next;
250 struct refname_hash_entry {
251 struct hashmap_entry ent;
252 struct object_id oid;
253 int ignore;
254 char refname[FLEX_ARRAY];
257 static int refname_hash_entry_cmp(const void *hashmap_cmp_fn_data UNUSED,
258 const struct hashmap_entry *eptr,
259 const struct hashmap_entry *entry_or_key,
260 const void *keydata)
262 const struct refname_hash_entry *e1, *e2;
264 e1 = container_of(eptr, const struct refname_hash_entry, ent);
265 e2 = container_of(entry_or_key, const struct refname_hash_entry, ent);
266 return strcmp(e1->refname, keydata ? keydata : e2->refname);
269 static struct refname_hash_entry *refname_hash_add(struct hashmap *map,
270 const char *refname,
271 const struct object_id *oid)
273 struct refname_hash_entry *ent;
274 size_t len = strlen(refname);
276 FLEX_ALLOC_MEM(ent, refname, refname, len);
277 hashmap_entry_init(&ent->ent, strhash(refname));
278 oidcpy(&ent->oid, oid);
279 hashmap_add(map, &ent->ent);
280 return ent;
283 static int add_one_refname(const char *refname,
284 const struct object_id *oid,
285 int flag UNUSED, void *cbdata)
287 struct hashmap *refname_map = cbdata;
289 (void) refname_hash_add(refname_map, refname, oid);
290 return 0;
293 static void refname_hash_init(struct hashmap *map)
295 hashmap_init(map, refname_hash_entry_cmp, NULL, 0);
298 static int refname_hash_exists(struct hashmap *map, const char *refname)
300 return !!hashmap_get_from_hash(map, strhash(refname), refname);
303 static void clear_item(struct refname_hash_entry *item)
305 item->ignore = 1;
309 static void add_already_queued_tags(const char *refname,
310 const struct object_id *old_oid,
311 const struct object_id *new_oid,
312 void *cb_data)
314 struct hashmap *queued_tags = cb_data;
315 if (starts_with(refname, "refs/tags/") && new_oid)
316 (void) refname_hash_add(queued_tags, refname, new_oid);
319 static void find_non_local_tags(const struct ref *refs,
320 struct ref_transaction *transaction,
321 struct ref **head,
322 struct ref ***tail)
324 struct hashmap existing_refs;
325 struct hashmap remote_refs;
326 struct oidset fetch_oids = OIDSET_INIT;
327 struct string_list remote_refs_list = STRING_LIST_INIT_NODUP;
328 struct string_list_item *remote_ref_item;
329 const struct ref *ref;
330 struct refname_hash_entry *item = NULL;
331 const int quick_flags = OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT;
333 refname_hash_init(&existing_refs);
334 refname_hash_init(&remote_refs);
335 create_fetch_oidset(head, &fetch_oids);
337 for_each_ref(add_one_refname, &existing_refs);
340 * If we already have a transaction, then we need to filter out all
341 * tags which have already been queued up.
343 if (transaction)
344 ref_transaction_for_each_queued_update(transaction,
345 add_already_queued_tags,
346 &existing_refs);
348 for (ref = refs; ref; ref = ref->next) {
349 if (!starts_with(ref->name, "refs/tags/"))
350 continue;
353 * The peeled ref always follows the matching base
354 * ref, so if we see a peeled ref that we don't want
355 * to fetch then we can mark the ref entry in the list
356 * as one to ignore by setting util to NULL.
358 if (ends_with(ref->name, "^{}")) {
359 if (item &&
360 !repo_has_object_file_with_flags(the_repository, &ref->old_oid, quick_flags) &&
361 !oidset_contains(&fetch_oids, &ref->old_oid) &&
362 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
363 !oidset_contains(&fetch_oids, &item->oid))
364 clear_item(item);
365 item = NULL;
366 continue;
370 * If item is non-NULL here, then we previously saw a
371 * ref not followed by a peeled reference, so we need
372 * to check if it is a lightweight tag that we want to
373 * fetch.
375 if (item &&
376 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
377 !oidset_contains(&fetch_oids, &item->oid))
378 clear_item(item);
380 item = NULL;
382 /* skip duplicates and refs that we already have */
383 if (refname_hash_exists(&remote_refs, ref->name) ||
384 refname_hash_exists(&existing_refs, ref->name))
385 continue;
387 item = refname_hash_add(&remote_refs, ref->name, &ref->old_oid);
388 string_list_insert(&remote_refs_list, ref->name);
390 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
393 * We may have a final lightweight tag that needs to be
394 * checked to see if it needs fetching.
396 if (item &&
397 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
398 !oidset_contains(&fetch_oids, &item->oid))
399 clear_item(item);
402 * For all the tags in the remote_refs_list,
403 * add them to the list of refs to be fetched
405 for_each_string_list_item(remote_ref_item, &remote_refs_list) {
406 const char *refname = remote_ref_item->string;
407 struct ref *rm;
408 unsigned int hash = strhash(refname);
410 item = hashmap_get_entry_from_hash(&remote_refs, hash, refname,
411 struct refname_hash_entry, ent);
412 if (!item)
413 BUG("unseen remote ref?");
415 /* Unless we have already decided to ignore this item... */
416 if (item->ignore)
417 continue;
419 rm = alloc_ref(item->refname);
420 rm->peer_ref = alloc_ref(item->refname);
421 oidcpy(&rm->old_oid, &item->oid);
422 **tail = rm;
423 *tail = &rm->next;
425 hashmap_clear_and_free(&remote_refs, struct refname_hash_entry, ent);
426 string_list_clear(&remote_refs_list, 0);
427 oidset_clear(&fetch_oids);
430 static void filter_prefetch_refspec(struct refspec *rs)
432 int i;
434 if (!prefetch)
435 return;
437 for (i = 0; i < rs->nr; i++) {
438 struct strbuf new_dst = STRBUF_INIT;
439 char *old_dst;
440 const char *sub = NULL;
442 if (rs->items[i].negative)
443 continue;
444 if (!rs->items[i].dst ||
445 (rs->items[i].src &&
446 !strncmp(rs->items[i].src,
447 ref_namespace[NAMESPACE_TAGS].ref,
448 strlen(ref_namespace[NAMESPACE_TAGS].ref)))) {
449 int j;
451 free(rs->items[i].src);
452 free(rs->items[i].dst);
454 for (j = i + 1; j < rs->nr; j++) {
455 rs->items[j - 1] = rs->items[j];
456 rs->raw[j - 1] = rs->raw[j];
458 rs->nr--;
459 i--;
460 continue;
463 old_dst = rs->items[i].dst;
464 strbuf_addstr(&new_dst, ref_namespace[NAMESPACE_PREFETCH].ref);
467 * If old_dst starts with "refs/", then place
468 * sub after that prefix. Otherwise, start at
469 * the beginning of the string.
471 if (!skip_prefix(old_dst, "refs/", &sub))
472 sub = old_dst;
473 strbuf_addstr(&new_dst, sub);
475 rs->items[i].dst = strbuf_detach(&new_dst, NULL);
476 rs->items[i].force = 1;
478 free(old_dst);
482 static struct ref *get_ref_map(struct remote *remote,
483 const struct ref *remote_refs,
484 struct refspec *rs,
485 int tags, int *autotags)
487 int i;
488 struct ref *rm;
489 struct ref *ref_map = NULL;
490 struct ref **tail = &ref_map;
492 /* opportunistically-updated references: */
493 struct ref *orefs = NULL, **oref_tail = &orefs;
495 struct hashmap existing_refs;
496 int existing_refs_populated = 0;
498 filter_prefetch_refspec(rs);
499 if (remote)
500 filter_prefetch_refspec(&remote->fetch);
502 if (rs->nr) {
503 struct refspec *fetch_refspec;
505 for (i = 0; i < rs->nr; i++) {
506 get_fetch_map(remote_refs, &rs->items[i], &tail, 0);
507 if (rs->items[i].dst && rs->items[i].dst[0])
508 *autotags = 1;
510 /* Merge everything on the command line (but not --tags) */
511 for (rm = ref_map; rm; rm = rm->next)
512 rm->fetch_head_status = FETCH_HEAD_MERGE;
515 * For any refs that we happen to be fetching via
516 * command-line arguments, the destination ref might
517 * have been missing or have been different than the
518 * remote-tracking ref that would be derived from the
519 * configured refspec. In these cases, we want to
520 * take the opportunity to update their configured
521 * remote-tracking reference. However, we do not want
522 * to mention these entries in FETCH_HEAD at all, as
523 * they would simply be duplicates of existing
524 * entries, so we set them FETCH_HEAD_IGNORE below.
526 * We compute these entries now, based only on the
527 * refspecs specified on the command line. But we add
528 * them to the list following the refspecs resulting
529 * from the tags option so that one of the latter,
530 * which has FETCH_HEAD_NOT_FOR_MERGE, is not removed
531 * by ref_remove_duplicates() in favor of one of these
532 * opportunistic entries with FETCH_HEAD_IGNORE.
534 if (refmap.nr)
535 fetch_refspec = &refmap;
536 else
537 fetch_refspec = &remote->fetch;
539 for (i = 0; i < fetch_refspec->nr; i++)
540 get_fetch_map(ref_map, &fetch_refspec->items[i], &oref_tail, 1);
541 } else if (refmap.nr) {
542 die("--refmap option is only meaningful with command-line refspec(s)");
543 } else {
544 /* Use the defaults */
545 struct branch *branch = branch_get(NULL);
546 int has_merge = branch_has_merge_config(branch);
547 if (remote &&
548 (remote->fetch.nr ||
549 /* Note: has_merge implies non-NULL branch->remote_name */
550 (has_merge && !strcmp(branch->remote_name, remote->name)))) {
551 for (i = 0; i < remote->fetch.nr; i++) {
552 get_fetch_map(remote_refs, &remote->fetch.items[i], &tail, 0);
553 if (remote->fetch.items[i].dst &&
554 remote->fetch.items[i].dst[0])
555 *autotags = 1;
556 if (!i && !has_merge && ref_map &&
557 !remote->fetch.items[0].pattern)
558 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
561 * if the remote we're fetching from is the same
562 * as given in branch.<name>.remote, we add the
563 * ref given in branch.<name>.merge, too.
565 * Note: has_merge implies non-NULL branch->remote_name
567 if (has_merge &&
568 !strcmp(branch->remote_name, remote->name))
569 add_merge_config(&ref_map, remote_refs, branch, &tail);
570 } else if (!prefetch) {
571 ref_map = get_remote_ref(remote_refs, "HEAD");
572 if (!ref_map)
573 die(_("couldn't find remote ref HEAD"));
574 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
575 tail = &ref_map->next;
579 if (tags == TAGS_SET)
580 /* also fetch all tags */
581 get_fetch_map(remote_refs, tag_refspec, &tail, 0);
582 else if (tags == TAGS_DEFAULT && *autotags)
583 find_non_local_tags(remote_refs, NULL, &ref_map, &tail);
585 /* Now append any refs to be updated opportunistically: */
586 *tail = orefs;
587 for (rm = orefs; rm; rm = rm->next) {
588 rm->fetch_head_status = FETCH_HEAD_IGNORE;
589 tail = &rm->next;
593 * apply negative refspecs first, before we remove duplicates. This is
594 * necessary as negative refspecs might remove an otherwise conflicting
595 * duplicate.
597 if (rs->nr)
598 ref_map = apply_negative_refspecs(ref_map, rs);
599 else
600 ref_map = apply_negative_refspecs(ref_map, &remote->fetch);
602 ref_map = ref_remove_duplicates(ref_map);
604 for (rm = ref_map; rm; rm = rm->next) {
605 if (rm->peer_ref) {
606 const char *refname = rm->peer_ref->name;
607 struct refname_hash_entry *peer_item;
608 unsigned int hash = strhash(refname);
610 if (!existing_refs_populated) {
611 refname_hash_init(&existing_refs);
612 for_each_ref(add_one_refname, &existing_refs);
613 existing_refs_populated = 1;
616 peer_item = hashmap_get_entry_from_hash(&existing_refs,
617 hash, refname,
618 struct refname_hash_entry, ent);
619 if (peer_item) {
620 struct object_id *old_oid = &peer_item->oid;
621 oidcpy(&rm->peer_ref->old_oid, old_oid);
625 if (existing_refs_populated)
626 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
628 return ref_map;
631 #define STORE_REF_ERROR_OTHER 1
632 #define STORE_REF_ERROR_DF_CONFLICT 2
634 static int s_update_ref(const char *action,
635 struct ref *ref,
636 struct ref_transaction *transaction,
637 int check_old)
639 char *msg;
640 char *rla = getenv("GIT_REFLOG_ACTION");
641 struct ref_transaction *our_transaction = NULL;
642 struct strbuf err = STRBUF_INIT;
643 int ret;
645 if (dry_run)
646 return 0;
647 if (!rla)
648 rla = default_rla.buf;
649 msg = xstrfmt("%s: %s", rla, action);
652 * If no transaction was passed to us, we manage the transaction
653 * ourselves. Otherwise, we trust the caller to handle the transaction
654 * lifecycle.
656 if (!transaction) {
657 transaction = our_transaction = ref_transaction_begin(&err);
658 if (!transaction) {
659 ret = STORE_REF_ERROR_OTHER;
660 goto out;
664 ret = ref_transaction_update(transaction, ref->name, &ref->new_oid,
665 check_old ? &ref->old_oid : NULL,
666 0, msg, &err);
667 if (ret) {
668 ret = STORE_REF_ERROR_OTHER;
669 goto out;
672 if (our_transaction) {
673 switch (ref_transaction_commit(our_transaction, &err)) {
674 case 0:
675 break;
676 case TRANSACTION_NAME_CONFLICT:
677 ret = STORE_REF_ERROR_DF_CONFLICT;
678 goto out;
679 default:
680 ret = STORE_REF_ERROR_OTHER;
681 goto out;
685 out:
686 ref_transaction_free(our_transaction);
687 if (ret)
688 error("%s", err.buf);
689 strbuf_release(&err);
690 free(msg);
691 return ret;
694 static int refcol_width(const struct ref *ref_map, int compact_format)
696 const struct ref *ref;
697 int max, width = 10;
699 max = term_columns();
700 if (compact_format)
701 max = max * 2 / 3;
703 for (ref = ref_map; ref; ref = ref->next) {
704 int rlen, llen = 0, len;
706 if (ref->status == REF_STATUS_REJECT_SHALLOW ||
707 !ref->peer_ref ||
708 !strcmp(ref->name, "HEAD"))
709 continue;
711 /* uptodate lines are only shown on high verbosity level */
712 if (verbosity <= 0 && oideq(&ref->peer_ref->old_oid, &ref->old_oid))
713 continue;
715 rlen = utf8_strwidth(prettify_refname(ref->name));
716 if (!compact_format)
717 llen = utf8_strwidth(prettify_refname(ref->peer_ref->name));
720 * rough estimation to see if the output line is too long and
721 * should not be counted (we can't do precise calculation
722 * anyway because we don't know if the error explanation part
723 * will be printed in update_local_ref)
725 len = 21 /* flag and summary */ + rlen + 4 /* -> */ + llen;
726 if (len >= max)
727 continue;
729 if (width < rlen)
730 width = rlen;
733 return width;
736 static void display_state_init(struct display_state *display_state, struct ref *ref_map,
737 const char *raw_url, enum display_format format)
739 int i;
741 memset(display_state, 0, sizeof(*display_state));
742 strbuf_init(&display_state->buf, 0);
743 display_state->format = format;
745 if (raw_url)
746 display_state->url = transport_anonymize_url(raw_url);
747 else
748 display_state->url = xstrdup("foreign");
750 display_state->url_len = strlen(display_state->url);
751 for (i = display_state->url_len - 1; display_state->url[i] == '/' && 0 <= i; i--)
753 display_state->url_len = i + 1;
754 if (4 < i && !strncmp(".git", display_state->url + i - 3, 4))
755 display_state->url_len = i - 3;
757 if (verbosity < 0)
758 return;
760 switch (display_state->format) {
761 case DISPLAY_FORMAT_FULL:
762 case DISPLAY_FORMAT_COMPACT:
763 display_state->refcol_width = refcol_width(ref_map,
764 display_state->format == DISPLAY_FORMAT_COMPACT);
765 break;
766 case DISPLAY_FORMAT_PORCELAIN:
767 /* We don't need to precompute anything here. */
768 break;
769 default:
770 BUG("unexpected display format %d", display_state->format);
774 static void display_state_release(struct display_state *display_state)
776 strbuf_release(&display_state->buf);
777 free(display_state->url);
780 static void print_remote_to_local(struct display_state *display_state,
781 const char *remote, const char *local)
783 strbuf_addf(&display_state->buf, "%-*s -> %s",
784 display_state->refcol_width, remote, local);
787 static int find_and_replace(struct strbuf *haystack,
788 const char *needle,
789 const char *placeholder)
791 const char *p = NULL;
792 int plen, nlen;
794 nlen = strlen(needle);
795 if (ends_with(haystack->buf, needle))
796 p = haystack->buf + haystack->len - nlen;
797 else
798 p = strstr(haystack->buf, needle);
799 if (!p)
800 return 0;
802 if (p > haystack->buf && p[-1] != '/')
803 return 0;
805 plen = strlen(p);
806 if (plen > nlen && p[nlen] != '/')
807 return 0;
809 strbuf_splice(haystack, p - haystack->buf, nlen,
810 placeholder, strlen(placeholder));
811 return 1;
814 static void print_compact(struct display_state *display_state,
815 const char *remote, const char *local)
817 struct strbuf r = STRBUF_INIT;
818 struct strbuf l = STRBUF_INIT;
820 if (!strcmp(remote, local)) {
821 strbuf_addf(&display_state->buf, "%-*s -> *", display_state->refcol_width, remote);
822 return;
825 strbuf_addstr(&r, remote);
826 strbuf_addstr(&l, local);
828 if (!find_and_replace(&r, local, "*"))
829 find_and_replace(&l, remote, "*");
830 print_remote_to_local(display_state, r.buf, l.buf);
832 strbuf_release(&r);
833 strbuf_release(&l);
836 static void display_ref_update(struct display_state *display_state, char code,
837 const char *summary, const char *error,
838 const char *remote, const char *local,
839 const struct object_id *old_oid,
840 const struct object_id *new_oid,
841 int summary_width)
843 FILE *f = stderr;
845 if (verbosity < 0)
846 return;
848 strbuf_reset(&display_state->buf);
850 switch (display_state->format) {
851 case DISPLAY_FORMAT_FULL:
852 case DISPLAY_FORMAT_COMPACT: {
853 int width;
855 if (!display_state->shown_url) {
856 strbuf_addf(&display_state->buf, _("From %.*s\n"),
857 display_state->url_len, display_state->url);
858 display_state->shown_url = 1;
861 width = (summary_width + strlen(summary) - gettext_width(summary));
862 remote = prettify_refname(remote);
863 local = prettify_refname(local);
865 strbuf_addf(&display_state->buf, " %c %-*s ", code, width, summary);
867 if (display_state->format != DISPLAY_FORMAT_COMPACT)
868 print_remote_to_local(display_state, remote, local);
869 else
870 print_compact(display_state, remote, local);
872 if (error)
873 strbuf_addf(&display_state->buf, " (%s)", error);
875 break;
877 case DISPLAY_FORMAT_PORCELAIN:
878 strbuf_addf(&display_state->buf, "%c %s %s %s", code,
879 oid_to_hex(old_oid), oid_to_hex(new_oid), local);
880 f = stdout;
881 break;
882 default:
883 BUG("unexpected display format %d", display_state->format);
885 strbuf_addch(&display_state->buf, '\n');
887 fputs(display_state->buf.buf, f);
890 static int update_local_ref(struct ref *ref,
891 struct ref_transaction *transaction,
892 struct display_state *display_state,
893 const struct ref *remote_ref,
894 int summary_width,
895 const struct fetch_config *config)
897 struct commit *current = NULL, *updated;
898 int fast_forward = 0;
900 if (!repo_has_object_file(the_repository, &ref->new_oid))
901 die(_("object %s not found"), oid_to_hex(&ref->new_oid));
903 if (oideq(&ref->old_oid, &ref->new_oid)) {
904 if (verbosity > 0)
905 display_ref_update(display_state, '=', _("[up to date]"), NULL,
906 remote_ref->name, ref->name,
907 &ref->old_oid, &ref->new_oid, summary_width);
908 return 0;
911 if (!update_head_ok &&
912 !is_null_oid(&ref->old_oid) &&
913 branch_checked_out(ref->name)) {
915 * If this is the head, and it's not okay to update
916 * the head, and the old value of the head isn't empty...
918 display_ref_update(display_state, '!', _("[rejected]"),
919 _("can't fetch into checked-out branch"),
920 remote_ref->name, ref->name,
921 &ref->old_oid, &ref->new_oid, summary_width);
922 return 1;
925 if (!is_null_oid(&ref->old_oid) &&
926 starts_with(ref->name, "refs/tags/")) {
927 if (force || ref->force) {
928 int r;
929 r = s_update_ref("updating tag", ref, transaction, 0);
930 display_ref_update(display_state, r ? '!' : 't', _("[tag update]"),
931 r ? _("unable to update local ref") : NULL,
932 remote_ref->name, ref->name,
933 &ref->old_oid, &ref->new_oid, summary_width);
934 return r;
935 } else {
936 display_ref_update(display_state, '!', _("[rejected]"),
937 _("would clobber existing tag"),
938 remote_ref->name, ref->name,
939 &ref->old_oid, &ref->new_oid, summary_width);
940 return 1;
944 current = lookup_commit_reference_gently(the_repository,
945 &ref->old_oid, 1);
946 updated = lookup_commit_reference_gently(the_repository,
947 &ref->new_oid, 1);
948 if (!current || !updated) {
949 const char *msg;
950 const char *what;
951 int r;
953 * Nicely describe the new ref we're fetching.
954 * Base this on the remote's ref name, as it's
955 * more likely to follow a standard layout.
957 if (starts_with(remote_ref->name, "refs/tags/")) {
958 msg = "storing tag";
959 what = _("[new tag]");
960 } else if (starts_with(remote_ref->name, "refs/heads/")) {
961 msg = "storing head";
962 what = _("[new branch]");
963 } else {
964 msg = "storing ref";
965 what = _("[new ref]");
968 r = s_update_ref(msg, ref, transaction, 0);
969 display_ref_update(display_state, r ? '!' : '*', what,
970 r ? _("unable to update local ref") : NULL,
971 remote_ref->name, ref->name,
972 &ref->old_oid, &ref->new_oid, summary_width);
973 return r;
976 if (config->show_forced_updates) {
977 uint64_t t_before = getnanotime();
978 fast_forward = repo_in_merge_bases(the_repository, current,
979 updated);
980 forced_updates_ms += (getnanotime() - t_before) / 1000000;
981 } else {
982 fast_forward = 1;
985 if (fast_forward) {
986 struct strbuf quickref = STRBUF_INIT;
987 int r;
989 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
990 strbuf_addstr(&quickref, "..");
991 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
992 r = s_update_ref("fast-forward", ref, transaction, 1);
993 display_ref_update(display_state, r ? '!' : ' ', quickref.buf,
994 r ? _("unable to update local ref") : NULL,
995 remote_ref->name, ref->name,
996 &ref->old_oid, &ref->new_oid, summary_width);
997 strbuf_release(&quickref);
998 return r;
999 } else if (force || ref->force) {
1000 struct strbuf quickref = STRBUF_INIT;
1001 int r;
1002 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
1003 strbuf_addstr(&quickref, "...");
1004 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
1005 r = s_update_ref("forced-update", ref, transaction, 1);
1006 display_ref_update(display_state, r ? '!' : '+', quickref.buf,
1007 r ? _("unable to update local ref") : _("forced update"),
1008 remote_ref->name, ref->name,
1009 &ref->old_oid, &ref->new_oid, summary_width);
1010 strbuf_release(&quickref);
1011 return r;
1012 } else {
1013 display_ref_update(display_state, '!', _("[rejected]"), _("non-fast-forward"),
1014 remote_ref->name, ref->name,
1015 &ref->old_oid, &ref->new_oid, summary_width);
1016 return 1;
1020 static const struct object_id *iterate_ref_map(void *cb_data)
1022 struct ref **rm = cb_data;
1023 struct ref *ref = *rm;
1025 while (ref && ref->status == REF_STATUS_REJECT_SHALLOW)
1026 ref = ref->next;
1027 if (!ref)
1028 return NULL;
1029 *rm = ref->next;
1030 return &ref->old_oid;
1033 struct fetch_head {
1034 FILE *fp;
1035 struct strbuf buf;
1038 static int open_fetch_head(struct fetch_head *fetch_head)
1040 const char *filename = git_path_fetch_head(the_repository);
1042 if (write_fetch_head) {
1043 fetch_head->fp = fopen(filename, "a");
1044 if (!fetch_head->fp)
1045 return error_errno(_("cannot open '%s'"), filename);
1046 strbuf_init(&fetch_head->buf, 0);
1047 } else {
1048 fetch_head->fp = NULL;
1051 return 0;
1054 static void append_fetch_head(struct fetch_head *fetch_head,
1055 const struct object_id *old_oid,
1056 enum fetch_head_status fetch_head_status,
1057 const char *note,
1058 const char *url, size_t url_len)
1060 char old_oid_hex[GIT_MAX_HEXSZ + 1];
1061 const char *merge_status_marker;
1062 size_t i;
1064 if (!fetch_head->fp)
1065 return;
1067 switch (fetch_head_status) {
1068 case FETCH_HEAD_NOT_FOR_MERGE:
1069 merge_status_marker = "not-for-merge";
1070 break;
1071 case FETCH_HEAD_MERGE:
1072 merge_status_marker = "";
1073 break;
1074 default:
1075 /* do not write anything to FETCH_HEAD */
1076 return;
1079 strbuf_addf(&fetch_head->buf, "%s\t%s\t%s",
1080 oid_to_hex_r(old_oid_hex, old_oid), merge_status_marker, note);
1081 for (i = 0; i < url_len; ++i)
1082 if ('\n' == url[i])
1083 strbuf_addstr(&fetch_head->buf, "\\n");
1084 else
1085 strbuf_addch(&fetch_head->buf, url[i]);
1086 strbuf_addch(&fetch_head->buf, '\n');
1089 * When using an atomic fetch, we do not want to update FETCH_HEAD if
1090 * any of the reference updates fails. We thus have to write all
1091 * updates to a buffer first and only commit it as soon as all
1092 * references have been successfully updated.
1094 if (!atomic_fetch) {
1095 strbuf_write(&fetch_head->buf, fetch_head->fp);
1096 strbuf_reset(&fetch_head->buf);
1100 static void commit_fetch_head(struct fetch_head *fetch_head)
1102 if (!fetch_head->fp || !atomic_fetch)
1103 return;
1104 strbuf_write(&fetch_head->buf, fetch_head->fp);
1107 static void close_fetch_head(struct fetch_head *fetch_head)
1109 if (!fetch_head->fp)
1110 return;
1112 fclose(fetch_head->fp);
1113 strbuf_release(&fetch_head->buf);
1116 static const char warn_show_forced_updates[] =
1117 N_("fetch normally indicates which branches had a forced update,\n"
1118 "but that check has been disabled; to re-enable, use '--show-forced-updates'\n"
1119 "flag or run 'git config fetch.showForcedUpdates true'");
1120 static const char warn_time_show_forced_updates[] =
1121 N_("it took %.2f seconds to check forced updates; you can use\n"
1122 "'--no-show-forced-updates' or run 'git config fetch.showForcedUpdates false'\n"
1123 "to avoid this check\n");
1125 static int store_updated_refs(struct display_state *display_state,
1126 const char *remote_name,
1127 int connectivity_checked,
1128 struct ref_transaction *transaction, struct ref *ref_map,
1129 struct fetch_head *fetch_head,
1130 const struct fetch_config *config)
1132 int rc = 0;
1133 struct strbuf note = STRBUF_INIT;
1134 const char *what, *kind;
1135 struct ref *rm;
1136 int want_status;
1137 int summary_width = 0;
1139 if (verbosity >= 0)
1140 summary_width = transport_summary_width(ref_map);
1142 if (!connectivity_checked) {
1143 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1145 opt.exclude_hidden_refs_section = "fetch";
1146 rm = ref_map;
1147 if (check_connected(iterate_ref_map, &rm, &opt)) {
1148 rc = error(_("%s did not send all necessary objects\n"),
1149 display_state->url);
1150 goto abort;
1155 * We do a pass for each fetch_head_status type in their enum order, so
1156 * merged entries are written before not-for-merge. That lets readers
1157 * use FETCH_HEAD as a refname to refer to the ref to be merged.
1159 for (want_status = FETCH_HEAD_MERGE;
1160 want_status <= FETCH_HEAD_IGNORE;
1161 want_status++) {
1162 for (rm = ref_map; rm; rm = rm->next) {
1163 struct ref *ref = NULL;
1165 if (rm->status == REF_STATUS_REJECT_SHALLOW) {
1166 if (want_status == FETCH_HEAD_MERGE)
1167 warning(_("rejected %s because shallow roots are not allowed to be updated"),
1168 rm->peer_ref ? rm->peer_ref->name : rm->name);
1169 continue;
1173 * When writing FETCH_HEAD we need to determine whether
1174 * we already have the commit or not. If not, then the
1175 * reference is not for merge and needs to be written
1176 * to the reflog after other commits which we already
1177 * have. We're not interested in this property though
1178 * in case FETCH_HEAD is not to be updated, so we can
1179 * skip the classification in that case.
1181 if (fetch_head->fp) {
1182 struct commit *commit = NULL;
1185 * References in "refs/tags/" are often going to point
1186 * to annotated tags, which are not part of the
1187 * commit-graph. We thus only try to look up refs in
1188 * the graph which are not in that namespace to not
1189 * regress performance in repositories with many
1190 * annotated tags.
1192 if (!starts_with(rm->name, "refs/tags/"))
1193 commit = lookup_commit_in_graph(the_repository, &rm->old_oid);
1194 if (!commit) {
1195 commit = lookup_commit_reference_gently(the_repository,
1196 &rm->old_oid,
1198 if (!commit)
1199 rm->fetch_head_status = FETCH_HEAD_NOT_FOR_MERGE;
1203 if (rm->fetch_head_status != want_status)
1204 continue;
1206 if (rm->peer_ref) {
1207 ref = alloc_ref(rm->peer_ref->name);
1208 oidcpy(&ref->old_oid, &rm->peer_ref->old_oid);
1209 oidcpy(&ref->new_oid, &rm->old_oid);
1210 ref->force = rm->peer_ref->force;
1213 if (config->recurse_submodules != RECURSE_SUBMODULES_OFF &&
1214 (!rm->peer_ref || !oideq(&ref->old_oid, &ref->new_oid))) {
1215 check_for_new_submodule_commits(&rm->old_oid);
1218 if (!strcmp(rm->name, "HEAD")) {
1219 kind = "";
1220 what = "";
1221 } else if (skip_prefix(rm->name, "refs/heads/", &what)) {
1222 kind = "branch";
1223 } else if (skip_prefix(rm->name, "refs/tags/", &what)) {
1224 kind = "tag";
1225 } else if (skip_prefix(rm->name, "refs/remotes/", &what)) {
1226 kind = "remote-tracking branch";
1227 } else {
1228 kind = "";
1229 what = rm->name;
1232 strbuf_reset(&note);
1233 if (*what) {
1234 if (*kind)
1235 strbuf_addf(&note, "%s ", kind);
1236 strbuf_addf(&note, "'%s' of ", what);
1239 append_fetch_head(fetch_head, &rm->old_oid,
1240 rm->fetch_head_status,
1241 note.buf, display_state->url,
1242 display_state->url_len);
1244 if (ref) {
1245 rc |= update_local_ref(ref, transaction, display_state,
1246 rm, summary_width, config);
1247 free(ref);
1248 } else if (write_fetch_head || dry_run) {
1250 * Display fetches written to FETCH_HEAD (or
1251 * would be written to FETCH_HEAD, if --dry-run
1252 * is set).
1254 display_ref_update(display_state, '*',
1255 *kind ? kind : "branch", NULL,
1256 rm->name,
1257 "FETCH_HEAD",
1258 &rm->new_oid, &rm->old_oid,
1259 summary_width);
1264 if (rc & STORE_REF_ERROR_DF_CONFLICT)
1265 error(_("some local refs could not be updated; try running\n"
1266 " 'git remote prune %s' to remove any old, conflicting "
1267 "branches"), remote_name);
1269 if (advice_enabled(ADVICE_FETCH_SHOW_FORCED_UPDATES)) {
1270 if (!config->show_forced_updates) {
1271 warning(_(warn_show_forced_updates));
1272 } else if (forced_updates_ms > FORCED_UPDATES_DELAY_WARNING_IN_MS) {
1273 warning(_(warn_time_show_forced_updates),
1274 forced_updates_ms / 1000.0);
1278 abort:
1279 strbuf_release(&note);
1280 return rc;
1284 * We would want to bypass the object transfer altogether if
1285 * everything we are going to fetch already exists and is connected
1286 * locally.
1288 static int check_exist_and_connected(struct ref *ref_map)
1290 struct ref *rm = ref_map;
1291 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1292 struct ref *r;
1295 * If we are deepening a shallow clone we already have these
1296 * objects reachable. Running rev-list here will return with
1297 * a good (0) exit status and we'll bypass the fetch that we
1298 * really need to perform. Claiming failure now will ensure
1299 * we perform the network exchange to deepen our history.
1301 if (deepen)
1302 return -1;
1305 * Similarly, if we need to refetch, we always want to perform a full
1306 * fetch ignoring existing objects.
1308 if (refetch)
1309 return -1;
1313 * check_connected() allows objects to merely be promised, but
1314 * we need all direct targets to exist.
1316 for (r = rm; r; r = r->next) {
1317 if (!repo_has_object_file_with_flags(the_repository, &r->old_oid,
1318 OBJECT_INFO_SKIP_FETCH_OBJECT))
1319 return -1;
1322 opt.quiet = 1;
1323 opt.exclude_hidden_refs_section = "fetch";
1324 return check_connected(iterate_ref_map, &rm, &opt);
1327 static int fetch_and_consume_refs(struct display_state *display_state,
1328 struct transport *transport,
1329 struct ref_transaction *transaction,
1330 struct ref *ref_map,
1331 struct fetch_head *fetch_head,
1332 const struct fetch_config *config)
1334 int connectivity_checked = 1;
1335 int ret;
1338 * We don't need to perform a fetch in case we can already satisfy all
1339 * refs.
1341 ret = check_exist_and_connected(ref_map);
1342 if (ret) {
1343 trace2_region_enter("fetch", "fetch_refs", the_repository);
1344 ret = transport_fetch_refs(transport, ref_map);
1345 trace2_region_leave("fetch", "fetch_refs", the_repository);
1346 if (ret)
1347 goto out;
1348 connectivity_checked = transport->smart_options ?
1349 transport->smart_options->connectivity_checked : 0;
1352 trace2_region_enter("fetch", "consume_refs", the_repository);
1353 ret = store_updated_refs(display_state, transport->remote->name,
1354 connectivity_checked, transaction, ref_map,
1355 fetch_head, config);
1356 trace2_region_leave("fetch", "consume_refs", the_repository);
1358 out:
1359 transport_unlock_pack(transport, 0);
1360 return ret;
1363 static int prune_refs(struct display_state *display_state,
1364 struct refspec *rs,
1365 struct ref_transaction *transaction,
1366 struct ref *ref_map)
1368 int result = 0;
1369 struct ref *ref, *stale_refs = get_stale_heads(rs, ref_map);
1370 struct strbuf err = STRBUF_INIT;
1371 const char *dangling_msg = dry_run
1372 ? _(" (%s will become dangling)")
1373 : _(" (%s has become dangling)");
1375 if (!dry_run) {
1376 if (transaction) {
1377 for (ref = stale_refs; ref; ref = ref->next) {
1378 result = ref_transaction_delete(transaction, ref->name, NULL, 0,
1379 "fetch: prune", &err);
1380 if (result)
1381 goto cleanup;
1383 } else {
1384 struct string_list refnames = STRING_LIST_INIT_NODUP;
1386 for (ref = stale_refs; ref; ref = ref->next)
1387 string_list_append(&refnames, ref->name);
1389 result = delete_refs("fetch: prune", &refnames, 0);
1390 string_list_clear(&refnames, 0);
1394 if (verbosity >= 0) {
1395 int summary_width = transport_summary_width(stale_refs);
1397 for (ref = stale_refs; ref; ref = ref->next) {
1398 display_ref_update(display_state, '-', _("[deleted]"), NULL,
1399 _("(none)"), ref->name,
1400 &ref->new_oid, &ref->old_oid,
1401 summary_width);
1402 warn_dangling_symref(stderr, dangling_msg, ref->name);
1406 cleanup:
1407 strbuf_release(&err);
1408 free_refs(stale_refs);
1409 return result;
1412 static void check_not_current_branch(struct ref *ref_map)
1414 const char *path;
1415 for (; ref_map; ref_map = ref_map->next)
1416 if (ref_map->peer_ref &&
1417 starts_with(ref_map->peer_ref->name, "refs/heads/") &&
1418 (path = branch_checked_out(ref_map->peer_ref->name)))
1419 die(_("refusing to fetch into branch '%s' "
1420 "checked out at '%s'"),
1421 ref_map->peer_ref->name, path);
1424 static int truncate_fetch_head(void)
1426 const char *filename = git_path_fetch_head(the_repository);
1427 FILE *fp = fopen_for_writing(filename);
1429 if (!fp)
1430 return error_errno(_("cannot open '%s'"), filename);
1431 fclose(fp);
1432 return 0;
1435 static void set_option(struct transport *transport, const char *name, const char *value)
1437 int r = transport_set_option(transport, name, value);
1438 if (r < 0)
1439 die(_("option \"%s\" value \"%s\" is not valid for %s"),
1440 name, value, transport->url);
1441 if (r > 0)
1442 warning(_("option \"%s\" is ignored for %s\n"),
1443 name, transport->url);
1447 static int add_oid(const char *refname UNUSED,
1448 const struct object_id *oid,
1449 int flags UNUSED, void *cb_data)
1451 struct oid_array *oids = cb_data;
1453 oid_array_append(oids, oid);
1454 return 0;
1457 static void add_negotiation_tips(struct git_transport_options *smart_options)
1459 struct oid_array *oids = xcalloc(1, sizeof(*oids));
1460 int i;
1462 for (i = 0; i < negotiation_tip.nr; i++) {
1463 const char *s = negotiation_tip.items[i].string;
1464 int old_nr;
1465 if (!has_glob_specials(s)) {
1466 struct object_id oid;
1467 if (repo_get_oid(the_repository, s, &oid))
1468 die(_("%s is not a valid object"), s);
1469 if (!has_object(the_repository, &oid, 0))
1470 die(_("the object %s does not exist"), s);
1471 oid_array_append(oids, &oid);
1472 continue;
1474 old_nr = oids->nr;
1475 for_each_glob_ref(add_oid, s, oids);
1476 if (old_nr == oids->nr)
1477 warning("ignoring --negotiation-tip=%s because it does not match any refs",
1480 smart_options->negotiation_tips = oids;
1483 static struct transport *prepare_transport(struct remote *remote, int deepen)
1485 struct transport *transport;
1487 transport = transport_get(remote, NULL);
1488 transport_set_verbosity(transport, verbosity, progress);
1489 transport->family = family;
1490 if (upload_pack)
1491 set_option(transport, TRANS_OPT_UPLOADPACK, upload_pack);
1492 if (keep)
1493 set_option(transport, TRANS_OPT_KEEP, "yes");
1494 if (depth)
1495 set_option(transport, TRANS_OPT_DEPTH, depth);
1496 if (deepen && deepen_since)
1497 set_option(transport, TRANS_OPT_DEEPEN_SINCE, deepen_since);
1498 if (deepen && deepen_not.nr)
1499 set_option(transport, TRANS_OPT_DEEPEN_NOT,
1500 (const char *)&deepen_not);
1501 if (deepen_relative)
1502 set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, "yes");
1503 if (update_shallow)
1504 set_option(transport, TRANS_OPT_UPDATE_SHALLOW, "yes");
1505 if (refetch)
1506 set_option(transport, TRANS_OPT_REFETCH, "yes");
1507 if (filter_options.choice) {
1508 const char *spec =
1509 expand_list_objects_filter_spec(&filter_options);
1510 set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER, spec);
1511 set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1513 if (negotiation_tip.nr) {
1514 if (transport->smart_options)
1515 add_negotiation_tips(transport->smart_options);
1516 else
1517 warning("ignoring --negotiation-tip because the protocol does not support it");
1519 return transport;
1522 static int backfill_tags(struct display_state *display_state,
1523 struct transport *transport,
1524 struct ref_transaction *transaction,
1525 struct ref *ref_map,
1526 struct fetch_head *fetch_head,
1527 const struct fetch_config *config)
1529 int retcode, cannot_reuse;
1532 * Once we have set TRANS_OPT_DEEPEN_SINCE, we can't unset it
1533 * when remote helper is used (setting it to an empty string
1534 * is not unsetting). We could extend the remote helper
1535 * protocol for that, but for now, just force a new connection
1536 * without deepen-since. Similar story for deepen-not.
1538 cannot_reuse = transport->cannot_reuse ||
1539 deepen_since || deepen_not.nr;
1540 if (cannot_reuse) {
1541 gsecondary = prepare_transport(transport->remote, 0);
1542 transport = gsecondary;
1545 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
1546 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
1547 transport_set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, NULL);
1548 retcode = fetch_and_consume_refs(display_state, transport, transaction, ref_map,
1549 fetch_head, config);
1551 if (gsecondary) {
1552 transport_disconnect(gsecondary);
1553 gsecondary = NULL;
1556 return retcode;
1559 static int do_fetch(struct transport *transport,
1560 struct refspec *rs,
1561 const struct fetch_config *config)
1563 struct ref_transaction *transaction = NULL;
1564 struct ref *ref_map = NULL;
1565 struct display_state display_state = { 0 };
1566 int autotags = (transport->remote->fetch_tags == 1);
1567 int retcode = 0;
1568 const struct ref *remote_refs;
1569 struct transport_ls_refs_options transport_ls_refs_options =
1570 TRANSPORT_LS_REFS_OPTIONS_INIT;
1571 int must_list_refs = 1;
1572 struct fetch_head fetch_head = { 0 };
1573 struct strbuf err = STRBUF_INIT;
1575 if (tags == TAGS_DEFAULT) {
1576 if (transport->remote->fetch_tags == 2)
1577 tags = TAGS_SET;
1578 if (transport->remote->fetch_tags == -1)
1579 tags = TAGS_UNSET;
1582 /* if not appending, truncate FETCH_HEAD */
1583 if (!append && write_fetch_head) {
1584 retcode = truncate_fetch_head();
1585 if (retcode)
1586 goto cleanup;
1589 if (rs->nr) {
1590 int i;
1592 refspec_ref_prefixes(rs, &transport_ls_refs_options.ref_prefixes);
1595 * We can avoid listing refs if all of them are exact
1596 * OIDs
1598 must_list_refs = 0;
1599 for (i = 0; i < rs->nr; i++) {
1600 if (!rs->items[i].exact_sha1) {
1601 must_list_refs = 1;
1602 break;
1605 } else {
1606 struct branch *branch = branch_get(NULL);
1608 if (transport->remote->fetch.nr)
1609 refspec_ref_prefixes(&transport->remote->fetch,
1610 &transport_ls_refs_options.ref_prefixes);
1611 if (branch_has_merge_config(branch) &&
1612 !strcmp(branch->remote_name, transport->remote->name)) {
1613 int i;
1614 for (i = 0; i < branch->merge_nr; i++) {
1615 strvec_push(&transport_ls_refs_options.ref_prefixes,
1616 branch->merge[i]->src);
1621 if (tags == TAGS_SET || tags == TAGS_DEFAULT) {
1622 must_list_refs = 1;
1623 if (transport_ls_refs_options.ref_prefixes.nr)
1624 strvec_push(&transport_ls_refs_options.ref_prefixes,
1625 "refs/tags/");
1628 if (must_list_refs) {
1629 trace2_region_enter("fetch", "remote_refs", the_repository);
1630 remote_refs = transport_get_remote_refs(transport,
1631 &transport_ls_refs_options);
1632 trace2_region_leave("fetch", "remote_refs", the_repository);
1633 } else
1634 remote_refs = NULL;
1636 transport_ls_refs_options_release(&transport_ls_refs_options);
1638 ref_map = get_ref_map(transport->remote, remote_refs, rs,
1639 tags, &autotags);
1640 if (!update_head_ok)
1641 check_not_current_branch(ref_map);
1643 retcode = open_fetch_head(&fetch_head);
1644 if (retcode)
1645 goto cleanup;
1647 display_state_init(&display_state, ref_map, transport->url,
1648 config->display_format);
1650 if (atomic_fetch) {
1651 transaction = ref_transaction_begin(&err);
1652 if (!transaction) {
1653 retcode = error("%s", err.buf);
1654 goto cleanup;
1658 if (tags == TAGS_DEFAULT && autotags)
1659 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1660 if (prune) {
1662 * We only prune based on refspecs specified
1663 * explicitly (via command line or configuration); we
1664 * don't care whether --tags was specified.
1666 if (rs->nr) {
1667 retcode = prune_refs(&display_state, rs, transaction, ref_map);
1668 } else {
1669 retcode = prune_refs(&display_state, &transport->remote->fetch,
1670 transaction, ref_map);
1672 if (retcode != 0)
1673 retcode = 1;
1676 if (fetch_and_consume_refs(&display_state, transport, transaction, ref_map,
1677 &fetch_head, config)) {
1678 retcode = 1;
1679 goto cleanup;
1683 * If neither --no-tags nor --tags was specified, do automated tag
1684 * following.
1686 if (tags == TAGS_DEFAULT && autotags) {
1687 struct ref *tags_ref_map = NULL, **tail = &tags_ref_map;
1689 find_non_local_tags(remote_refs, transaction, &tags_ref_map, &tail);
1690 if (tags_ref_map) {
1692 * If backfilling of tags fails then we want to tell
1693 * the user so, but we have to continue regardless to
1694 * populate upstream information of the references we
1695 * have already fetched above. The exception though is
1696 * when `--atomic` is passed: in that case we'll abort
1697 * the transaction and don't commit anything.
1699 if (backfill_tags(&display_state, transport, transaction, tags_ref_map,
1700 &fetch_head, config))
1701 retcode = 1;
1704 free_refs(tags_ref_map);
1707 if (transaction) {
1708 if (retcode)
1709 goto cleanup;
1711 retcode = ref_transaction_commit(transaction, &err);
1712 if (retcode) {
1713 error("%s", err.buf);
1714 ref_transaction_free(transaction);
1715 transaction = NULL;
1716 goto cleanup;
1720 commit_fetch_head(&fetch_head);
1722 if (set_upstream) {
1723 struct branch *branch = branch_get("HEAD");
1724 struct ref *rm;
1725 struct ref *source_ref = NULL;
1728 * We're setting the upstream configuration for the
1729 * current branch. The relevant upstream is the
1730 * fetched branch that is meant to be merged with the
1731 * current one, i.e. the one fetched to FETCH_HEAD.
1733 * When there are several such branches, consider the
1734 * request ambiguous and err on the safe side by doing
1735 * nothing and just emit a warning.
1737 for (rm = ref_map; rm; rm = rm->next) {
1738 if (!rm->peer_ref) {
1739 if (source_ref) {
1740 warning(_("multiple branches detected, incompatible with --set-upstream"));
1741 goto cleanup;
1742 } else {
1743 source_ref = rm;
1747 if (source_ref) {
1748 if (!branch) {
1749 const char *shortname = source_ref->name;
1750 skip_prefix(shortname, "refs/heads/", &shortname);
1752 warning(_("could not set upstream of HEAD to '%s' from '%s' when "
1753 "it does not point to any branch."),
1754 shortname, transport->remote->name);
1755 goto cleanup;
1758 if (!strcmp(source_ref->name, "HEAD") ||
1759 starts_with(source_ref->name, "refs/heads/"))
1760 install_branch_config(0,
1761 branch->name,
1762 transport->remote->name,
1763 source_ref->name);
1764 else if (starts_with(source_ref->name, "refs/remotes/"))
1765 warning(_("not setting upstream for a remote remote-tracking branch"));
1766 else if (starts_with(source_ref->name, "refs/tags/"))
1767 warning(_("not setting upstream for a remote tag"));
1768 else
1769 warning(_("unknown branch type"));
1770 } else {
1771 warning(_("no source branch found;\n"
1772 "you need to specify exactly one branch with the --set-upstream option"));
1776 cleanup:
1777 if (retcode && transaction) {
1778 ref_transaction_abort(transaction, &err);
1779 error("%s", err.buf);
1782 display_state_release(&display_state);
1783 close_fetch_head(&fetch_head);
1784 strbuf_release(&err);
1785 free_refs(ref_map);
1786 return retcode;
1789 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
1791 struct string_list *list = priv;
1792 if (!remote->skip_default_update)
1793 string_list_append(list, remote->name);
1794 return 0;
1797 struct remote_group_data {
1798 const char *name;
1799 struct string_list *list;
1802 static int get_remote_group(const char *key, const char *value, void *priv)
1804 struct remote_group_data *g = priv;
1806 if (skip_prefix(key, "remotes.", &key) && !strcmp(key, g->name)) {
1807 /* split list by white space */
1808 while (*value) {
1809 size_t wordlen = strcspn(value, " \t\n");
1811 if (wordlen >= 1)
1812 string_list_append_nodup(g->list,
1813 xstrndup(value, wordlen));
1814 value += wordlen + (value[wordlen] != '\0');
1818 return 0;
1821 static int add_remote_or_group(const char *name, struct string_list *list)
1823 int prev_nr = list->nr;
1824 struct remote_group_data g;
1825 g.name = name; g.list = list;
1827 git_config(get_remote_group, &g);
1828 if (list->nr == prev_nr) {
1829 struct remote *remote = remote_get(name);
1830 if (!remote_is_configured(remote, 0))
1831 return 0;
1832 string_list_append(list, remote->name);
1834 return 1;
1837 static void add_options_to_argv(struct strvec *argv,
1838 const struct fetch_config *config)
1840 if (dry_run)
1841 strvec_push(argv, "--dry-run");
1842 if (prune != -1)
1843 strvec_push(argv, prune ? "--prune" : "--no-prune");
1844 if (prune_tags != -1)
1845 strvec_push(argv, prune_tags ? "--prune-tags" : "--no-prune-tags");
1846 if (update_head_ok)
1847 strvec_push(argv, "--update-head-ok");
1848 if (force)
1849 strvec_push(argv, "--force");
1850 if (keep)
1851 strvec_push(argv, "--keep");
1852 if (config->recurse_submodules == RECURSE_SUBMODULES_ON)
1853 strvec_push(argv, "--recurse-submodules");
1854 else if (config->recurse_submodules == RECURSE_SUBMODULES_OFF)
1855 strvec_push(argv, "--no-recurse-submodules");
1856 else if (config->recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND)
1857 strvec_push(argv, "--recurse-submodules=on-demand");
1858 if (tags == TAGS_SET)
1859 strvec_push(argv, "--tags");
1860 else if (tags == TAGS_UNSET)
1861 strvec_push(argv, "--no-tags");
1862 if (verbosity >= 2)
1863 strvec_push(argv, "-v");
1864 if (verbosity >= 1)
1865 strvec_push(argv, "-v");
1866 else if (verbosity < 0)
1867 strvec_push(argv, "-q");
1868 if (family == TRANSPORT_FAMILY_IPV4)
1869 strvec_push(argv, "--ipv4");
1870 else if (family == TRANSPORT_FAMILY_IPV6)
1871 strvec_push(argv, "--ipv6");
1872 if (!write_fetch_head)
1873 strvec_push(argv, "--no-write-fetch-head");
1874 if (config->display_format == DISPLAY_FORMAT_PORCELAIN)
1875 strvec_pushf(argv, "--porcelain");
1878 /* Fetch multiple remotes in parallel */
1880 struct parallel_fetch_state {
1881 const char **argv;
1882 struct string_list *remotes;
1883 int next, result;
1884 const struct fetch_config *config;
1887 static int fetch_next_remote(struct child_process *cp,
1888 struct strbuf *out UNUSED,
1889 void *cb, void **task_cb)
1891 struct parallel_fetch_state *state = cb;
1892 char *remote;
1894 if (state->next < 0 || state->next >= state->remotes->nr)
1895 return 0;
1897 remote = state->remotes->items[state->next++].string;
1898 *task_cb = remote;
1900 strvec_pushv(&cp->args, state->argv);
1901 strvec_push(&cp->args, remote);
1902 cp->git_cmd = 1;
1904 if (verbosity >= 0 && state->config->display_format != DISPLAY_FORMAT_PORCELAIN)
1905 printf(_("Fetching %s\n"), remote);
1907 return 1;
1910 static int fetch_failed_to_start(struct strbuf *out UNUSED,
1911 void *cb, void *task_cb)
1913 struct parallel_fetch_state *state = cb;
1914 const char *remote = task_cb;
1916 state->result = error(_("could not fetch %s"), remote);
1918 return 0;
1921 static int fetch_finished(int result, struct strbuf *out,
1922 void *cb, void *task_cb)
1924 struct parallel_fetch_state *state = cb;
1925 const char *remote = task_cb;
1927 if (result) {
1928 strbuf_addf(out, _("could not fetch '%s' (exit code: %d)\n"),
1929 remote, result);
1930 state->result = -1;
1933 return 0;
1936 static int fetch_multiple(struct string_list *list, int max_children,
1937 const struct fetch_config *config)
1939 int i, result = 0;
1940 struct strvec argv = STRVEC_INIT;
1942 if (!append && write_fetch_head) {
1943 int errcode = truncate_fetch_head();
1944 if (errcode)
1945 return errcode;
1949 * Cancel out the fetch.bundleURI config when running subprocesses,
1950 * to avoid fetching from the same bundle list multiple times.
1952 strvec_pushl(&argv, "-c", "fetch.bundleURI=",
1953 "fetch", "--append", "--no-auto-gc",
1954 "--no-write-commit-graph", NULL);
1955 add_options_to_argv(&argv, config);
1957 if (max_children != 1 && list->nr != 1) {
1958 struct parallel_fetch_state state = { argv.v, list, 0, 0, config };
1959 const struct run_process_parallel_opts opts = {
1960 .tr2_category = "fetch",
1961 .tr2_label = "parallel/fetch",
1963 .processes = max_children,
1965 .get_next_task = &fetch_next_remote,
1966 .start_failure = &fetch_failed_to_start,
1967 .task_finished = &fetch_finished,
1968 .data = &state,
1971 strvec_push(&argv, "--end-of-options");
1973 run_processes_parallel(&opts);
1974 result = state.result;
1975 } else
1976 for (i = 0; i < list->nr; i++) {
1977 const char *name = list->items[i].string;
1978 struct child_process cmd = CHILD_PROCESS_INIT;
1980 strvec_pushv(&cmd.args, argv.v);
1981 strvec_push(&cmd.args, name);
1982 if (verbosity >= 0 && config->display_format != DISPLAY_FORMAT_PORCELAIN)
1983 printf(_("Fetching %s\n"), name);
1984 cmd.git_cmd = 1;
1985 if (run_command(&cmd)) {
1986 error(_("could not fetch %s"), name);
1987 result = 1;
1991 strvec_clear(&argv);
1992 return !!result;
1996 * Fetching from the promisor remote should use the given filter-spec
1997 * or inherit the default filter-spec from the config.
1999 static inline void fetch_one_setup_partial(struct remote *remote)
2002 * Explicit --no-filter argument overrides everything, regardless
2003 * of any prior partial clones and fetches.
2005 if (filter_options.no_filter)
2006 return;
2009 * If no prior partial clone/fetch and the current fetch DID NOT
2010 * request a partial-fetch, do a normal fetch.
2012 if (!repo_has_promisor_remote(the_repository) && !filter_options.choice)
2013 return;
2016 * If this is a partial-fetch request, we enable partial on
2017 * this repo if not already enabled and remember the given
2018 * filter-spec as the default for subsequent fetches to this
2019 * remote if there is currently no default filter-spec.
2021 if (filter_options.choice) {
2022 partial_clone_register(remote->name, &filter_options);
2023 return;
2027 * Do a partial-fetch from the promisor remote using either the
2028 * explicitly given filter-spec or inherit the filter-spec from
2029 * the config.
2031 if (!filter_options.choice)
2032 partial_clone_get_default_filter_spec(&filter_options, remote->name);
2033 return;
2036 static int fetch_one(struct remote *remote, int argc, const char **argv,
2037 int prune_tags_ok, int use_stdin_refspecs,
2038 const struct fetch_config *config)
2040 struct refspec rs = REFSPEC_INIT_FETCH;
2041 int i;
2042 int exit_code;
2043 int maybe_prune_tags;
2044 int remote_via_config = remote_is_configured(remote, 0);
2046 if (!remote)
2047 die(_("no remote repository specified; please specify either a URL or a\n"
2048 "remote name from which new revisions should be fetched"));
2050 gtransport = prepare_transport(remote, 1);
2052 if (prune < 0) {
2053 /* no command line request */
2054 if (0 <= remote->prune)
2055 prune = remote->prune;
2056 else if (0 <= config->prune)
2057 prune = config->prune;
2058 else
2059 prune = PRUNE_BY_DEFAULT;
2062 if (prune_tags < 0) {
2063 /* no command line request */
2064 if (0 <= remote->prune_tags)
2065 prune_tags = remote->prune_tags;
2066 else if (0 <= config->prune_tags)
2067 prune_tags = config->prune_tags;
2068 else
2069 prune_tags = PRUNE_TAGS_BY_DEFAULT;
2072 maybe_prune_tags = prune_tags_ok && prune_tags;
2073 if (maybe_prune_tags && remote_via_config)
2074 refspec_append(&remote->fetch, TAG_REFSPEC);
2076 if (maybe_prune_tags && (argc || !remote_via_config))
2077 refspec_append(&rs, TAG_REFSPEC);
2079 for (i = 0; i < argc; i++) {
2080 if (!strcmp(argv[i], "tag")) {
2081 i++;
2082 if (i >= argc)
2083 die(_("you need to specify a tag name"));
2085 refspec_appendf(&rs, "refs/tags/%s:refs/tags/%s",
2086 argv[i], argv[i]);
2087 } else {
2088 refspec_append(&rs, argv[i]);
2092 if (use_stdin_refspecs) {
2093 struct strbuf line = STRBUF_INIT;
2094 while (strbuf_getline_lf(&line, stdin) != EOF)
2095 refspec_append(&rs, line.buf);
2096 strbuf_release(&line);
2099 if (server_options.nr)
2100 gtransport->server_options = &server_options;
2102 sigchain_push_common(unlock_pack_on_signal);
2103 atexit(unlock_pack_atexit);
2104 sigchain_push(SIGPIPE, SIG_IGN);
2105 exit_code = do_fetch(gtransport, &rs, config);
2106 sigchain_pop(SIGPIPE);
2107 refspec_clear(&rs);
2108 transport_disconnect(gtransport);
2109 gtransport = NULL;
2110 return exit_code;
2113 int cmd_fetch(int argc, const char **argv, const char *prefix)
2115 struct fetch_config config = {
2116 .display_format = DISPLAY_FORMAT_FULL,
2117 .prune = -1,
2118 .prune_tags = -1,
2119 .show_forced_updates = 1,
2120 .recurse_submodules = RECURSE_SUBMODULES_DEFAULT,
2121 .parallel = 1,
2122 .submodule_fetch_jobs = -1,
2124 const char *submodule_prefix = "";
2125 const char *bundle_uri;
2126 struct string_list list = STRING_LIST_INIT_DUP;
2127 struct remote *remote = NULL;
2128 int all = 0, multiple = 0;
2129 int result = 0;
2130 int prune_tags_ok = 1;
2131 int enable_auto_gc = 1;
2132 int unshallow = 0;
2133 int max_jobs = -1;
2134 int recurse_submodules_cli = RECURSE_SUBMODULES_DEFAULT;
2135 int recurse_submodules_default = RECURSE_SUBMODULES_ON_DEMAND;
2136 int fetch_write_commit_graph = -1;
2137 int stdin_refspecs = 0;
2138 int negotiate_only = 0;
2139 int porcelain = 0;
2140 int i;
2142 struct option builtin_fetch_options[] = {
2143 OPT__VERBOSITY(&verbosity),
2144 OPT_BOOL(0, "all", &all,
2145 N_("fetch from all remotes")),
2146 OPT_BOOL(0, "set-upstream", &set_upstream,
2147 N_("set upstream for git pull/fetch")),
2148 OPT_BOOL('a', "append", &append,
2149 N_("append to .git/FETCH_HEAD instead of overwriting")),
2150 OPT_BOOL(0, "atomic", &atomic_fetch,
2151 N_("use atomic transaction to update references")),
2152 OPT_STRING(0, "upload-pack", &upload_pack, N_("path"),
2153 N_("path to upload pack on remote end")),
2154 OPT__FORCE(&force, N_("force overwrite of local reference"), 0),
2155 OPT_BOOL('m', "multiple", &multiple,
2156 N_("fetch from multiple remotes")),
2157 OPT_SET_INT('t', "tags", &tags,
2158 N_("fetch all tags and associated objects"), TAGS_SET),
2159 OPT_SET_INT('n', NULL, &tags,
2160 N_("do not fetch all tags (--no-tags)"), TAGS_UNSET),
2161 OPT_INTEGER('j', "jobs", &max_jobs,
2162 N_("number of submodules fetched in parallel")),
2163 OPT_BOOL(0, "prefetch", &prefetch,
2164 N_("modify the refspec to place all refs within refs/prefetch/")),
2165 OPT_BOOL('p', "prune", &prune,
2166 N_("prune remote-tracking branches no longer on remote")),
2167 OPT_BOOL('P', "prune-tags", &prune_tags,
2168 N_("prune local tags no longer on remote and clobber changed tags")),
2169 OPT_CALLBACK_F(0, "recurse-submodules", &recurse_submodules_cli, N_("on-demand"),
2170 N_("control recursive fetching of submodules"),
2171 PARSE_OPT_OPTARG, option_fetch_parse_recurse_submodules),
2172 OPT_BOOL(0, "dry-run", &dry_run,
2173 N_("dry run")),
2174 OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
2175 OPT_BOOL(0, "write-fetch-head", &write_fetch_head,
2176 N_("write fetched references to the FETCH_HEAD file")),
2177 OPT_BOOL('k', "keep", &keep, N_("keep downloaded pack")),
2178 OPT_BOOL('u', "update-head-ok", &update_head_ok,
2179 N_("allow updating of HEAD ref")),
2180 OPT_BOOL(0, "progress", &progress, N_("force progress reporting")),
2181 OPT_STRING(0, "depth", &depth, N_("depth"),
2182 N_("deepen history of shallow clone")),
2183 OPT_STRING(0, "shallow-since", &deepen_since, N_("time"),
2184 N_("deepen history of shallow repository based on time")),
2185 OPT_STRING_LIST(0, "shallow-exclude", &deepen_not, N_("revision"),
2186 N_("deepen history of shallow clone, excluding rev")),
2187 OPT_INTEGER(0, "deepen", &deepen_relative,
2188 N_("deepen history of shallow clone")),
2189 OPT_SET_INT_F(0, "unshallow", &unshallow,
2190 N_("convert to a complete repository"),
2191 1, PARSE_OPT_NONEG),
2192 OPT_SET_INT_F(0, "refetch", &refetch,
2193 N_("re-fetch without negotiating common commits"),
2194 1, PARSE_OPT_NONEG),
2195 { OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, N_("dir"),
2196 N_("prepend this to submodule path output"), PARSE_OPT_HIDDEN },
2197 OPT_CALLBACK_F(0, "recurse-submodules-default",
2198 &recurse_submodules_default, N_("on-demand"),
2199 N_("default for recursive fetching of submodules "
2200 "(lower priority than config files)"),
2201 PARSE_OPT_HIDDEN, option_fetch_parse_recurse_submodules),
2202 OPT_BOOL(0, "update-shallow", &update_shallow,
2203 N_("accept refs that update .git/shallow")),
2204 OPT_CALLBACK_F(0, "refmap", NULL, N_("refmap"),
2205 N_("specify fetch refmap"), PARSE_OPT_NONEG, parse_refmap_arg),
2206 OPT_STRING_LIST('o', "server-option", &server_options, N_("server-specific"), N_("option to transmit")),
2207 OPT_SET_INT('4', "ipv4", &family, N_("use IPv4 addresses only"),
2208 TRANSPORT_FAMILY_IPV4),
2209 OPT_SET_INT('6', "ipv6", &family, N_("use IPv6 addresses only"),
2210 TRANSPORT_FAMILY_IPV6),
2211 OPT_STRING_LIST(0, "negotiation-tip", &negotiation_tip, N_("revision"),
2212 N_("report that we have only objects reachable from this object")),
2213 OPT_BOOL(0, "negotiate-only", &negotiate_only,
2214 N_("do not fetch a packfile; instead, print ancestors of negotiation tips")),
2215 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
2216 OPT_BOOL(0, "auto-maintenance", &enable_auto_gc,
2217 N_("run 'maintenance --auto' after fetching")),
2218 OPT_BOOL(0, "auto-gc", &enable_auto_gc,
2219 N_("run 'maintenance --auto' after fetching")),
2220 OPT_BOOL(0, "show-forced-updates", &config.show_forced_updates,
2221 N_("check for forced-updates on all updated branches")),
2222 OPT_BOOL(0, "write-commit-graph", &fetch_write_commit_graph,
2223 N_("write the commit-graph after fetching")),
2224 OPT_BOOL(0, "stdin", &stdin_refspecs,
2225 N_("accept refspecs from stdin")),
2226 OPT_END()
2229 packet_trace_identity("fetch");
2231 /* Record the command line for the reflog */
2232 strbuf_addstr(&default_rla, "fetch");
2233 for (i = 1; i < argc; i++) {
2234 /* This handles non-URLs gracefully */
2235 char *anon = transport_anonymize_url(argv[i]);
2237 strbuf_addf(&default_rla, " %s", anon);
2238 free(anon);
2241 git_config(git_fetch_config, &config);
2242 if (the_repository->gitdir) {
2243 prepare_repo_settings(the_repository);
2244 the_repository->settings.command_requires_full_index = 0;
2247 argc = parse_options(argc, argv, prefix,
2248 builtin_fetch_options, builtin_fetch_usage, 0);
2250 if (recurse_submodules_cli != RECURSE_SUBMODULES_DEFAULT)
2251 config.recurse_submodules = recurse_submodules_cli;
2253 if (negotiate_only) {
2254 switch (recurse_submodules_cli) {
2255 case RECURSE_SUBMODULES_OFF:
2256 case RECURSE_SUBMODULES_DEFAULT:
2258 * --negotiate-only should never recurse into
2259 * submodules. Skip it by setting recurse_submodules to
2260 * RECURSE_SUBMODULES_OFF.
2262 config.recurse_submodules = RECURSE_SUBMODULES_OFF;
2263 break;
2265 default:
2266 die(_("options '%s' and '%s' cannot be used together"),
2267 "--negotiate-only", "--recurse-submodules");
2271 if (config.recurse_submodules != RECURSE_SUBMODULES_OFF) {
2272 int *sfjc = config.submodule_fetch_jobs == -1
2273 ? &config.submodule_fetch_jobs : NULL;
2274 int *rs = config.recurse_submodules == RECURSE_SUBMODULES_DEFAULT
2275 ? &config.recurse_submodules : NULL;
2277 fetch_config_from_gitmodules(sfjc, rs);
2281 if (porcelain) {
2282 switch (recurse_submodules_cli) {
2283 case RECURSE_SUBMODULES_OFF:
2284 case RECURSE_SUBMODULES_DEFAULT:
2286 * Reference updates in submodules would be ambiguous
2287 * in porcelain mode, so we reject this combination.
2289 config.recurse_submodules = RECURSE_SUBMODULES_OFF;
2290 break;
2292 default:
2293 die(_("options '%s' and '%s' cannot be used together"),
2294 "--porcelain", "--recurse-submodules");
2297 config.display_format = DISPLAY_FORMAT_PORCELAIN;
2300 if (negotiate_only && !negotiation_tip.nr)
2301 die(_("--negotiate-only needs one or more --negotiation-tip=*"));
2303 if (deepen_relative) {
2304 if (deepen_relative < 0)
2305 die(_("negative depth in --deepen is not supported"));
2306 if (depth)
2307 die(_("options '%s' and '%s' cannot be used together"), "--deepen", "--depth");
2308 depth = xstrfmt("%d", deepen_relative);
2310 if (unshallow) {
2311 if (depth)
2312 die(_("options '%s' and '%s' cannot be used together"), "--depth", "--unshallow");
2313 else if (!is_repository_shallow(the_repository))
2314 die(_("--unshallow on a complete repository does not make sense"));
2315 else
2316 depth = xstrfmt("%d", INFINITE_DEPTH);
2319 /* no need to be strict, transport_set_option() will validate it again */
2320 if (depth && atoi(depth) < 1)
2321 die(_("depth %s is not a positive number"), depth);
2322 if (depth || deepen_since || deepen_not.nr)
2323 deepen = 1;
2325 /* FETCH_HEAD never gets updated in --dry-run mode */
2326 if (dry_run)
2327 write_fetch_head = 0;
2329 if (!max_jobs)
2330 max_jobs = online_cpus();
2332 if (!git_config_get_string_tmp("fetch.bundleuri", &bundle_uri) &&
2333 fetch_bundle_uri(the_repository, bundle_uri, NULL))
2334 warning(_("failed to fetch bundles from '%s'"), bundle_uri);
2336 if (all) {
2337 if (argc == 1)
2338 die(_("fetch --all does not take a repository argument"));
2339 else if (argc > 1)
2340 die(_("fetch --all does not make sense with refspecs"));
2341 (void) for_each_remote(get_one_remote_for_fetch, &list);
2343 /* do not do fetch_multiple() of one */
2344 if (list.nr == 1)
2345 remote = remote_get(list.items[0].string);
2346 } else if (argc == 0) {
2347 /* No arguments -- use default remote */
2348 remote = remote_get(NULL);
2349 } else if (multiple) {
2350 /* All arguments are assumed to be remotes or groups */
2351 for (i = 0; i < argc; i++)
2352 if (!add_remote_or_group(argv[i], &list))
2353 die(_("no such remote or remote group: %s"),
2354 argv[i]);
2355 } else {
2356 /* Single remote or group */
2357 (void) add_remote_or_group(argv[0], &list);
2358 if (list.nr > 1) {
2359 /* More than one remote */
2360 if (argc > 1)
2361 die(_("fetching a group and specifying refspecs does not make sense"));
2362 } else {
2363 /* Zero or one remotes */
2364 remote = remote_get(argv[0]);
2365 prune_tags_ok = (argc == 1);
2366 argc--;
2367 argv++;
2370 string_list_remove_duplicates(&list, 0);
2372 if (negotiate_only) {
2373 struct oidset acked_commits = OIDSET_INIT;
2374 struct oidset_iter iter;
2375 const struct object_id *oid;
2377 if (!remote)
2378 die(_("must supply remote when using --negotiate-only"));
2379 gtransport = prepare_transport(remote, 1);
2380 if (gtransport->smart_options) {
2381 gtransport->smart_options->acked_commits = &acked_commits;
2382 } else {
2383 warning(_("protocol does not support --negotiate-only, exiting"));
2384 result = 1;
2385 goto cleanup;
2387 if (server_options.nr)
2388 gtransport->server_options = &server_options;
2389 result = transport_fetch_refs(gtransport, NULL);
2391 oidset_iter_init(&acked_commits, &iter);
2392 while ((oid = oidset_iter_next(&iter)))
2393 printf("%s\n", oid_to_hex(oid));
2394 oidset_clear(&acked_commits);
2395 } else if (remote) {
2396 if (filter_options.choice || repo_has_promisor_remote(the_repository))
2397 fetch_one_setup_partial(remote);
2398 result = fetch_one(remote, argc, argv, prune_tags_ok, stdin_refspecs,
2399 &config);
2400 } else {
2401 int max_children = max_jobs;
2403 if (filter_options.choice)
2404 die(_("--filter can only be used with the remote "
2405 "configured in extensions.partialclone"));
2407 if (atomic_fetch)
2408 die(_("--atomic can only be used when fetching "
2409 "from one remote"));
2411 if (stdin_refspecs)
2412 die(_("--stdin can only be used when fetching "
2413 "from one remote"));
2415 if (max_children < 0)
2416 max_children = config.parallel;
2418 /* TODO should this also die if we have a previous partial-clone? */
2419 result = fetch_multiple(&list, max_children, &config);
2423 * This is only needed after fetch_one(), which does not fetch
2424 * submodules by itself.
2426 * When we fetch from multiple remotes, fetch_multiple() has
2427 * already updated submodules to grab commits necessary for
2428 * the fetched history from each remote, so there is no need
2429 * to fetch submodules from here.
2431 if (!result && remote && (config.recurse_submodules != RECURSE_SUBMODULES_OFF)) {
2432 struct strvec options = STRVEC_INIT;
2433 int max_children = max_jobs;
2435 if (max_children < 0)
2436 max_children = config.submodule_fetch_jobs;
2437 if (max_children < 0)
2438 max_children = config.parallel;
2440 add_options_to_argv(&options, &config);
2441 result = fetch_submodules(the_repository,
2442 &options,
2443 submodule_prefix,
2444 config.recurse_submodules,
2445 recurse_submodules_default,
2446 verbosity < 0,
2447 max_children);
2448 strvec_clear(&options);
2452 * Skip irrelevant tasks because we know objects were not
2453 * fetched.
2455 * NEEDSWORK: as a future optimization, we can return early
2456 * whenever objects were not fetched e.g. if we already have all
2457 * of them.
2459 if (negotiate_only)
2460 goto cleanup;
2462 prepare_repo_settings(the_repository);
2463 if (fetch_write_commit_graph > 0 ||
2464 (fetch_write_commit_graph < 0 &&
2465 the_repository->settings.fetch_write_commit_graph)) {
2466 int commit_graph_flags = COMMIT_GRAPH_WRITE_SPLIT;
2468 if (progress)
2469 commit_graph_flags |= COMMIT_GRAPH_WRITE_PROGRESS;
2471 write_commit_graph_reachable(the_repository->objects->odb,
2472 commit_graph_flags,
2473 NULL);
2476 if (enable_auto_gc) {
2477 if (refetch) {
2479 * Hint auto-maintenance strongly to encourage repacking,
2480 * but respect config settings disabling it.
2482 int opt_val;
2483 if (git_config_get_int("gc.autopacklimit", &opt_val))
2484 opt_val = -1;
2485 if (opt_val != 0)
2486 git_config_push_parameter("gc.autoPackLimit=1");
2488 if (git_config_get_int("maintenance.incremental-repack.auto", &opt_val))
2489 opt_val = -1;
2490 if (opt_val != 0)
2491 git_config_push_parameter("maintenance.incremental-repack.auto=-1");
2493 run_auto_maintenance(verbosity < 0);
2496 cleanup:
2497 string_list_clear(&list, 0);
2498 return result;