Merge branch 'en/header-cleanup' into maint-2.43
[alt-git.git] / builtin / fetch.c
blob119f1a72ac6605b65937af3b7cbc651b4c695c0d
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 prune;
104 int prune_tags;
105 int show_forced_updates;
106 int recurse_submodules;
107 int parallel;
108 int submodule_fetch_jobs;
111 static int git_fetch_config(const char *k, const char *v,
112 const struct config_context *ctx, void *cb)
114 struct fetch_config *fetch_config = cb;
116 if (!strcmp(k, "fetch.prune")) {
117 fetch_config->prune = git_config_bool(k, v);
118 return 0;
121 if (!strcmp(k, "fetch.prunetags")) {
122 fetch_config->prune_tags = git_config_bool(k, v);
123 return 0;
126 if (!strcmp(k, "fetch.showforcedupdates")) {
127 fetch_config->show_forced_updates = git_config_bool(k, v);
128 return 0;
131 if (!strcmp(k, "submodule.recurse")) {
132 int r = git_config_bool(k, v) ?
133 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
134 fetch_config->recurse_submodules = r;
137 if (!strcmp(k, "submodule.fetchjobs")) {
138 fetch_config->submodule_fetch_jobs = parse_submodule_fetchjobs(k, v, ctx->kvi);
139 return 0;
140 } else if (!strcmp(k, "fetch.recursesubmodules")) {
141 fetch_config->recurse_submodules = parse_fetch_recurse_submodules_arg(k, v);
142 return 0;
145 if (!strcmp(k, "fetch.parallel")) {
146 fetch_config->parallel = git_config_int(k, v, ctx->kvi);
147 if (fetch_config->parallel < 0)
148 die(_("fetch.parallel cannot be negative"));
149 if (!fetch_config->parallel)
150 fetch_config->parallel = online_cpus();
151 return 0;
154 if (!strcmp(k, "fetch.output")) {
155 if (!v)
156 return config_error_nonbool(k);
157 else if (!strcasecmp(v, "full"))
158 fetch_config->display_format = DISPLAY_FORMAT_FULL;
159 else if (!strcasecmp(v, "compact"))
160 fetch_config->display_format = DISPLAY_FORMAT_COMPACT;
161 else
162 die(_("invalid value for '%s': '%s'"),
163 "fetch.output", v);
166 return git_default_config(k, v, ctx, cb);
169 static int parse_refmap_arg(const struct option *opt, const char *arg, int unset)
171 BUG_ON_OPT_NEG(unset);
174 * "git fetch --refmap='' origin foo"
175 * can be used to tell the command not to store anywhere
177 refspec_append(opt->value, arg);
179 return 0;
182 static void unlock_pack(unsigned int flags)
184 if (gtransport)
185 transport_unlock_pack(gtransport, flags);
186 if (gsecondary)
187 transport_unlock_pack(gsecondary, flags);
190 static void unlock_pack_atexit(void)
192 unlock_pack(0);
195 static void unlock_pack_on_signal(int signo)
197 unlock_pack(TRANSPORT_UNLOCK_PACK_IN_SIGNAL_HANDLER);
198 sigchain_pop(signo);
199 raise(signo);
202 static void add_merge_config(struct ref **head,
203 const struct ref *remote_refs,
204 struct branch *branch,
205 struct ref ***tail)
207 int i;
209 for (i = 0; i < branch->merge_nr; i++) {
210 struct ref *rm, **old_tail = *tail;
211 struct refspec_item refspec;
213 for (rm = *head; rm; rm = rm->next) {
214 if (branch_merge_matches(branch, i, rm->name)) {
215 rm->fetch_head_status = FETCH_HEAD_MERGE;
216 break;
219 if (rm)
220 continue;
223 * Not fetched to a remote-tracking branch? We need to fetch
224 * it anyway to allow this branch's "branch.$name.merge"
225 * to be honored by 'git pull', but we do not have to
226 * fail if branch.$name.merge is misconfigured to point
227 * at a nonexisting branch. If we were indeed called by
228 * 'git pull', it will notice the misconfiguration because
229 * there is no entry in the resulting FETCH_HEAD marked
230 * for merging.
232 memset(&refspec, 0, sizeof(refspec));
233 refspec.src = branch->merge[i]->src;
234 get_fetch_map(remote_refs, &refspec, tail, 1);
235 for (rm = *old_tail; rm; rm = rm->next)
236 rm->fetch_head_status = FETCH_HEAD_MERGE;
240 static void create_fetch_oidset(struct ref **head, struct oidset *out)
242 struct ref *rm = *head;
243 while (rm) {
244 oidset_insert(out, &rm->old_oid);
245 rm = rm->next;
249 struct refname_hash_entry {
250 struct hashmap_entry ent;
251 struct object_id oid;
252 int ignore;
253 char refname[FLEX_ARRAY];
256 static int refname_hash_entry_cmp(const void *hashmap_cmp_fn_data UNUSED,
257 const struct hashmap_entry *eptr,
258 const struct hashmap_entry *entry_or_key,
259 const void *keydata)
261 const struct refname_hash_entry *e1, *e2;
263 e1 = container_of(eptr, const struct refname_hash_entry, ent);
264 e2 = container_of(entry_or_key, const struct refname_hash_entry, ent);
265 return strcmp(e1->refname, keydata ? keydata : e2->refname);
268 static struct refname_hash_entry *refname_hash_add(struct hashmap *map,
269 const char *refname,
270 const struct object_id *oid)
272 struct refname_hash_entry *ent;
273 size_t len = strlen(refname);
275 FLEX_ALLOC_MEM(ent, refname, refname, len);
276 hashmap_entry_init(&ent->ent, strhash(refname));
277 oidcpy(&ent->oid, oid);
278 hashmap_add(map, &ent->ent);
279 return ent;
282 static int add_one_refname(const char *refname,
283 const struct object_id *oid,
284 int flag UNUSED, void *cbdata)
286 struct hashmap *refname_map = cbdata;
288 (void) refname_hash_add(refname_map, refname, oid);
289 return 0;
292 static void refname_hash_init(struct hashmap *map)
294 hashmap_init(map, refname_hash_entry_cmp, NULL, 0);
297 static int refname_hash_exists(struct hashmap *map, const char *refname)
299 return !!hashmap_get_from_hash(map, strhash(refname), refname);
302 static void clear_item(struct refname_hash_entry *item)
304 item->ignore = 1;
308 static void add_already_queued_tags(const char *refname,
309 const struct object_id *old_oid UNUSED,
310 const struct object_id *new_oid,
311 void *cb_data)
313 struct hashmap *queued_tags = cb_data;
314 if (starts_with(refname, "refs/tags/") && new_oid)
315 (void) refname_hash_add(queued_tags, refname, new_oid);
318 static void find_non_local_tags(const struct ref *refs,
319 struct ref_transaction *transaction,
320 struct ref **head,
321 struct ref ***tail)
323 struct hashmap existing_refs;
324 struct hashmap remote_refs;
325 struct oidset fetch_oids = OIDSET_INIT;
326 struct string_list remote_refs_list = STRING_LIST_INIT_NODUP;
327 struct string_list_item *remote_ref_item;
328 const struct ref *ref;
329 struct refname_hash_entry *item = NULL;
330 const int quick_flags = OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT;
332 refname_hash_init(&existing_refs);
333 refname_hash_init(&remote_refs);
334 create_fetch_oidset(head, &fetch_oids);
336 for_each_ref(add_one_refname, &existing_refs);
339 * If we already have a transaction, then we need to filter out all
340 * tags which have already been queued up.
342 if (transaction)
343 ref_transaction_for_each_queued_update(transaction,
344 add_already_queued_tags,
345 &existing_refs);
347 for (ref = refs; ref; ref = ref->next) {
348 if (!starts_with(ref->name, "refs/tags/"))
349 continue;
352 * The peeled ref always follows the matching base
353 * ref, so if we see a peeled ref that we don't want
354 * to fetch then we can mark the ref entry in the list
355 * as one to ignore by setting util to NULL.
357 if (ends_with(ref->name, "^{}")) {
358 if (item &&
359 !repo_has_object_file_with_flags(the_repository, &ref->old_oid, quick_flags) &&
360 !oidset_contains(&fetch_oids, &ref->old_oid) &&
361 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
362 !oidset_contains(&fetch_oids, &item->oid))
363 clear_item(item);
364 item = NULL;
365 continue;
369 * If item is non-NULL here, then we previously saw a
370 * ref not followed by a peeled reference, so we need
371 * to check if it is a lightweight tag that we want to
372 * fetch.
374 if (item &&
375 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
376 !oidset_contains(&fetch_oids, &item->oid))
377 clear_item(item);
379 item = NULL;
381 /* skip duplicates and refs that we already have */
382 if (refname_hash_exists(&remote_refs, ref->name) ||
383 refname_hash_exists(&existing_refs, ref->name))
384 continue;
386 item = refname_hash_add(&remote_refs, ref->name, &ref->old_oid);
387 string_list_insert(&remote_refs_list, ref->name);
389 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
392 * We may have a final lightweight tag that needs to be
393 * checked to see if it needs fetching.
395 if (item &&
396 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
397 !oidset_contains(&fetch_oids, &item->oid))
398 clear_item(item);
401 * For all the tags in the remote_refs_list,
402 * add them to the list of refs to be fetched
404 for_each_string_list_item(remote_ref_item, &remote_refs_list) {
405 const char *refname = remote_ref_item->string;
406 struct ref *rm;
407 unsigned int hash = strhash(refname);
409 item = hashmap_get_entry_from_hash(&remote_refs, hash, refname,
410 struct refname_hash_entry, ent);
411 if (!item)
412 BUG("unseen remote ref?");
414 /* Unless we have already decided to ignore this item... */
415 if (item->ignore)
416 continue;
418 rm = alloc_ref(item->refname);
419 rm->peer_ref = alloc_ref(item->refname);
420 oidcpy(&rm->old_oid, &item->oid);
421 **tail = rm;
422 *tail = &rm->next;
424 hashmap_clear_and_free(&remote_refs, struct refname_hash_entry, ent);
425 string_list_clear(&remote_refs_list, 0);
426 oidset_clear(&fetch_oids);
429 static void filter_prefetch_refspec(struct refspec *rs)
431 int i;
433 if (!prefetch)
434 return;
436 for (i = 0; i < rs->nr; i++) {
437 struct strbuf new_dst = STRBUF_INIT;
438 char *old_dst;
439 const char *sub = NULL;
441 if (rs->items[i].negative)
442 continue;
443 if (!rs->items[i].dst ||
444 (rs->items[i].src &&
445 !strncmp(rs->items[i].src,
446 ref_namespace[NAMESPACE_TAGS].ref,
447 strlen(ref_namespace[NAMESPACE_TAGS].ref)))) {
448 int j;
450 free(rs->items[i].src);
451 free(rs->items[i].dst);
453 for (j = i + 1; j < rs->nr; j++) {
454 rs->items[j - 1] = rs->items[j];
455 rs->raw[j - 1] = rs->raw[j];
457 rs->nr--;
458 i--;
459 continue;
462 old_dst = rs->items[i].dst;
463 strbuf_addstr(&new_dst, ref_namespace[NAMESPACE_PREFETCH].ref);
466 * If old_dst starts with "refs/", then place
467 * sub after that prefix. Otherwise, start at
468 * the beginning of the string.
470 if (!skip_prefix(old_dst, "refs/", &sub))
471 sub = old_dst;
472 strbuf_addstr(&new_dst, sub);
474 rs->items[i].dst = strbuf_detach(&new_dst, NULL);
475 rs->items[i].force = 1;
477 free(old_dst);
481 static struct ref *get_ref_map(struct remote *remote,
482 const struct ref *remote_refs,
483 struct refspec *rs,
484 int tags, int *autotags)
486 int i;
487 struct ref *rm;
488 struct ref *ref_map = NULL;
489 struct ref **tail = &ref_map;
491 /* opportunistically-updated references: */
492 struct ref *orefs = NULL, **oref_tail = &orefs;
494 struct hashmap existing_refs;
495 int existing_refs_populated = 0;
497 filter_prefetch_refspec(rs);
498 if (remote)
499 filter_prefetch_refspec(&remote->fetch);
501 if (rs->nr) {
502 struct refspec *fetch_refspec;
504 for (i = 0; i < rs->nr; i++) {
505 get_fetch_map(remote_refs, &rs->items[i], &tail, 0);
506 if (rs->items[i].dst && rs->items[i].dst[0])
507 *autotags = 1;
509 /* Merge everything on the command line (but not --tags) */
510 for (rm = ref_map; rm; rm = rm->next)
511 rm->fetch_head_status = FETCH_HEAD_MERGE;
514 * For any refs that we happen to be fetching via
515 * command-line arguments, the destination ref might
516 * have been missing or have been different than the
517 * remote-tracking ref that would be derived from the
518 * configured refspec. In these cases, we want to
519 * take the opportunity to update their configured
520 * remote-tracking reference. However, we do not want
521 * to mention these entries in FETCH_HEAD at all, as
522 * they would simply be duplicates of existing
523 * entries, so we set them FETCH_HEAD_IGNORE below.
525 * We compute these entries now, based only on the
526 * refspecs specified on the command line. But we add
527 * them to the list following the refspecs resulting
528 * from the tags option so that one of the latter,
529 * which has FETCH_HEAD_NOT_FOR_MERGE, is not removed
530 * by ref_remove_duplicates() in favor of one of these
531 * opportunistic entries with FETCH_HEAD_IGNORE.
533 if (refmap.nr)
534 fetch_refspec = &refmap;
535 else
536 fetch_refspec = &remote->fetch;
538 for (i = 0; i < fetch_refspec->nr; i++)
539 get_fetch_map(ref_map, &fetch_refspec->items[i], &oref_tail, 1);
540 } else if (refmap.nr) {
541 die("--refmap option is only meaningful with command-line refspec(s)");
542 } else {
543 /* Use the defaults */
544 struct branch *branch = branch_get(NULL);
545 int has_merge = branch_has_merge_config(branch);
546 if (remote &&
547 (remote->fetch.nr ||
548 /* Note: has_merge implies non-NULL branch->remote_name */
549 (has_merge && !strcmp(branch->remote_name, remote->name)))) {
550 for (i = 0; i < remote->fetch.nr; i++) {
551 get_fetch_map(remote_refs, &remote->fetch.items[i], &tail, 0);
552 if (remote->fetch.items[i].dst &&
553 remote->fetch.items[i].dst[0])
554 *autotags = 1;
555 if (!i && !has_merge && ref_map &&
556 !remote->fetch.items[0].pattern)
557 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
560 * if the remote we're fetching from is the same
561 * as given in branch.<name>.remote, we add the
562 * ref given in branch.<name>.merge, too.
564 * Note: has_merge implies non-NULL branch->remote_name
566 if (has_merge &&
567 !strcmp(branch->remote_name, remote->name))
568 add_merge_config(&ref_map, remote_refs, branch, &tail);
569 } else if (!prefetch) {
570 ref_map = get_remote_ref(remote_refs, "HEAD");
571 if (!ref_map)
572 die(_("couldn't find remote ref HEAD"));
573 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
574 tail = &ref_map->next;
578 if (tags == TAGS_SET)
579 /* also fetch all tags */
580 get_fetch_map(remote_refs, tag_refspec, &tail, 0);
581 else if (tags == TAGS_DEFAULT && *autotags)
582 find_non_local_tags(remote_refs, NULL, &ref_map, &tail);
584 /* Now append any refs to be updated opportunistically: */
585 *tail = orefs;
586 for (rm = orefs; rm; rm = rm->next) {
587 rm->fetch_head_status = FETCH_HEAD_IGNORE;
588 tail = &rm->next;
592 * apply negative refspecs first, before we remove duplicates. This is
593 * necessary as negative refspecs might remove an otherwise conflicting
594 * duplicate.
596 if (rs->nr)
597 ref_map = apply_negative_refspecs(ref_map, rs);
598 else
599 ref_map = apply_negative_refspecs(ref_map, &remote->fetch);
601 ref_map = ref_remove_duplicates(ref_map);
603 for (rm = ref_map; rm; rm = rm->next) {
604 if (rm->peer_ref) {
605 const char *refname = rm->peer_ref->name;
606 struct refname_hash_entry *peer_item;
607 unsigned int hash = strhash(refname);
609 if (!existing_refs_populated) {
610 refname_hash_init(&existing_refs);
611 for_each_ref(add_one_refname, &existing_refs);
612 existing_refs_populated = 1;
615 peer_item = hashmap_get_entry_from_hash(&existing_refs,
616 hash, refname,
617 struct refname_hash_entry, ent);
618 if (peer_item) {
619 struct object_id *old_oid = &peer_item->oid;
620 oidcpy(&rm->peer_ref->old_oid, old_oid);
624 if (existing_refs_populated)
625 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
627 return ref_map;
630 #define STORE_REF_ERROR_OTHER 1
631 #define STORE_REF_ERROR_DF_CONFLICT 2
633 static int s_update_ref(const char *action,
634 struct ref *ref,
635 struct ref_transaction *transaction,
636 int check_old)
638 char *msg;
639 char *rla = getenv("GIT_REFLOG_ACTION");
640 struct ref_transaction *our_transaction = NULL;
641 struct strbuf err = STRBUF_INIT;
642 int ret;
644 if (dry_run)
645 return 0;
646 if (!rla)
647 rla = default_rla.buf;
648 msg = xstrfmt("%s: %s", rla, action);
651 * If no transaction was passed to us, we manage the transaction
652 * ourselves. Otherwise, we trust the caller to handle the transaction
653 * lifecycle.
655 if (!transaction) {
656 transaction = our_transaction = ref_transaction_begin(&err);
657 if (!transaction) {
658 ret = STORE_REF_ERROR_OTHER;
659 goto out;
663 ret = ref_transaction_update(transaction, ref->name, &ref->new_oid,
664 check_old ? &ref->old_oid : NULL,
665 0, msg, &err);
666 if (ret) {
667 ret = STORE_REF_ERROR_OTHER;
668 goto out;
671 if (our_transaction) {
672 switch (ref_transaction_commit(our_transaction, &err)) {
673 case 0:
674 break;
675 case TRANSACTION_NAME_CONFLICT:
676 ret = STORE_REF_ERROR_DF_CONFLICT;
677 goto out;
678 default:
679 ret = STORE_REF_ERROR_OTHER;
680 goto out;
684 out:
685 ref_transaction_free(our_transaction);
686 if (ret)
687 error("%s", err.buf);
688 strbuf_release(&err);
689 free(msg);
690 return ret;
693 static int refcol_width(const struct ref *ref_map, int compact_format)
695 const struct ref *ref;
696 int max, width = 10;
698 max = term_columns();
699 if (compact_format)
700 max = max * 2 / 3;
702 for (ref = ref_map; ref; ref = ref->next) {
703 int rlen, llen = 0, len;
705 if (ref->status == REF_STATUS_REJECT_SHALLOW ||
706 !ref->peer_ref ||
707 !strcmp(ref->name, "HEAD"))
708 continue;
710 /* uptodate lines are only shown on high verbosity level */
711 if (verbosity <= 0 && oideq(&ref->peer_ref->old_oid, &ref->old_oid))
712 continue;
714 rlen = utf8_strwidth(prettify_refname(ref->name));
715 if (!compact_format)
716 llen = utf8_strwidth(prettify_refname(ref->peer_ref->name));
719 * rough estimation to see if the output line is too long and
720 * should not be counted (we can't do precise calculation
721 * anyway because we don't know if the error explanation part
722 * will be printed in update_local_ref)
724 len = 21 /* flag and summary */ + rlen + 4 /* -> */ + llen;
725 if (len >= max)
726 continue;
728 if (width < rlen)
729 width = rlen;
732 return width;
735 static void display_state_init(struct display_state *display_state, struct ref *ref_map,
736 const char *raw_url, enum display_format format)
738 int i;
740 memset(display_state, 0, sizeof(*display_state));
741 strbuf_init(&display_state->buf, 0);
742 display_state->format = format;
744 if (raw_url)
745 display_state->url = transport_anonymize_url(raw_url);
746 else
747 display_state->url = xstrdup("foreign");
749 display_state->url_len = strlen(display_state->url);
750 for (i = display_state->url_len - 1; display_state->url[i] == '/' && 0 <= i; i--)
752 display_state->url_len = i + 1;
753 if (4 < i && !strncmp(".git", display_state->url + i - 3, 4))
754 display_state->url_len = i - 3;
756 if (verbosity < 0)
757 return;
759 switch (display_state->format) {
760 case DISPLAY_FORMAT_FULL:
761 case DISPLAY_FORMAT_COMPACT:
762 display_state->refcol_width = refcol_width(ref_map,
763 display_state->format == DISPLAY_FORMAT_COMPACT);
764 break;
765 case DISPLAY_FORMAT_PORCELAIN:
766 /* We don't need to precompute anything here. */
767 break;
768 default:
769 BUG("unexpected display format %d", display_state->format);
773 static void display_state_release(struct display_state *display_state)
775 strbuf_release(&display_state->buf);
776 free(display_state->url);
779 static void print_remote_to_local(struct display_state *display_state,
780 const char *remote, const char *local)
782 strbuf_addf(&display_state->buf, "%-*s -> %s",
783 display_state->refcol_width, remote, local);
786 static int find_and_replace(struct strbuf *haystack,
787 const char *needle,
788 const char *placeholder)
790 const char *p = NULL;
791 int plen, nlen;
793 nlen = strlen(needle);
794 if (ends_with(haystack->buf, needle))
795 p = haystack->buf + haystack->len - nlen;
796 else
797 p = strstr(haystack->buf, needle);
798 if (!p)
799 return 0;
801 if (p > haystack->buf && p[-1] != '/')
802 return 0;
804 plen = strlen(p);
805 if (plen > nlen && p[nlen] != '/')
806 return 0;
808 strbuf_splice(haystack, p - haystack->buf, nlen,
809 placeholder, strlen(placeholder));
810 return 1;
813 static void print_compact(struct display_state *display_state,
814 const char *remote, const char *local)
816 struct strbuf r = STRBUF_INIT;
817 struct strbuf l = STRBUF_INIT;
819 if (!strcmp(remote, local)) {
820 strbuf_addf(&display_state->buf, "%-*s -> *", display_state->refcol_width, remote);
821 return;
824 strbuf_addstr(&r, remote);
825 strbuf_addstr(&l, local);
827 if (!find_and_replace(&r, local, "*"))
828 find_and_replace(&l, remote, "*");
829 print_remote_to_local(display_state, r.buf, l.buf);
831 strbuf_release(&r);
832 strbuf_release(&l);
835 static void display_ref_update(struct display_state *display_state, char code,
836 const char *summary, const char *error,
837 const char *remote, const char *local,
838 const struct object_id *old_oid,
839 const struct object_id *new_oid,
840 int summary_width)
842 FILE *f = stderr;
844 if (verbosity < 0)
845 return;
847 strbuf_reset(&display_state->buf);
849 switch (display_state->format) {
850 case DISPLAY_FORMAT_FULL:
851 case DISPLAY_FORMAT_COMPACT: {
852 int width;
854 if (!display_state->shown_url) {
855 strbuf_addf(&display_state->buf, _("From %.*s\n"),
856 display_state->url_len, display_state->url);
857 display_state->shown_url = 1;
860 width = (summary_width + strlen(summary) - gettext_width(summary));
861 remote = prettify_refname(remote);
862 local = prettify_refname(local);
864 strbuf_addf(&display_state->buf, " %c %-*s ", code, width, summary);
866 if (display_state->format != DISPLAY_FORMAT_COMPACT)
867 print_remote_to_local(display_state, remote, local);
868 else
869 print_compact(display_state, remote, local);
871 if (error)
872 strbuf_addf(&display_state->buf, " (%s)", error);
874 break;
876 case DISPLAY_FORMAT_PORCELAIN:
877 strbuf_addf(&display_state->buf, "%c %s %s %s", code,
878 oid_to_hex(old_oid), oid_to_hex(new_oid), local);
879 f = stdout;
880 break;
881 default:
882 BUG("unexpected display format %d", display_state->format);
884 strbuf_addch(&display_state->buf, '\n');
886 fputs(display_state->buf.buf, f);
889 static int update_local_ref(struct ref *ref,
890 struct ref_transaction *transaction,
891 struct display_state *display_state,
892 const struct ref *remote_ref,
893 int summary_width,
894 const struct fetch_config *config)
896 struct commit *current = NULL, *updated;
897 int fast_forward = 0;
899 if (!repo_has_object_file(the_repository, &ref->new_oid))
900 die(_("object %s not found"), oid_to_hex(&ref->new_oid));
902 if (oideq(&ref->old_oid, &ref->new_oid)) {
903 if (verbosity > 0)
904 display_ref_update(display_state, '=', _("[up to date]"), NULL,
905 remote_ref->name, ref->name,
906 &ref->old_oid, &ref->new_oid, summary_width);
907 return 0;
910 if (!update_head_ok &&
911 !is_null_oid(&ref->old_oid) &&
912 branch_checked_out(ref->name)) {
914 * If this is the head, and it's not okay to update
915 * the head, and the old value of the head isn't empty...
917 display_ref_update(display_state, '!', _("[rejected]"),
918 _("can't fetch into checked-out branch"),
919 remote_ref->name, ref->name,
920 &ref->old_oid, &ref->new_oid, summary_width);
921 return 1;
924 if (!is_null_oid(&ref->old_oid) &&
925 starts_with(ref->name, "refs/tags/")) {
926 if (force || ref->force) {
927 int r;
928 r = s_update_ref("updating tag", ref, transaction, 0);
929 display_ref_update(display_state, r ? '!' : 't', _("[tag update]"),
930 r ? _("unable to update local ref") : NULL,
931 remote_ref->name, ref->name,
932 &ref->old_oid, &ref->new_oid, summary_width);
933 return r;
934 } else {
935 display_ref_update(display_state, '!', _("[rejected]"),
936 _("would clobber existing tag"),
937 remote_ref->name, ref->name,
938 &ref->old_oid, &ref->new_oid, summary_width);
939 return 1;
943 current = lookup_commit_reference_gently(the_repository,
944 &ref->old_oid, 1);
945 updated = lookup_commit_reference_gently(the_repository,
946 &ref->new_oid, 1);
947 if (!current || !updated) {
948 const char *msg;
949 const char *what;
950 int r;
952 * Nicely describe the new ref we're fetching.
953 * Base this on the remote's ref name, as it's
954 * more likely to follow a standard layout.
956 if (starts_with(remote_ref->name, "refs/tags/")) {
957 msg = "storing tag";
958 what = _("[new tag]");
959 } else if (starts_with(remote_ref->name, "refs/heads/")) {
960 msg = "storing head";
961 what = _("[new branch]");
962 } else {
963 msg = "storing ref";
964 what = _("[new ref]");
967 r = s_update_ref(msg, ref, transaction, 0);
968 display_ref_update(display_state, r ? '!' : '*', what,
969 r ? _("unable to update local ref") : NULL,
970 remote_ref->name, ref->name,
971 &ref->old_oid, &ref->new_oid, summary_width);
972 return r;
975 if (config->show_forced_updates) {
976 uint64_t t_before = getnanotime();
977 fast_forward = repo_in_merge_bases(the_repository, current,
978 updated);
979 forced_updates_ms += (getnanotime() - t_before) / 1000000;
980 } else {
981 fast_forward = 1;
984 if (fast_forward) {
985 struct strbuf quickref = STRBUF_INIT;
986 int r;
988 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
989 strbuf_addstr(&quickref, "..");
990 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
991 r = s_update_ref("fast-forward", ref, transaction, 1);
992 display_ref_update(display_state, r ? '!' : ' ', quickref.buf,
993 r ? _("unable to update local ref") : NULL,
994 remote_ref->name, ref->name,
995 &ref->old_oid, &ref->new_oid, summary_width);
996 strbuf_release(&quickref);
997 return r;
998 } else if (force || ref->force) {
999 struct strbuf quickref = STRBUF_INIT;
1000 int r;
1001 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
1002 strbuf_addstr(&quickref, "...");
1003 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
1004 r = s_update_ref("forced-update", ref, transaction, 1);
1005 display_ref_update(display_state, r ? '!' : '+', quickref.buf,
1006 r ? _("unable to update local ref") : _("forced update"),
1007 remote_ref->name, ref->name,
1008 &ref->old_oid, &ref->new_oid, summary_width);
1009 strbuf_release(&quickref);
1010 return r;
1011 } else {
1012 display_ref_update(display_state, '!', _("[rejected]"), _("non-fast-forward"),
1013 remote_ref->name, ref->name,
1014 &ref->old_oid, &ref->new_oid, summary_width);
1015 return 1;
1019 static const struct object_id *iterate_ref_map(void *cb_data)
1021 struct ref **rm = cb_data;
1022 struct ref *ref = *rm;
1024 while (ref && ref->status == REF_STATUS_REJECT_SHALLOW)
1025 ref = ref->next;
1026 if (!ref)
1027 return NULL;
1028 *rm = ref->next;
1029 return &ref->old_oid;
1032 struct fetch_head {
1033 FILE *fp;
1034 struct strbuf buf;
1037 static int open_fetch_head(struct fetch_head *fetch_head)
1039 const char *filename = git_path_fetch_head(the_repository);
1041 if (write_fetch_head) {
1042 fetch_head->fp = fopen(filename, "a");
1043 if (!fetch_head->fp)
1044 return error_errno(_("cannot open '%s'"), filename);
1045 strbuf_init(&fetch_head->buf, 0);
1046 } else {
1047 fetch_head->fp = NULL;
1050 return 0;
1053 static void append_fetch_head(struct fetch_head *fetch_head,
1054 const struct object_id *old_oid,
1055 enum fetch_head_status fetch_head_status,
1056 const char *note,
1057 const char *url, size_t url_len)
1059 char old_oid_hex[GIT_MAX_HEXSZ + 1];
1060 const char *merge_status_marker;
1061 size_t i;
1063 if (!fetch_head->fp)
1064 return;
1066 switch (fetch_head_status) {
1067 case FETCH_HEAD_NOT_FOR_MERGE:
1068 merge_status_marker = "not-for-merge";
1069 break;
1070 case FETCH_HEAD_MERGE:
1071 merge_status_marker = "";
1072 break;
1073 default:
1074 /* do not write anything to FETCH_HEAD */
1075 return;
1078 strbuf_addf(&fetch_head->buf, "%s\t%s\t%s",
1079 oid_to_hex_r(old_oid_hex, old_oid), merge_status_marker, note);
1080 for (i = 0; i < url_len; ++i)
1081 if ('\n' == url[i])
1082 strbuf_addstr(&fetch_head->buf, "\\n");
1083 else
1084 strbuf_addch(&fetch_head->buf, url[i]);
1085 strbuf_addch(&fetch_head->buf, '\n');
1088 * When using an atomic fetch, we do not want to update FETCH_HEAD if
1089 * any of the reference updates fails. We thus have to write all
1090 * updates to a buffer first and only commit it as soon as all
1091 * references have been successfully updated.
1093 if (!atomic_fetch) {
1094 strbuf_write(&fetch_head->buf, fetch_head->fp);
1095 strbuf_reset(&fetch_head->buf);
1099 static void commit_fetch_head(struct fetch_head *fetch_head)
1101 if (!fetch_head->fp || !atomic_fetch)
1102 return;
1103 strbuf_write(&fetch_head->buf, fetch_head->fp);
1106 static void close_fetch_head(struct fetch_head *fetch_head)
1108 if (!fetch_head->fp)
1109 return;
1111 fclose(fetch_head->fp);
1112 strbuf_release(&fetch_head->buf);
1115 static const char warn_show_forced_updates[] =
1116 N_("fetch normally indicates which branches had a forced update,\n"
1117 "but that check has been disabled; to re-enable, use '--show-forced-updates'\n"
1118 "flag or run 'git config fetch.showForcedUpdates true'");
1119 static const char warn_time_show_forced_updates[] =
1120 N_("it took %.2f seconds to check forced updates; you can use\n"
1121 "'--no-show-forced-updates' or run 'git config fetch.showForcedUpdates false'\n"
1122 "to avoid this check\n");
1124 static int store_updated_refs(struct display_state *display_state,
1125 const char *remote_name,
1126 int connectivity_checked,
1127 struct ref_transaction *transaction, struct ref *ref_map,
1128 struct fetch_head *fetch_head,
1129 const struct fetch_config *config)
1131 int rc = 0;
1132 struct strbuf note = STRBUF_INIT;
1133 const char *what, *kind;
1134 struct ref *rm;
1135 int want_status;
1136 int summary_width = 0;
1138 if (verbosity >= 0)
1139 summary_width = transport_summary_width(ref_map);
1141 if (!connectivity_checked) {
1142 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1144 opt.exclude_hidden_refs_section = "fetch";
1145 rm = ref_map;
1146 if (check_connected(iterate_ref_map, &rm, &opt)) {
1147 rc = error(_("%s did not send all necessary objects\n"),
1148 display_state->url);
1149 goto abort;
1154 * We do a pass for each fetch_head_status type in their enum order, so
1155 * merged entries are written before not-for-merge. That lets readers
1156 * use FETCH_HEAD as a refname to refer to the ref to be merged.
1158 for (want_status = FETCH_HEAD_MERGE;
1159 want_status <= FETCH_HEAD_IGNORE;
1160 want_status++) {
1161 for (rm = ref_map; rm; rm = rm->next) {
1162 struct ref *ref = NULL;
1164 if (rm->status == REF_STATUS_REJECT_SHALLOW) {
1165 if (want_status == FETCH_HEAD_MERGE)
1166 warning(_("rejected %s because shallow roots are not allowed to be updated"),
1167 rm->peer_ref ? rm->peer_ref->name : rm->name);
1168 continue;
1172 * When writing FETCH_HEAD we need to determine whether
1173 * we already have the commit or not. If not, then the
1174 * reference is not for merge and needs to be written
1175 * to the reflog after other commits which we already
1176 * have. We're not interested in this property though
1177 * in case FETCH_HEAD is not to be updated, so we can
1178 * skip the classification in that case.
1180 if (fetch_head->fp) {
1181 struct commit *commit = NULL;
1184 * References in "refs/tags/" are often going to point
1185 * to annotated tags, which are not part of the
1186 * commit-graph. We thus only try to look up refs in
1187 * the graph which are not in that namespace to not
1188 * regress performance in repositories with many
1189 * annotated tags.
1191 if (!starts_with(rm->name, "refs/tags/"))
1192 commit = lookup_commit_in_graph(the_repository, &rm->old_oid);
1193 if (!commit) {
1194 commit = lookup_commit_reference_gently(the_repository,
1195 &rm->old_oid,
1197 if (!commit)
1198 rm->fetch_head_status = FETCH_HEAD_NOT_FOR_MERGE;
1202 if (rm->fetch_head_status != want_status)
1203 continue;
1205 if (rm->peer_ref) {
1206 ref = alloc_ref(rm->peer_ref->name);
1207 oidcpy(&ref->old_oid, &rm->peer_ref->old_oid);
1208 oidcpy(&ref->new_oid, &rm->old_oid);
1209 ref->force = rm->peer_ref->force;
1212 if (config->recurse_submodules != RECURSE_SUBMODULES_OFF &&
1213 (!rm->peer_ref || !oideq(&ref->old_oid, &ref->new_oid))) {
1214 check_for_new_submodule_commits(&rm->old_oid);
1217 if (!strcmp(rm->name, "HEAD")) {
1218 kind = "";
1219 what = "";
1220 } else if (skip_prefix(rm->name, "refs/heads/", &what)) {
1221 kind = "branch";
1222 } else if (skip_prefix(rm->name, "refs/tags/", &what)) {
1223 kind = "tag";
1224 } else if (skip_prefix(rm->name, "refs/remotes/", &what)) {
1225 kind = "remote-tracking branch";
1226 } else {
1227 kind = "";
1228 what = rm->name;
1231 strbuf_reset(&note);
1232 if (*what) {
1233 if (*kind)
1234 strbuf_addf(&note, "%s ", kind);
1235 strbuf_addf(&note, "'%s' of ", what);
1238 append_fetch_head(fetch_head, &rm->old_oid,
1239 rm->fetch_head_status,
1240 note.buf, display_state->url,
1241 display_state->url_len);
1243 if (ref) {
1244 rc |= update_local_ref(ref, transaction, display_state,
1245 rm, summary_width, config);
1246 free(ref);
1247 } else if (write_fetch_head || dry_run) {
1249 * Display fetches written to FETCH_HEAD (or
1250 * would be written to FETCH_HEAD, if --dry-run
1251 * is set).
1253 display_ref_update(display_state, '*',
1254 *kind ? kind : "branch", NULL,
1255 rm->name,
1256 "FETCH_HEAD",
1257 &rm->new_oid, &rm->old_oid,
1258 summary_width);
1263 if (rc & STORE_REF_ERROR_DF_CONFLICT)
1264 error(_("some local refs could not be updated; try running\n"
1265 " 'git remote prune %s' to remove any old, conflicting "
1266 "branches"), remote_name);
1268 if (advice_enabled(ADVICE_FETCH_SHOW_FORCED_UPDATES)) {
1269 if (!config->show_forced_updates) {
1270 warning(_(warn_show_forced_updates));
1271 } else if (forced_updates_ms > FORCED_UPDATES_DELAY_WARNING_IN_MS) {
1272 warning(_(warn_time_show_forced_updates),
1273 forced_updates_ms / 1000.0);
1277 abort:
1278 strbuf_release(&note);
1279 return rc;
1283 * We would want to bypass the object transfer altogether if
1284 * everything we are going to fetch already exists and is connected
1285 * locally.
1287 static int check_exist_and_connected(struct ref *ref_map)
1289 struct ref *rm = ref_map;
1290 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1291 struct ref *r;
1294 * If we are deepening a shallow clone we already have these
1295 * objects reachable. Running rev-list here will return with
1296 * a good (0) exit status and we'll bypass the fetch that we
1297 * really need to perform. Claiming failure now will ensure
1298 * we perform the network exchange to deepen our history.
1300 if (deepen)
1301 return -1;
1304 * Similarly, if we need to refetch, we always want to perform a full
1305 * fetch ignoring existing objects.
1307 if (refetch)
1308 return -1;
1312 * check_connected() allows objects to merely be promised, but
1313 * we need all direct targets to exist.
1315 for (r = rm; r; r = r->next) {
1316 if (!repo_has_object_file_with_flags(the_repository, &r->old_oid,
1317 OBJECT_INFO_SKIP_FETCH_OBJECT))
1318 return -1;
1321 opt.quiet = 1;
1322 opt.exclude_hidden_refs_section = "fetch";
1323 return check_connected(iterate_ref_map, &rm, &opt);
1326 static int fetch_and_consume_refs(struct display_state *display_state,
1327 struct transport *transport,
1328 struct ref_transaction *transaction,
1329 struct ref *ref_map,
1330 struct fetch_head *fetch_head,
1331 const struct fetch_config *config)
1333 int connectivity_checked = 1;
1334 int ret;
1337 * We don't need to perform a fetch in case we can already satisfy all
1338 * refs.
1340 ret = check_exist_and_connected(ref_map);
1341 if (ret) {
1342 trace2_region_enter("fetch", "fetch_refs", the_repository);
1343 ret = transport_fetch_refs(transport, ref_map);
1344 trace2_region_leave("fetch", "fetch_refs", the_repository);
1345 if (ret)
1346 goto out;
1347 connectivity_checked = transport->smart_options ?
1348 transport->smart_options->connectivity_checked : 0;
1351 trace2_region_enter("fetch", "consume_refs", the_repository);
1352 ret = store_updated_refs(display_state, transport->remote->name,
1353 connectivity_checked, transaction, ref_map,
1354 fetch_head, config);
1355 trace2_region_leave("fetch", "consume_refs", the_repository);
1357 out:
1358 transport_unlock_pack(transport, 0);
1359 return ret;
1362 static int prune_refs(struct display_state *display_state,
1363 struct refspec *rs,
1364 struct ref_transaction *transaction,
1365 struct ref *ref_map)
1367 int result = 0;
1368 struct ref *ref, *stale_refs = get_stale_heads(rs, ref_map);
1369 struct strbuf err = STRBUF_INIT;
1370 const char *dangling_msg = dry_run
1371 ? _(" (%s will become dangling)")
1372 : _(" (%s has become dangling)");
1374 if (!dry_run) {
1375 if (transaction) {
1376 for (ref = stale_refs; ref; ref = ref->next) {
1377 result = ref_transaction_delete(transaction, ref->name, NULL, 0,
1378 "fetch: prune", &err);
1379 if (result)
1380 goto cleanup;
1382 } else {
1383 struct string_list refnames = STRING_LIST_INIT_NODUP;
1385 for (ref = stale_refs; ref; ref = ref->next)
1386 string_list_append(&refnames, ref->name);
1388 result = delete_refs("fetch: prune", &refnames, 0);
1389 string_list_clear(&refnames, 0);
1393 if (verbosity >= 0) {
1394 int summary_width = transport_summary_width(stale_refs);
1396 for (ref = stale_refs; ref; ref = ref->next) {
1397 display_ref_update(display_state, '-', _("[deleted]"), NULL,
1398 _("(none)"), ref->name,
1399 &ref->new_oid, &ref->old_oid,
1400 summary_width);
1401 warn_dangling_symref(stderr, dangling_msg, ref->name);
1405 cleanup:
1406 strbuf_release(&err);
1407 free_refs(stale_refs);
1408 return result;
1411 static void check_not_current_branch(struct ref *ref_map)
1413 const char *path;
1414 for (; ref_map; ref_map = ref_map->next)
1415 if (ref_map->peer_ref &&
1416 starts_with(ref_map->peer_ref->name, "refs/heads/") &&
1417 (path = branch_checked_out(ref_map->peer_ref->name)))
1418 die(_("refusing to fetch into branch '%s' "
1419 "checked out at '%s'"),
1420 ref_map->peer_ref->name, path);
1423 static int truncate_fetch_head(void)
1425 const char *filename = git_path_fetch_head(the_repository);
1426 FILE *fp = fopen_for_writing(filename);
1428 if (!fp)
1429 return error_errno(_("cannot open '%s'"), filename);
1430 fclose(fp);
1431 return 0;
1434 static void set_option(struct transport *transport, const char *name, const char *value)
1436 int r = transport_set_option(transport, name, value);
1437 if (r < 0)
1438 die(_("option \"%s\" value \"%s\" is not valid for %s"),
1439 name, value, transport->url);
1440 if (r > 0)
1441 warning(_("option \"%s\" is ignored for %s\n"),
1442 name, transport->url);
1446 static int add_oid(const char *refname UNUSED,
1447 const struct object_id *oid,
1448 int flags UNUSED, void *cb_data)
1450 struct oid_array *oids = cb_data;
1452 oid_array_append(oids, oid);
1453 return 0;
1456 static void add_negotiation_tips(struct git_transport_options *smart_options)
1458 struct oid_array *oids = xcalloc(1, sizeof(*oids));
1459 int i;
1461 for (i = 0; i < negotiation_tip.nr; i++) {
1462 const char *s = negotiation_tip.items[i].string;
1463 int old_nr;
1464 if (!has_glob_specials(s)) {
1465 struct object_id oid;
1466 if (repo_get_oid(the_repository, s, &oid))
1467 die(_("%s is not a valid object"), s);
1468 if (!has_object(the_repository, &oid, 0))
1469 die(_("the object %s does not exist"), s);
1470 oid_array_append(oids, &oid);
1471 continue;
1473 old_nr = oids->nr;
1474 for_each_glob_ref(add_oid, s, oids);
1475 if (old_nr == oids->nr)
1476 warning("ignoring --negotiation-tip=%s because it does not match any refs",
1479 smart_options->negotiation_tips = oids;
1482 static struct transport *prepare_transport(struct remote *remote, int deepen)
1484 struct transport *transport;
1486 transport = transport_get(remote, NULL);
1487 transport_set_verbosity(transport, verbosity, progress);
1488 transport->family = family;
1489 if (upload_pack)
1490 set_option(transport, TRANS_OPT_UPLOADPACK, upload_pack);
1491 if (keep)
1492 set_option(transport, TRANS_OPT_KEEP, "yes");
1493 if (depth)
1494 set_option(transport, TRANS_OPT_DEPTH, depth);
1495 if (deepen && deepen_since)
1496 set_option(transport, TRANS_OPT_DEEPEN_SINCE, deepen_since);
1497 if (deepen && deepen_not.nr)
1498 set_option(transport, TRANS_OPT_DEEPEN_NOT,
1499 (const char *)&deepen_not);
1500 if (deepen_relative)
1501 set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, "yes");
1502 if (update_shallow)
1503 set_option(transport, TRANS_OPT_UPDATE_SHALLOW, "yes");
1504 if (refetch)
1505 set_option(transport, TRANS_OPT_REFETCH, "yes");
1506 if (filter_options.choice) {
1507 const char *spec =
1508 expand_list_objects_filter_spec(&filter_options);
1509 set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER, spec);
1510 set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1512 if (negotiation_tip.nr) {
1513 if (transport->smart_options)
1514 add_negotiation_tips(transport->smart_options);
1515 else
1516 warning("ignoring --negotiation-tip because the protocol does not support it");
1518 return transport;
1521 static int backfill_tags(struct display_state *display_state,
1522 struct transport *transport,
1523 struct ref_transaction *transaction,
1524 struct ref *ref_map,
1525 struct fetch_head *fetch_head,
1526 const struct fetch_config *config)
1528 int retcode, cannot_reuse;
1531 * Once we have set TRANS_OPT_DEEPEN_SINCE, we can't unset it
1532 * when remote helper is used (setting it to an empty string
1533 * is not unsetting). We could extend the remote helper
1534 * protocol for that, but for now, just force a new connection
1535 * without deepen-since. Similar story for deepen-not.
1537 cannot_reuse = transport->cannot_reuse ||
1538 deepen_since || deepen_not.nr;
1539 if (cannot_reuse) {
1540 gsecondary = prepare_transport(transport->remote, 0);
1541 transport = gsecondary;
1544 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
1545 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
1546 transport_set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, NULL);
1547 retcode = fetch_and_consume_refs(display_state, transport, transaction, ref_map,
1548 fetch_head, config);
1550 if (gsecondary) {
1551 transport_disconnect(gsecondary);
1552 gsecondary = NULL;
1555 return retcode;
1558 static int do_fetch(struct transport *transport,
1559 struct refspec *rs,
1560 const struct fetch_config *config)
1562 struct ref_transaction *transaction = NULL;
1563 struct ref *ref_map = NULL;
1564 struct display_state display_state = { 0 };
1565 int autotags = (transport->remote->fetch_tags == 1);
1566 int retcode = 0;
1567 const struct ref *remote_refs;
1568 struct transport_ls_refs_options transport_ls_refs_options =
1569 TRANSPORT_LS_REFS_OPTIONS_INIT;
1570 int must_list_refs = 1;
1571 struct fetch_head fetch_head = { 0 };
1572 struct strbuf err = STRBUF_INIT;
1574 if (tags == TAGS_DEFAULT) {
1575 if (transport->remote->fetch_tags == 2)
1576 tags = TAGS_SET;
1577 if (transport->remote->fetch_tags == -1)
1578 tags = TAGS_UNSET;
1581 /* if not appending, truncate FETCH_HEAD */
1582 if (!append && write_fetch_head) {
1583 retcode = truncate_fetch_head();
1584 if (retcode)
1585 goto cleanup;
1588 if (rs->nr) {
1589 int i;
1591 refspec_ref_prefixes(rs, &transport_ls_refs_options.ref_prefixes);
1594 * We can avoid listing refs if all of them are exact
1595 * OIDs
1597 must_list_refs = 0;
1598 for (i = 0; i < rs->nr; i++) {
1599 if (!rs->items[i].exact_sha1) {
1600 must_list_refs = 1;
1601 break;
1604 } else {
1605 struct branch *branch = branch_get(NULL);
1607 if (transport->remote->fetch.nr)
1608 refspec_ref_prefixes(&transport->remote->fetch,
1609 &transport_ls_refs_options.ref_prefixes);
1610 if (branch_has_merge_config(branch) &&
1611 !strcmp(branch->remote_name, transport->remote->name)) {
1612 int i;
1613 for (i = 0; i < branch->merge_nr; i++) {
1614 strvec_push(&transport_ls_refs_options.ref_prefixes,
1615 branch->merge[i]->src);
1620 if (tags == TAGS_SET || tags == TAGS_DEFAULT) {
1621 must_list_refs = 1;
1622 if (transport_ls_refs_options.ref_prefixes.nr)
1623 strvec_push(&transport_ls_refs_options.ref_prefixes,
1624 "refs/tags/");
1627 if (must_list_refs) {
1628 trace2_region_enter("fetch", "remote_refs", the_repository);
1629 remote_refs = transport_get_remote_refs(transport,
1630 &transport_ls_refs_options);
1631 trace2_region_leave("fetch", "remote_refs", the_repository);
1632 } else
1633 remote_refs = NULL;
1635 transport_ls_refs_options_release(&transport_ls_refs_options);
1637 ref_map = get_ref_map(transport->remote, remote_refs, rs,
1638 tags, &autotags);
1639 if (!update_head_ok)
1640 check_not_current_branch(ref_map);
1642 retcode = open_fetch_head(&fetch_head);
1643 if (retcode)
1644 goto cleanup;
1646 display_state_init(&display_state, ref_map, transport->url,
1647 config->display_format);
1649 if (atomic_fetch) {
1650 transaction = ref_transaction_begin(&err);
1651 if (!transaction) {
1652 retcode = -1;
1653 goto cleanup;
1657 if (tags == TAGS_DEFAULT && autotags)
1658 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1659 if (prune) {
1661 * We only prune based on refspecs specified
1662 * explicitly (via command line or configuration); we
1663 * don't care whether --tags was specified.
1665 if (rs->nr) {
1666 retcode = prune_refs(&display_state, rs, transaction, ref_map);
1667 } else {
1668 retcode = prune_refs(&display_state, &transport->remote->fetch,
1669 transaction, ref_map);
1671 if (retcode != 0)
1672 retcode = 1;
1675 if (fetch_and_consume_refs(&display_state, transport, transaction, ref_map,
1676 &fetch_head, config)) {
1677 retcode = 1;
1678 goto cleanup;
1682 * If neither --no-tags nor --tags was specified, do automated tag
1683 * following.
1685 if (tags == TAGS_DEFAULT && autotags) {
1686 struct ref *tags_ref_map = NULL, **tail = &tags_ref_map;
1688 find_non_local_tags(remote_refs, transaction, &tags_ref_map, &tail);
1689 if (tags_ref_map) {
1691 * If backfilling of tags fails then we want to tell
1692 * the user so, but we have to continue regardless to
1693 * populate upstream information of the references we
1694 * have already fetched above. The exception though is
1695 * when `--atomic` is passed: in that case we'll abort
1696 * the transaction and don't commit anything.
1698 if (backfill_tags(&display_state, transport, transaction, tags_ref_map,
1699 &fetch_head, config))
1700 retcode = 1;
1703 free_refs(tags_ref_map);
1706 if (transaction) {
1707 if (retcode)
1708 goto cleanup;
1710 retcode = ref_transaction_commit(transaction, &err);
1711 if (retcode) {
1712 ref_transaction_free(transaction);
1713 transaction = NULL;
1714 goto cleanup;
1718 commit_fetch_head(&fetch_head);
1720 if (set_upstream) {
1721 struct branch *branch = branch_get("HEAD");
1722 struct ref *rm;
1723 struct ref *source_ref = NULL;
1726 * We're setting the upstream configuration for the
1727 * current branch. The relevant upstream is the
1728 * fetched branch that is meant to be merged with the
1729 * current one, i.e. the one fetched to FETCH_HEAD.
1731 * When there are several such branches, consider the
1732 * request ambiguous and err on the safe side by doing
1733 * nothing and just emit a warning.
1735 for (rm = ref_map; rm; rm = rm->next) {
1736 if (!rm->peer_ref) {
1737 if (source_ref) {
1738 warning(_("multiple branches detected, incompatible with --set-upstream"));
1739 goto cleanup;
1740 } else {
1741 source_ref = rm;
1745 if (source_ref) {
1746 if (!branch) {
1747 const char *shortname = source_ref->name;
1748 skip_prefix(shortname, "refs/heads/", &shortname);
1750 warning(_("could not set upstream of HEAD to '%s' from '%s' when "
1751 "it does not point to any branch."),
1752 shortname, transport->remote->name);
1753 goto cleanup;
1756 if (!strcmp(source_ref->name, "HEAD") ||
1757 starts_with(source_ref->name, "refs/heads/"))
1758 install_branch_config(0,
1759 branch->name,
1760 transport->remote->name,
1761 source_ref->name);
1762 else if (starts_with(source_ref->name, "refs/remotes/"))
1763 warning(_("not setting upstream for a remote remote-tracking branch"));
1764 else if (starts_with(source_ref->name, "refs/tags/"))
1765 warning(_("not setting upstream for a remote tag"));
1766 else
1767 warning(_("unknown branch type"));
1768 } else {
1769 warning(_("no source branch found;\n"
1770 "you need to specify exactly one branch with the --set-upstream option"));
1774 cleanup:
1775 if (retcode) {
1776 if (err.len) {
1777 error("%s", err.buf);
1778 strbuf_reset(&err);
1780 if (transaction && ref_transaction_abort(transaction, &err) &&
1781 err.len)
1782 error("%s", err.buf);
1785 display_state_release(&display_state);
1786 close_fetch_head(&fetch_head);
1787 strbuf_release(&err);
1788 free_refs(ref_map);
1789 return retcode;
1792 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
1794 struct string_list *list = priv;
1795 if (!remote->skip_default_update)
1796 string_list_append(list, remote->name);
1797 return 0;
1800 struct remote_group_data {
1801 const char *name;
1802 struct string_list *list;
1805 static int get_remote_group(const char *key, const char *value,
1806 const struct config_context *ctx UNUSED,
1807 void *priv)
1809 struct remote_group_data *g = priv;
1811 if (skip_prefix(key, "remotes.", &key) && !strcmp(key, g->name)) {
1812 /* split list by white space */
1813 while (*value) {
1814 size_t wordlen = strcspn(value, " \t\n");
1816 if (wordlen >= 1)
1817 string_list_append_nodup(g->list,
1818 xstrndup(value, wordlen));
1819 value += wordlen + (value[wordlen] != '\0');
1823 return 0;
1826 static int add_remote_or_group(const char *name, struct string_list *list)
1828 int prev_nr = list->nr;
1829 struct remote_group_data g;
1830 g.name = name; g.list = list;
1832 git_config(get_remote_group, &g);
1833 if (list->nr == prev_nr) {
1834 struct remote *remote = remote_get(name);
1835 if (!remote_is_configured(remote, 0))
1836 return 0;
1837 string_list_append(list, remote->name);
1839 return 1;
1842 static void add_options_to_argv(struct strvec *argv,
1843 const struct fetch_config *config)
1845 if (dry_run)
1846 strvec_push(argv, "--dry-run");
1847 if (prune != -1)
1848 strvec_push(argv, prune ? "--prune" : "--no-prune");
1849 if (prune_tags != -1)
1850 strvec_push(argv, prune_tags ? "--prune-tags" : "--no-prune-tags");
1851 if (update_head_ok)
1852 strvec_push(argv, "--update-head-ok");
1853 if (force)
1854 strvec_push(argv, "--force");
1855 if (keep)
1856 strvec_push(argv, "--keep");
1857 if (config->recurse_submodules == RECURSE_SUBMODULES_ON)
1858 strvec_push(argv, "--recurse-submodules");
1859 else if (config->recurse_submodules == RECURSE_SUBMODULES_OFF)
1860 strvec_push(argv, "--no-recurse-submodules");
1861 else if (config->recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND)
1862 strvec_push(argv, "--recurse-submodules=on-demand");
1863 if (tags == TAGS_SET)
1864 strvec_push(argv, "--tags");
1865 else if (tags == TAGS_UNSET)
1866 strvec_push(argv, "--no-tags");
1867 if (verbosity >= 2)
1868 strvec_push(argv, "-v");
1869 if (verbosity >= 1)
1870 strvec_push(argv, "-v");
1871 else if (verbosity < 0)
1872 strvec_push(argv, "-q");
1873 if (family == TRANSPORT_FAMILY_IPV4)
1874 strvec_push(argv, "--ipv4");
1875 else if (family == TRANSPORT_FAMILY_IPV6)
1876 strvec_push(argv, "--ipv6");
1877 if (!write_fetch_head)
1878 strvec_push(argv, "--no-write-fetch-head");
1879 if (config->display_format == DISPLAY_FORMAT_PORCELAIN)
1880 strvec_pushf(argv, "--porcelain");
1883 /* Fetch multiple remotes in parallel */
1885 struct parallel_fetch_state {
1886 const char **argv;
1887 struct string_list *remotes;
1888 int next, result;
1889 const struct fetch_config *config;
1892 static int fetch_next_remote(struct child_process *cp,
1893 struct strbuf *out UNUSED,
1894 void *cb, void **task_cb)
1896 struct parallel_fetch_state *state = cb;
1897 char *remote;
1899 if (state->next < 0 || state->next >= state->remotes->nr)
1900 return 0;
1902 remote = state->remotes->items[state->next++].string;
1903 *task_cb = remote;
1905 strvec_pushv(&cp->args, state->argv);
1906 strvec_push(&cp->args, remote);
1907 cp->git_cmd = 1;
1909 if (verbosity >= 0 && state->config->display_format != DISPLAY_FORMAT_PORCELAIN)
1910 printf(_("Fetching %s\n"), remote);
1912 return 1;
1915 static int fetch_failed_to_start(struct strbuf *out UNUSED,
1916 void *cb, void *task_cb)
1918 struct parallel_fetch_state *state = cb;
1919 const char *remote = task_cb;
1921 state->result = error(_("could not fetch %s"), remote);
1923 return 0;
1926 static int fetch_finished(int result, struct strbuf *out,
1927 void *cb, void *task_cb)
1929 struct parallel_fetch_state *state = cb;
1930 const char *remote = task_cb;
1932 if (result) {
1933 strbuf_addf(out, _("could not fetch '%s' (exit code: %d)\n"),
1934 remote, result);
1935 state->result = -1;
1938 return 0;
1941 static int fetch_multiple(struct string_list *list, int max_children,
1942 const struct fetch_config *config)
1944 int i, result = 0;
1945 struct strvec argv = STRVEC_INIT;
1947 if (!append && write_fetch_head) {
1948 int errcode = truncate_fetch_head();
1949 if (errcode)
1950 return errcode;
1954 * Cancel out the fetch.bundleURI config when running subprocesses,
1955 * to avoid fetching from the same bundle list multiple times.
1957 strvec_pushl(&argv, "-c", "fetch.bundleURI=",
1958 "fetch", "--append", "--no-auto-gc",
1959 "--no-write-commit-graph", NULL);
1960 add_options_to_argv(&argv, config);
1962 if (max_children != 1 && list->nr != 1) {
1963 struct parallel_fetch_state state = { argv.v, list, 0, 0, config };
1964 const struct run_process_parallel_opts opts = {
1965 .tr2_category = "fetch",
1966 .tr2_label = "parallel/fetch",
1968 .processes = max_children,
1970 .get_next_task = &fetch_next_remote,
1971 .start_failure = &fetch_failed_to_start,
1972 .task_finished = &fetch_finished,
1973 .data = &state,
1976 strvec_push(&argv, "--end-of-options");
1978 run_processes_parallel(&opts);
1979 result = state.result;
1980 } else
1981 for (i = 0; i < list->nr; i++) {
1982 const char *name = list->items[i].string;
1983 struct child_process cmd = CHILD_PROCESS_INIT;
1985 strvec_pushv(&cmd.args, argv.v);
1986 strvec_push(&cmd.args, name);
1987 if (verbosity >= 0 && config->display_format != DISPLAY_FORMAT_PORCELAIN)
1988 printf(_("Fetching %s\n"), name);
1989 cmd.git_cmd = 1;
1990 if (run_command(&cmd)) {
1991 error(_("could not fetch %s"), name);
1992 result = 1;
1996 strvec_clear(&argv);
1997 return !!result;
2001 * Fetching from the promisor remote should use the given filter-spec
2002 * or inherit the default filter-spec from the config.
2004 static inline void fetch_one_setup_partial(struct remote *remote)
2007 * Explicit --no-filter argument overrides everything, regardless
2008 * of any prior partial clones and fetches.
2010 if (filter_options.no_filter)
2011 return;
2014 * If no prior partial clone/fetch and the current fetch DID NOT
2015 * request a partial-fetch, do a normal fetch.
2017 if (!repo_has_promisor_remote(the_repository) && !filter_options.choice)
2018 return;
2021 * If this is a partial-fetch request, we enable partial on
2022 * this repo if not already enabled and remember the given
2023 * filter-spec as the default for subsequent fetches to this
2024 * remote if there is currently no default filter-spec.
2026 if (filter_options.choice) {
2027 partial_clone_register(remote->name, &filter_options);
2028 return;
2032 * Do a partial-fetch from the promisor remote using either the
2033 * explicitly given filter-spec or inherit the filter-spec from
2034 * the config.
2036 if (!filter_options.choice)
2037 partial_clone_get_default_filter_spec(&filter_options, remote->name);
2038 return;
2041 static int fetch_one(struct remote *remote, int argc, const char **argv,
2042 int prune_tags_ok, int use_stdin_refspecs,
2043 const struct fetch_config *config)
2045 struct refspec rs = REFSPEC_INIT_FETCH;
2046 int i;
2047 int exit_code;
2048 int maybe_prune_tags;
2049 int remote_via_config = remote_is_configured(remote, 0);
2051 if (!remote)
2052 die(_("no remote repository specified; please specify either a URL or a\n"
2053 "remote name from which new revisions should be fetched"));
2055 gtransport = prepare_transport(remote, 1);
2057 if (prune < 0) {
2058 /* no command line request */
2059 if (0 <= remote->prune)
2060 prune = remote->prune;
2061 else if (0 <= config->prune)
2062 prune = config->prune;
2063 else
2064 prune = PRUNE_BY_DEFAULT;
2067 if (prune_tags < 0) {
2068 /* no command line request */
2069 if (0 <= remote->prune_tags)
2070 prune_tags = remote->prune_tags;
2071 else if (0 <= config->prune_tags)
2072 prune_tags = config->prune_tags;
2073 else
2074 prune_tags = PRUNE_TAGS_BY_DEFAULT;
2077 maybe_prune_tags = prune_tags_ok && prune_tags;
2078 if (maybe_prune_tags && remote_via_config)
2079 refspec_append(&remote->fetch, TAG_REFSPEC);
2081 if (maybe_prune_tags && (argc || !remote_via_config))
2082 refspec_append(&rs, TAG_REFSPEC);
2084 for (i = 0; i < argc; i++) {
2085 if (!strcmp(argv[i], "tag")) {
2086 i++;
2087 if (i >= argc)
2088 die(_("you need to specify a tag name"));
2090 refspec_appendf(&rs, "refs/tags/%s:refs/tags/%s",
2091 argv[i], argv[i]);
2092 } else {
2093 refspec_append(&rs, argv[i]);
2097 if (use_stdin_refspecs) {
2098 struct strbuf line = STRBUF_INIT;
2099 while (strbuf_getline_lf(&line, stdin) != EOF)
2100 refspec_append(&rs, line.buf);
2101 strbuf_release(&line);
2104 if (server_options.nr)
2105 gtransport->server_options = &server_options;
2107 sigchain_push_common(unlock_pack_on_signal);
2108 atexit(unlock_pack_atexit);
2109 sigchain_push(SIGPIPE, SIG_IGN);
2110 exit_code = do_fetch(gtransport, &rs, config);
2111 sigchain_pop(SIGPIPE);
2112 refspec_clear(&rs);
2113 transport_disconnect(gtransport);
2114 gtransport = NULL;
2115 return exit_code;
2118 int cmd_fetch(int argc, const char **argv, const char *prefix)
2120 struct fetch_config config = {
2121 .display_format = DISPLAY_FORMAT_FULL,
2122 .prune = -1,
2123 .prune_tags = -1,
2124 .show_forced_updates = 1,
2125 .recurse_submodules = RECURSE_SUBMODULES_DEFAULT,
2126 .parallel = 1,
2127 .submodule_fetch_jobs = -1,
2129 const char *submodule_prefix = "";
2130 const char *bundle_uri;
2131 struct string_list list = STRING_LIST_INIT_DUP;
2132 struct remote *remote = NULL;
2133 int all = 0, multiple = 0;
2134 int result = 0;
2135 int prune_tags_ok = 1;
2136 int enable_auto_gc = 1;
2137 int unshallow = 0;
2138 int max_jobs = -1;
2139 int recurse_submodules_cli = RECURSE_SUBMODULES_DEFAULT;
2140 int recurse_submodules_default = RECURSE_SUBMODULES_ON_DEMAND;
2141 int fetch_write_commit_graph = -1;
2142 int stdin_refspecs = 0;
2143 int negotiate_only = 0;
2144 int porcelain = 0;
2145 int i;
2147 struct option builtin_fetch_options[] = {
2148 OPT__VERBOSITY(&verbosity),
2149 OPT_BOOL(0, "all", &all,
2150 N_("fetch from all remotes")),
2151 OPT_BOOL(0, "set-upstream", &set_upstream,
2152 N_("set upstream for git pull/fetch")),
2153 OPT_BOOL('a', "append", &append,
2154 N_("append to .git/FETCH_HEAD instead of overwriting")),
2155 OPT_BOOL(0, "atomic", &atomic_fetch,
2156 N_("use atomic transaction to update references")),
2157 OPT_STRING(0, "upload-pack", &upload_pack, N_("path"),
2158 N_("path to upload pack on remote end")),
2159 OPT__FORCE(&force, N_("force overwrite of local reference"), 0),
2160 OPT_BOOL('m', "multiple", &multiple,
2161 N_("fetch from multiple remotes")),
2162 OPT_SET_INT('t', "tags", &tags,
2163 N_("fetch all tags and associated objects"), TAGS_SET),
2164 OPT_SET_INT('n', NULL, &tags,
2165 N_("do not fetch all tags (--no-tags)"), TAGS_UNSET),
2166 OPT_INTEGER('j', "jobs", &max_jobs,
2167 N_("number of submodules fetched in parallel")),
2168 OPT_BOOL(0, "prefetch", &prefetch,
2169 N_("modify the refspec to place all refs within refs/prefetch/")),
2170 OPT_BOOL('p', "prune", &prune,
2171 N_("prune remote-tracking branches no longer on remote")),
2172 OPT_BOOL('P', "prune-tags", &prune_tags,
2173 N_("prune local tags no longer on remote and clobber changed tags")),
2174 OPT_CALLBACK_F(0, "recurse-submodules", &recurse_submodules_cli, N_("on-demand"),
2175 N_("control recursive fetching of submodules"),
2176 PARSE_OPT_OPTARG, option_fetch_parse_recurse_submodules),
2177 OPT_BOOL(0, "dry-run", &dry_run,
2178 N_("dry run")),
2179 OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
2180 OPT_BOOL(0, "write-fetch-head", &write_fetch_head,
2181 N_("write fetched references to the FETCH_HEAD file")),
2182 OPT_BOOL('k', "keep", &keep, N_("keep downloaded pack")),
2183 OPT_BOOL('u', "update-head-ok", &update_head_ok,
2184 N_("allow updating of HEAD ref")),
2185 OPT_BOOL(0, "progress", &progress, N_("force progress reporting")),
2186 OPT_STRING(0, "depth", &depth, N_("depth"),
2187 N_("deepen history of shallow clone")),
2188 OPT_STRING(0, "shallow-since", &deepen_since, N_("time"),
2189 N_("deepen history of shallow repository based on time")),
2190 OPT_STRING_LIST(0, "shallow-exclude", &deepen_not, N_("revision"),
2191 N_("deepen history of shallow clone, excluding rev")),
2192 OPT_INTEGER(0, "deepen", &deepen_relative,
2193 N_("deepen history of shallow clone")),
2194 OPT_SET_INT_F(0, "unshallow", &unshallow,
2195 N_("convert to a complete repository"),
2196 1, PARSE_OPT_NONEG),
2197 OPT_SET_INT_F(0, "refetch", &refetch,
2198 N_("re-fetch without negotiating common commits"),
2199 1, PARSE_OPT_NONEG),
2200 { OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, N_("dir"),
2201 N_("prepend this to submodule path output"), PARSE_OPT_HIDDEN },
2202 OPT_CALLBACK_F(0, "recurse-submodules-default",
2203 &recurse_submodules_default, N_("on-demand"),
2204 N_("default for recursive fetching of submodules "
2205 "(lower priority than config files)"),
2206 PARSE_OPT_HIDDEN, option_fetch_parse_recurse_submodules),
2207 OPT_BOOL(0, "update-shallow", &update_shallow,
2208 N_("accept refs that update .git/shallow")),
2209 OPT_CALLBACK_F(0, "refmap", &refmap, N_("refmap"),
2210 N_("specify fetch refmap"), PARSE_OPT_NONEG, parse_refmap_arg),
2211 OPT_STRING_LIST('o', "server-option", &server_options, N_("server-specific"), N_("option to transmit")),
2212 OPT_IPVERSION(&family),
2213 OPT_STRING_LIST(0, "negotiation-tip", &negotiation_tip, N_("revision"),
2214 N_("report that we have only objects reachable from this object")),
2215 OPT_BOOL(0, "negotiate-only", &negotiate_only,
2216 N_("do not fetch a packfile; instead, print ancestors of negotiation tips")),
2217 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
2218 OPT_BOOL(0, "auto-maintenance", &enable_auto_gc,
2219 N_("run 'maintenance --auto' after fetching")),
2220 OPT_BOOL(0, "auto-gc", &enable_auto_gc,
2221 N_("run 'maintenance --auto' after fetching")),
2222 OPT_BOOL(0, "show-forced-updates", &config.show_forced_updates,
2223 N_("check for forced-updates on all updated branches")),
2224 OPT_BOOL(0, "write-commit-graph", &fetch_write_commit_graph,
2225 N_("write the commit-graph after fetching")),
2226 OPT_BOOL(0, "stdin", &stdin_refspecs,
2227 N_("accept refspecs from stdin")),
2228 OPT_END()
2231 packet_trace_identity("fetch");
2233 /* Record the command line for the reflog */
2234 strbuf_addstr(&default_rla, "fetch");
2235 for (i = 1; i < argc; i++) {
2236 /* This handles non-URLs gracefully */
2237 char *anon = transport_anonymize_url(argv[i]);
2239 strbuf_addf(&default_rla, " %s", anon);
2240 free(anon);
2243 git_config(git_fetch_config, &config);
2244 if (the_repository->gitdir) {
2245 prepare_repo_settings(the_repository);
2246 the_repository->settings.command_requires_full_index = 0;
2249 argc = parse_options(argc, argv, prefix,
2250 builtin_fetch_options, builtin_fetch_usage, 0);
2252 if (recurse_submodules_cli != RECURSE_SUBMODULES_DEFAULT)
2253 config.recurse_submodules = recurse_submodules_cli;
2255 if (negotiate_only) {
2256 switch (recurse_submodules_cli) {
2257 case RECURSE_SUBMODULES_OFF:
2258 case RECURSE_SUBMODULES_DEFAULT:
2260 * --negotiate-only should never recurse into
2261 * submodules. Skip it by setting recurse_submodules to
2262 * RECURSE_SUBMODULES_OFF.
2264 config.recurse_submodules = RECURSE_SUBMODULES_OFF;
2265 break;
2267 default:
2268 die(_("options '%s' and '%s' cannot be used together"),
2269 "--negotiate-only", "--recurse-submodules");
2273 if (config.recurse_submodules != RECURSE_SUBMODULES_OFF) {
2274 int *sfjc = config.submodule_fetch_jobs == -1
2275 ? &config.submodule_fetch_jobs : NULL;
2276 int *rs = config.recurse_submodules == RECURSE_SUBMODULES_DEFAULT
2277 ? &config.recurse_submodules : NULL;
2279 fetch_config_from_gitmodules(sfjc, rs);
2283 if (porcelain) {
2284 switch (recurse_submodules_cli) {
2285 case RECURSE_SUBMODULES_OFF:
2286 case RECURSE_SUBMODULES_DEFAULT:
2288 * Reference updates in submodules would be ambiguous
2289 * in porcelain mode, so we reject this combination.
2291 config.recurse_submodules = RECURSE_SUBMODULES_OFF;
2292 break;
2294 default:
2295 die(_("options '%s' and '%s' cannot be used together"),
2296 "--porcelain", "--recurse-submodules");
2299 config.display_format = DISPLAY_FORMAT_PORCELAIN;
2302 if (negotiate_only && !negotiation_tip.nr)
2303 die(_("--negotiate-only needs one or more --negotiation-tip=*"));
2305 if (deepen_relative) {
2306 if (deepen_relative < 0)
2307 die(_("negative depth in --deepen is not supported"));
2308 if (depth)
2309 die(_("options '%s' and '%s' cannot be used together"), "--deepen", "--depth");
2310 depth = xstrfmt("%d", deepen_relative);
2312 if (unshallow) {
2313 if (depth)
2314 die(_("options '%s' and '%s' cannot be used together"), "--depth", "--unshallow");
2315 else if (!is_repository_shallow(the_repository))
2316 die(_("--unshallow on a complete repository does not make sense"));
2317 else
2318 depth = xstrfmt("%d", INFINITE_DEPTH);
2321 /* no need to be strict, transport_set_option() will validate it again */
2322 if (depth && atoi(depth) < 1)
2323 die(_("depth %s is not a positive number"), depth);
2324 if (depth || deepen_since || deepen_not.nr)
2325 deepen = 1;
2327 /* FETCH_HEAD never gets updated in --dry-run mode */
2328 if (dry_run)
2329 write_fetch_head = 0;
2331 if (!max_jobs)
2332 max_jobs = online_cpus();
2334 if (!git_config_get_string_tmp("fetch.bundleuri", &bundle_uri) &&
2335 fetch_bundle_uri(the_repository, bundle_uri, NULL))
2336 warning(_("failed to fetch bundles from '%s'"), bundle_uri);
2338 if (all) {
2339 if (argc == 1)
2340 die(_("fetch --all does not take a repository argument"));
2341 else if (argc > 1)
2342 die(_("fetch --all does not make sense with refspecs"));
2343 (void) for_each_remote(get_one_remote_for_fetch, &list);
2345 /* do not do fetch_multiple() of one */
2346 if (list.nr == 1)
2347 remote = remote_get(list.items[0].string);
2348 } else if (argc == 0) {
2349 /* No arguments -- use default remote */
2350 remote = remote_get(NULL);
2351 } else if (multiple) {
2352 /* All arguments are assumed to be remotes or groups */
2353 for (i = 0; i < argc; i++)
2354 if (!add_remote_or_group(argv[i], &list))
2355 die(_("no such remote or remote group: %s"),
2356 argv[i]);
2357 } else {
2358 /* Single remote or group */
2359 (void) add_remote_or_group(argv[0], &list);
2360 if (list.nr > 1) {
2361 /* More than one remote */
2362 if (argc > 1)
2363 die(_("fetching a group and specifying refspecs does not make sense"));
2364 } else {
2365 /* Zero or one remotes */
2366 remote = remote_get(argv[0]);
2367 prune_tags_ok = (argc == 1);
2368 argc--;
2369 argv++;
2372 string_list_remove_duplicates(&list, 0);
2374 if (negotiate_only) {
2375 struct oidset acked_commits = OIDSET_INIT;
2376 struct oidset_iter iter;
2377 const struct object_id *oid;
2379 if (!remote)
2380 die(_("must supply remote when using --negotiate-only"));
2381 gtransport = prepare_transport(remote, 1);
2382 if (gtransport->smart_options) {
2383 gtransport->smart_options->acked_commits = &acked_commits;
2384 } else {
2385 warning(_("protocol does not support --negotiate-only, exiting"));
2386 result = 1;
2387 goto cleanup;
2389 if (server_options.nr)
2390 gtransport->server_options = &server_options;
2391 result = transport_fetch_refs(gtransport, NULL);
2393 oidset_iter_init(&acked_commits, &iter);
2394 while ((oid = oidset_iter_next(&iter)))
2395 printf("%s\n", oid_to_hex(oid));
2396 oidset_clear(&acked_commits);
2397 } else if (remote) {
2398 if (filter_options.choice || repo_has_promisor_remote(the_repository))
2399 fetch_one_setup_partial(remote);
2400 result = fetch_one(remote, argc, argv, prune_tags_ok, stdin_refspecs,
2401 &config);
2402 } else {
2403 int max_children = max_jobs;
2405 if (filter_options.choice)
2406 die(_("--filter can only be used with the remote "
2407 "configured in extensions.partialclone"));
2409 if (atomic_fetch)
2410 die(_("--atomic can only be used when fetching "
2411 "from one remote"));
2413 if (stdin_refspecs)
2414 die(_("--stdin can only be used when fetching "
2415 "from one remote"));
2417 if (max_children < 0)
2418 max_children = config.parallel;
2420 /* TODO should this also die if we have a previous partial-clone? */
2421 result = fetch_multiple(&list, max_children, &config);
2425 * This is only needed after fetch_one(), which does not fetch
2426 * submodules by itself.
2428 * When we fetch from multiple remotes, fetch_multiple() has
2429 * already updated submodules to grab commits necessary for
2430 * the fetched history from each remote, so there is no need
2431 * to fetch submodules from here.
2433 if (!result && remote && (config.recurse_submodules != RECURSE_SUBMODULES_OFF)) {
2434 struct strvec options = STRVEC_INIT;
2435 int max_children = max_jobs;
2437 if (max_children < 0)
2438 max_children = config.submodule_fetch_jobs;
2439 if (max_children < 0)
2440 max_children = config.parallel;
2442 add_options_to_argv(&options, &config);
2443 result = fetch_submodules(the_repository,
2444 &options,
2445 submodule_prefix,
2446 config.recurse_submodules,
2447 recurse_submodules_default,
2448 verbosity < 0,
2449 max_children);
2450 strvec_clear(&options);
2454 * Skip irrelevant tasks because we know objects were not
2455 * fetched.
2457 * NEEDSWORK: as a future optimization, we can return early
2458 * whenever objects were not fetched e.g. if we already have all
2459 * of them.
2461 if (negotiate_only)
2462 goto cleanup;
2464 prepare_repo_settings(the_repository);
2465 if (fetch_write_commit_graph > 0 ||
2466 (fetch_write_commit_graph < 0 &&
2467 the_repository->settings.fetch_write_commit_graph)) {
2468 int commit_graph_flags = COMMIT_GRAPH_WRITE_SPLIT;
2470 if (progress)
2471 commit_graph_flags |= COMMIT_GRAPH_WRITE_PROGRESS;
2473 write_commit_graph_reachable(the_repository->objects->odb,
2474 commit_graph_flags,
2475 NULL);
2478 if (enable_auto_gc) {
2479 if (refetch) {
2481 * Hint auto-maintenance strongly to encourage repacking,
2482 * but respect config settings disabling it.
2484 int opt_val;
2485 if (git_config_get_int("gc.autopacklimit", &opt_val))
2486 opt_val = -1;
2487 if (opt_val != 0)
2488 git_config_push_parameter("gc.autoPackLimit=1");
2490 if (git_config_get_int("maintenance.incremental-repack.auto", &opt_val))
2491 opt_val = -1;
2492 if (opt_val != 0)
2493 git_config_push_parameter("maintenance.incremental-repack.auto=-1");
2495 run_auto_maintenance(verbosity < 0);
2498 cleanup:
2499 string_list_clear(&list, 0);
2500 return result;