Merge branch 'sn/typo-grammo-phraso-fixes'
[git.git] / builtin / fetch.c
blobfd134ba74d9086cfa44ba1c1b5a5a2597d182bee
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,
114 const struct config_context *ctx, void *cb)
116 struct fetch_config *fetch_config = cb;
118 if (!strcmp(k, "fetch.prune")) {
119 fetch_config->prune = git_config_bool(k, v);
120 return 0;
123 if (!strcmp(k, "fetch.prunetags")) {
124 fetch_config->prune_tags = git_config_bool(k, v);
125 return 0;
128 if (!strcmp(k, "fetch.showforcedupdates")) {
129 fetch_config->show_forced_updates = git_config_bool(k, v);
130 return 0;
133 if (!strcmp(k, "submodule.recurse")) {
134 int r = git_config_bool(k, v) ?
135 RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
136 fetch_config->recurse_submodules = r;
139 if (!strcmp(k, "submodule.fetchjobs")) {
140 fetch_config->submodule_fetch_jobs = parse_submodule_fetchjobs(k, v, ctx->kvi);
141 return 0;
142 } else if (!strcmp(k, "fetch.recursesubmodules")) {
143 fetch_config->recurse_submodules = parse_fetch_recurse_submodules_arg(k, v);
144 return 0;
147 if (!strcmp(k, "fetch.parallel")) {
148 fetch_config->parallel = git_config_int(k, v, ctx->kvi);
149 if (fetch_config->parallel < 0)
150 die(_("fetch.parallel cannot be negative"));
151 if (!fetch_config->parallel)
152 fetch_config->parallel = online_cpus();
153 return 0;
156 if (!strcmp(k, "fetch.output")) {
157 if (!v)
158 return config_error_nonbool(k);
159 else if (!strcasecmp(v, "full"))
160 fetch_config->display_format = DISPLAY_FORMAT_FULL;
161 else if (!strcasecmp(v, "compact"))
162 fetch_config->display_format = DISPLAY_FORMAT_COMPACT;
163 else
164 die(_("invalid value for '%s': '%s'"),
165 "fetch.output", v);
168 return git_default_config(k, v, ctx, cb);
171 static int parse_refmap_arg(const struct option *opt, const char *arg, int unset)
173 BUG_ON_OPT_NEG(unset);
176 * "git fetch --refmap='' origin foo"
177 * can be used to tell the command not to store anywhere
179 refspec_append(opt->value, arg);
181 return 0;
184 static void unlock_pack(unsigned int flags)
186 if (gtransport)
187 transport_unlock_pack(gtransport, flags);
188 if (gsecondary)
189 transport_unlock_pack(gsecondary, flags);
192 static void unlock_pack_atexit(void)
194 unlock_pack(0);
197 static void unlock_pack_on_signal(int signo)
199 unlock_pack(TRANSPORT_UNLOCK_PACK_IN_SIGNAL_HANDLER);
200 sigchain_pop(signo);
201 raise(signo);
204 static void add_merge_config(struct ref **head,
205 const struct ref *remote_refs,
206 struct branch *branch,
207 struct ref ***tail)
209 int i;
211 for (i = 0; i < branch->merge_nr; i++) {
212 struct ref *rm, **old_tail = *tail;
213 struct refspec_item refspec;
215 for (rm = *head; rm; rm = rm->next) {
216 if (branch_merge_matches(branch, i, rm->name)) {
217 rm->fetch_head_status = FETCH_HEAD_MERGE;
218 break;
221 if (rm)
222 continue;
225 * Not fetched to a remote-tracking branch? We need to fetch
226 * it anyway to allow this branch's "branch.$name.merge"
227 * to be honored by 'git pull', but we do not have to
228 * fail if branch.$name.merge is misconfigured to point
229 * at a nonexisting branch. If we were indeed called by
230 * 'git pull', it will notice the misconfiguration because
231 * there is no entry in the resulting FETCH_HEAD marked
232 * for merging.
234 memset(&refspec, 0, sizeof(refspec));
235 refspec.src = branch->merge[i]->src;
236 get_fetch_map(remote_refs, &refspec, tail, 1);
237 for (rm = *old_tail; rm; rm = rm->next)
238 rm->fetch_head_status = FETCH_HEAD_MERGE;
242 static void create_fetch_oidset(struct ref **head, struct oidset *out)
244 struct ref *rm = *head;
245 while (rm) {
246 oidset_insert(out, &rm->old_oid);
247 rm = rm->next;
251 struct refname_hash_entry {
252 struct hashmap_entry ent;
253 struct object_id oid;
254 int ignore;
255 char refname[FLEX_ARRAY];
258 static int refname_hash_entry_cmp(const void *hashmap_cmp_fn_data UNUSED,
259 const struct hashmap_entry *eptr,
260 const struct hashmap_entry *entry_or_key,
261 const void *keydata)
263 const struct refname_hash_entry *e1, *e2;
265 e1 = container_of(eptr, const struct refname_hash_entry, ent);
266 e2 = container_of(entry_or_key, const struct refname_hash_entry, ent);
267 return strcmp(e1->refname, keydata ? keydata : e2->refname);
270 static struct refname_hash_entry *refname_hash_add(struct hashmap *map,
271 const char *refname,
272 const struct object_id *oid)
274 struct refname_hash_entry *ent;
275 size_t len = strlen(refname);
277 FLEX_ALLOC_MEM(ent, refname, refname, len);
278 hashmap_entry_init(&ent->ent, strhash(refname));
279 oidcpy(&ent->oid, oid);
280 hashmap_add(map, &ent->ent);
281 return ent;
284 static int add_one_refname(const char *refname,
285 const struct object_id *oid,
286 int flag UNUSED, void *cbdata)
288 struct hashmap *refname_map = cbdata;
290 (void) refname_hash_add(refname_map, refname, oid);
291 return 0;
294 static void refname_hash_init(struct hashmap *map)
296 hashmap_init(map, refname_hash_entry_cmp, NULL, 0);
299 static int refname_hash_exists(struct hashmap *map, const char *refname)
301 return !!hashmap_get_from_hash(map, strhash(refname), refname);
304 static void clear_item(struct refname_hash_entry *item)
306 item->ignore = 1;
310 static void add_already_queued_tags(const char *refname,
311 const struct object_id *old_oid UNUSED,
312 const struct object_id *new_oid,
313 void *cb_data)
315 struct hashmap *queued_tags = cb_data;
316 if (starts_with(refname, "refs/tags/") && new_oid)
317 (void) refname_hash_add(queued_tags, refname, new_oid);
320 static void find_non_local_tags(const struct ref *refs,
321 struct ref_transaction *transaction,
322 struct ref **head,
323 struct ref ***tail)
325 struct hashmap existing_refs;
326 struct hashmap remote_refs;
327 struct oidset fetch_oids = OIDSET_INIT;
328 struct string_list remote_refs_list = STRING_LIST_INIT_NODUP;
329 struct string_list_item *remote_ref_item;
330 const struct ref *ref;
331 struct refname_hash_entry *item = NULL;
332 const int quick_flags = OBJECT_INFO_QUICK | OBJECT_INFO_SKIP_FETCH_OBJECT;
334 refname_hash_init(&existing_refs);
335 refname_hash_init(&remote_refs);
336 create_fetch_oidset(head, &fetch_oids);
338 for_each_ref(add_one_refname, &existing_refs);
341 * If we already have a transaction, then we need to filter out all
342 * tags which have already been queued up.
344 if (transaction)
345 ref_transaction_for_each_queued_update(transaction,
346 add_already_queued_tags,
347 &existing_refs);
349 for (ref = refs; ref; ref = ref->next) {
350 if (!starts_with(ref->name, "refs/tags/"))
351 continue;
354 * The peeled ref always follows the matching base
355 * ref, so if we see a peeled ref that we don't want
356 * to fetch then we can mark the ref entry in the list
357 * as one to ignore by setting util to NULL.
359 if (ends_with(ref->name, "^{}")) {
360 if (item &&
361 !repo_has_object_file_with_flags(the_repository, &ref->old_oid, quick_flags) &&
362 !oidset_contains(&fetch_oids, &ref->old_oid) &&
363 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
364 !oidset_contains(&fetch_oids, &item->oid))
365 clear_item(item);
366 item = NULL;
367 continue;
371 * If item is non-NULL here, then we previously saw a
372 * ref not followed by a peeled reference, so we need
373 * to check if it is a lightweight tag that we want to
374 * fetch.
376 if (item &&
377 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
378 !oidset_contains(&fetch_oids, &item->oid))
379 clear_item(item);
381 item = NULL;
383 /* skip duplicates and refs that we already have */
384 if (refname_hash_exists(&remote_refs, ref->name) ||
385 refname_hash_exists(&existing_refs, ref->name))
386 continue;
388 item = refname_hash_add(&remote_refs, ref->name, &ref->old_oid);
389 string_list_insert(&remote_refs_list, ref->name);
391 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
394 * We may have a final lightweight tag that needs to be
395 * checked to see if it needs fetching.
397 if (item &&
398 !repo_has_object_file_with_flags(the_repository, &item->oid, quick_flags) &&
399 !oidset_contains(&fetch_oids, &item->oid))
400 clear_item(item);
403 * For all the tags in the remote_refs_list,
404 * add them to the list of refs to be fetched
406 for_each_string_list_item(remote_ref_item, &remote_refs_list) {
407 const char *refname = remote_ref_item->string;
408 struct ref *rm;
409 unsigned int hash = strhash(refname);
411 item = hashmap_get_entry_from_hash(&remote_refs, hash, refname,
412 struct refname_hash_entry, ent);
413 if (!item)
414 BUG("unseen remote ref?");
416 /* Unless we have already decided to ignore this item... */
417 if (item->ignore)
418 continue;
420 rm = alloc_ref(item->refname);
421 rm->peer_ref = alloc_ref(item->refname);
422 oidcpy(&rm->old_oid, &item->oid);
423 **tail = rm;
424 *tail = &rm->next;
426 hashmap_clear_and_free(&remote_refs, struct refname_hash_entry, ent);
427 string_list_clear(&remote_refs_list, 0);
428 oidset_clear(&fetch_oids);
431 static void filter_prefetch_refspec(struct refspec *rs)
433 int i;
435 if (!prefetch)
436 return;
438 for (i = 0; i < rs->nr; i++) {
439 struct strbuf new_dst = STRBUF_INIT;
440 char *old_dst;
441 const char *sub = NULL;
443 if (rs->items[i].negative)
444 continue;
445 if (!rs->items[i].dst ||
446 (rs->items[i].src &&
447 !strncmp(rs->items[i].src,
448 ref_namespace[NAMESPACE_TAGS].ref,
449 strlen(ref_namespace[NAMESPACE_TAGS].ref)))) {
450 int j;
452 free(rs->items[i].src);
453 free(rs->items[i].dst);
455 for (j = i + 1; j < rs->nr; j++) {
456 rs->items[j - 1] = rs->items[j];
457 rs->raw[j - 1] = rs->raw[j];
459 rs->nr--;
460 i--;
461 continue;
464 old_dst = rs->items[i].dst;
465 strbuf_addstr(&new_dst, ref_namespace[NAMESPACE_PREFETCH].ref);
468 * If old_dst starts with "refs/", then place
469 * sub after that prefix. Otherwise, start at
470 * the beginning of the string.
472 if (!skip_prefix(old_dst, "refs/", &sub))
473 sub = old_dst;
474 strbuf_addstr(&new_dst, sub);
476 rs->items[i].dst = strbuf_detach(&new_dst, NULL);
477 rs->items[i].force = 1;
479 free(old_dst);
483 static struct ref *get_ref_map(struct remote *remote,
484 const struct ref *remote_refs,
485 struct refspec *rs,
486 int tags, int *autotags)
488 int i;
489 struct ref *rm;
490 struct ref *ref_map = NULL;
491 struct ref **tail = &ref_map;
493 /* opportunistically-updated references: */
494 struct ref *orefs = NULL, **oref_tail = &orefs;
496 struct hashmap existing_refs;
497 int existing_refs_populated = 0;
499 filter_prefetch_refspec(rs);
500 if (remote)
501 filter_prefetch_refspec(&remote->fetch);
503 if (rs->nr) {
504 struct refspec *fetch_refspec;
506 for (i = 0; i < rs->nr; i++) {
507 get_fetch_map(remote_refs, &rs->items[i], &tail, 0);
508 if (rs->items[i].dst && rs->items[i].dst[0])
509 *autotags = 1;
511 /* Merge everything on the command line (but not --tags) */
512 for (rm = ref_map; rm; rm = rm->next)
513 rm->fetch_head_status = FETCH_HEAD_MERGE;
516 * For any refs that we happen to be fetching via
517 * command-line arguments, the destination ref might
518 * have been missing or have been different than the
519 * remote-tracking ref that would be derived from the
520 * configured refspec. In these cases, we want to
521 * take the opportunity to update their configured
522 * remote-tracking reference. However, we do not want
523 * to mention these entries in FETCH_HEAD at all, as
524 * they would simply be duplicates of existing
525 * entries, so we set them FETCH_HEAD_IGNORE below.
527 * We compute these entries now, based only on the
528 * refspecs specified on the command line. But we add
529 * them to the list following the refspecs resulting
530 * from the tags option so that one of the latter,
531 * which has FETCH_HEAD_NOT_FOR_MERGE, is not removed
532 * by ref_remove_duplicates() in favor of one of these
533 * opportunistic entries with FETCH_HEAD_IGNORE.
535 if (refmap.nr)
536 fetch_refspec = &refmap;
537 else
538 fetch_refspec = &remote->fetch;
540 for (i = 0; i < fetch_refspec->nr; i++)
541 get_fetch_map(ref_map, &fetch_refspec->items[i], &oref_tail, 1);
542 } else if (refmap.nr) {
543 die("--refmap option is only meaningful with command-line refspec(s)");
544 } else {
545 /* Use the defaults */
546 struct branch *branch = branch_get(NULL);
547 int has_merge = branch_has_merge_config(branch);
548 if (remote &&
549 (remote->fetch.nr ||
550 /* Note: has_merge implies non-NULL branch->remote_name */
551 (has_merge && !strcmp(branch->remote_name, remote->name)))) {
552 for (i = 0; i < remote->fetch.nr; i++) {
553 get_fetch_map(remote_refs, &remote->fetch.items[i], &tail, 0);
554 if (remote->fetch.items[i].dst &&
555 remote->fetch.items[i].dst[0])
556 *autotags = 1;
557 if (!i && !has_merge && ref_map &&
558 !remote->fetch.items[0].pattern)
559 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
562 * if the remote we're fetching from is the same
563 * as given in branch.<name>.remote, we add the
564 * ref given in branch.<name>.merge, too.
566 * Note: has_merge implies non-NULL branch->remote_name
568 if (has_merge &&
569 !strcmp(branch->remote_name, remote->name))
570 add_merge_config(&ref_map, remote_refs, branch, &tail);
571 } else if (!prefetch) {
572 ref_map = get_remote_ref(remote_refs, "HEAD");
573 if (!ref_map)
574 die(_("couldn't find remote ref HEAD"));
575 ref_map->fetch_head_status = FETCH_HEAD_MERGE;
576 tail = &ref_map->next;
580 if (tags == TAGS_SET)
581 /* also fetch all tags */
582 get_fetch_map(remote_refs, tag_refspec, &tail, 0);
583 else if (tags == TAGS_DEFAULT && *autotags)
584 find_non_local_tags(remote_refs, NULL, &ref_map, &tail);
586 /* Now append any refs to be updated opportunistically: */
587 *tail = orefs;
588 for (rm = orefs; rm; rm = rm->next) {
589 rm->fetch_head_status = FETCH_HEAD_IGNORE;
590 tail = &rm->next;
594 * apply negative refspecs first, before we remove duplicates. This is
595 * necessary as negative refspecs might remove an otherwise conflicting
596 * duplicate.
598 if (rs->nr)
599 ref_map = apply_negative_refspecs(ref_map, rs);
600 else
601 ref_map = apply_negative_refspecs(ref_map, &remote->fetch);
603 ref_map = ref_remove_duplicates(ref_map);
605 for (rm = ref_map; rm; rm = rm->next) {
606 if (rm->peer_ref) {
607 const char *refname = rm->peer_ref->name;
608 struct refname_hash_entry *peer_item;
609 unsigned int hash = strhash(refname);
611 if (!existing_refs_populated) {
612 refname_hash_init(&existing_refs);
613 for_each_ref(add_one_refname, &existing_refs);
614 existing_refs_populated = 1;
617 peer_item = hashmap_get_entry_from_hash(&existing_refs,
618 hash, refname,
619 struct refname_hash_entry, ent);
620 if (peer_item) {
621 struct object_id *old_oid = &peer_item->oid;
622 oidcpy(&rm->peer_ref->old_oid, old_oid);
626 if (existing_refs_populated)
627 hashmap_clear_and_free(&existing_refs, struct refname_hash_entry, ent);
629 return ref_map;
632 #define STORE_REF_ERROR_OTHER 1
633 #define STORE_REF_ERROR_DF_CONFLICT 2
635 static int s_update_ref(const char *action,
636 struct ref *ref,
637 struct ref_transaction *transaction,
638 int check_old)
640 char *msg;
641 char *rla = getenv("GIT_REFLOG_ACTION");
642 struct ref_transaction *our_transaction = NULL;
643 struct strbuf err = STRBUF_INIT;
644 int ret;
646 if (dry_run)
647 return 0;
648 if (!rla)
649 rla = default_rla.buf;
650 msg = xstrfmt("%s: %s", rla, action);
653 * If no transaction was passed to us, we manage the transaction
654 * ourselves. Otherwise, we trust the caller to handle the transaction
655 * lifecycle.
657 if (!transaction) {
658 transaction = our_transaction = ref_transaction_begin(&err);
659 if (!transaction) {
660 ret = STORE_REF_ERROR_OTHER;
661 goto out;
665 ret = ref_transaction_update(transaction, ref->name, &ref->new_oid,
666 check_old ? &ref->old_oid : NULL,
667 0, msg, &err);
668 if (ret) {
669 ret = STORE_REF_ERROR_OTHER;
670 goto out;
673 if (our_transaction) {
674 switch (ref_transaction_commit(our_transaction, &err)) {
675 case 0:
676 break;
677 case TRANSACTION_NAME_CONFLICT:
678 ret = STORE_REF_ERROR_DF_CONFLICT;
679 goto out;
680 default:
681 ret = STORE_REF_ERROR_OTHER;
682 goto out;
686 out:
687 ref_transaction_free(our_transaction);
688 if (ret)
689 error("%s", err.buf);
690 strbuf_release(&err);
691 free(msg);
692 return ret;
695 static int refcol_width(const struct ref *ref_map, int compact_format)
697 const struct ref *ref;
698 int max, width = 10;
700 max = term_columns();
701 if (compact_format)
702 max = max * 2 / 3;
704 for (ref = ref_map; ref; ref = ref->next) {
705 int rlen, llen = 0, len;
707 if (ref->status == REF_STATUS_REJECT_SHALLOW ||
708 !ref->peer_ref ||
709 !strcmp(ref->name, "HEAD"))
710 continue;
712 /* uptodate lines are only shown on high verbosity level */
713 if (verbosity <= 0 && oideq(&ref->peer_ref->old_oid, &ref->old_oid))
714 continue;
716 rlen = utf8_strwidth(prettify_refname(ref->name));
717 if (!compact_format)
718 llen = utf8_strwidth(prettify_refname(ref->peer_ref->name));
721 * rough estimation to see if the output line is too long and
722 * should not be counted (we can't do precise calculation
723 * anyway because we don't know if the error explanation part
724 * will be printed in update_local_ref)
726 len = 21 /* flag and summary */ + rlen + 4 /* -> */ + llen;
727 if (len >= max)
728 continue;
730 if (width < rlen)
731 width = rlen;
734 return width;
737 static void display_state_init(struct display_state *display_state, struct ref *ref_map,
738 const char *raw_url, enum display_format format)
740 int i;
742 memset(display_state, 0, sizeof(*display_state));
743 strbuf_init(&display_state->buf, 0);
744 display_state->format = format;
746 if (raw_url)
747 display_state->url = transport_anonymize_url(raw_url);
748 else
749 display_state->url = xstrdup("foreign");
751 display_state->url_len = strlen(display_state->url);
752 for (i = display_state->url_len - 1; display_state->url[i] == '/' && 0 <= i; i--)
754 display_state->url_len = i + 1;
755 if (4 < i && !strncmp(".git", display_state->url + i - 3, 4))
756 display_state->url_len = i - 3;
758 if (verbosity < 0)
759 return;
761 switch (display_state->format) {
762 case DISPLAY_FORMAT_FULL:
763 case DISPLAY_FORMAT_COMPACT:
764 display_state->refcol_width = refcol_width(ref_map,
765 display_state->format == DISPLAY_FORMAT_COMPACT);
766 break;
767 case DISPLAY_FORMAT_PORCELAIN:
768 /* We don't need to precompute anything here. */
769 break;
770 default:
771 BUG("unexpected display format %d", display_state->format);
775 static void display_state_release(struct display_state *display_state)
777 strbuf_release(&display_state->buf);
778 free(display_state->url);
781 static void print_remote_to_local(struct display_state *display_state,
782 const char *remote, const char *local)
784 strbuf_addf(&display_state->buf, "%-*s -> %s",
785 display_state->refcol_width, remote, local);
788 static int find_and_replace(struct strbuf *haystack,
789 const char *needle,
790 const char *placeholder)
792 const char *p = NULL;
793 int plen, nlen;
795 nlen = strlen(needle);
796 if (ends_with(haystack->buf, needle))
797 p = haystack->buf + haystack->len - nlen;
798 else
799 p = strstr(haystack->buf, needle);
800 if (!p)
801 return 0;
803 if (p > haystack->buf && p[-1] != '/')
804 return 0;
806 plen = strlen(p);
807 if (plen > nlen && p[nlen] != '/')
808 return 0;
810 strbuf_splice(haystack, p - haystack->buf, nlen,
811 placeholder, strlen(placeholder));
812 return 1;
815 static void print_compact(struct display_state *display_state,
816 const char *remote, const char *local)
818 struct strbuf r = STRBUF_INIT;
819 struct strbuf l = STRBUF_INIT;
821 if (!strcmp(remote, local)) {
822 strbuf_addf(&display_state->buf, "%-*s -> *", display_state->refcol_width, remote);
823 return;
826 strbuf_addstr(&r, remote);
827 strbuf_addstr(&l, local);
829 if (!find_and_replace(&r, local, "*"))
830 find_and_replace(&l, remote, "*");
831 print_remote_to_local(display_state, r.buf, l.buf);
833 strbuf_release(&r);
834 strbuf_release(&l);
837 static void display_ref_update(struct display_state *display_state, char code,
838 const char *summary, const char *error,
839 const char *remote, const char *local,
840 const struct object_id *old_oid,
841 const struct object_id *new_oid,
842 int summary_width)
844 FILE *f = stderr;
846 if (verbosity < 0)
847 return;
849 strbuf_reset(&display_state->buf);
851 switch (display_state->format) {
852 case DISPLAY_FORMAT_FULL:
853 case DISPLAY_FORMAT_COMPACT: {
854 int width;
856 if (!display_state->shown_url) {
857 strbuf_addf(&display_state->buf, _("From %.*s\n"),
858 display_state->url_len, display_state->url);
859 display_state->shown_url = 1;
862 width = (summary_width + strlen(summary) - gettext_width(summary));
863 remote = prettify_refname(remote);
864 local = prettify_refname(local);
866 strbuf_addf(&display_state->buf, " %c %-*s ", code, width, summary);
868 if (display_state->format != DISPLAY_FORMAT_COMPACT)
869 print_remote_to_local(display_state, remote, local);
870 else
871 print_compact(display_state, remote, local);
873 if (error)
874 strbuf_addf(&display_state->buf, " (%s)", error);
876 break;
878 case DISPLAY_FORMAT_PORCELAIN:
879 strbuf_addf(&display_state->buf, "%c %s %s %s", code,
880 oid_to_hex(old_oid), oid_to_hex(new_oid), local);
881 f = stdout;
882 break;
883 default:
884 BUG("unexpected display format %d", display_state->format);
886 strbuf_addch(&display_state->buf, '\n');
888 fputs(display_state->buf.buf, f);
891 static int update_local_ref(struct ref *ref,
892 struct ref_transaction *transaction,
893 struct display_state *display_state,
894 const struct ref *remote_ref,
895 int summary_width,
896 const struct fetch_config *config)
898 struct commit *current = NULL, *updated;
899 int fast_forward = 0;
901 if (!repo_has_object_file(the_repository, &ref->new_oid))
902 die(_("object %s not found"), oid_to_hex(&ref->new_oid));
904 if (oideq(&ref->old_oid, &ref->new_oid)) {
905 if (verbosity > 0)
906 display_ref_update(display_state, '=', _("[up to date]"), NULL,
907 remote_ref->name, ref->name,
908 &ref->old_oid, &ref->new_oid, summary_width);
909 return 0;
912 if (!update_head_ok &&
913 !is_null_oid(&ref->old_oid) &&
914 branch_checked_out(ref->name)) {
916 * If this is the head, and it's not okay to update
917 * the head, and the old value of the head isn't empty...
919 display_ref_update(display_state, '!', _("[rejected]"),
920 _("can't fetch into checked-out branch"),
921 remote_ref->name, ref->name,
922 &ref->old_oid, &ref->new_oid, summary_width);
923 return 1;
926 if (!is_null_oid(&ref->old_oid) &&
927 starts_with(ref->name, "refs/tags/")) {
928 if (force || ref->force) {
929 int r;
930 r = s_update_ref("updating tag", ref, transaction, 0);
931 display_ref_update(display_state, r ? '!' : 't', _("[tag update]"),
932 r ? _("unable to update local ref") : NULL,
933 remote_ref->name, ref->name,
934 &ref->old_oid, &ref->new_oid, summary_width);
935 return r;
936 } else {
937 display_ref_update(display_state, '!', _("[rejected]"),
938 _("would clobber existing tag"),
939 remote_ref->name, ref->name,
940 &ref->old_oid, &ref->new_oid, summary_width);
941 return 1;
945 current = lookup_commit_reference_gently(the_repository,
946 &ref->old_oid, 1);
947 updated = lookup_commit_reference_gently(the_repository,
948 &ref->new_oid, 1);
949 if (!current || !updated) {
950 const char *msg;
951 const char *what;
952 int r;
954 * Nicely describe the new ref we're fetching.
955 * Base this on the remote's ref name, as it's
956 * more likely to follow a standard layout.
958 if (starts_with(remote_ref->name, "refs/tags/")) {
959 msg = "storing tag";
960 what = _("[new tag]");
961 } else if (starts_with(remote_ref->name, "refs/heads/")) {
962 msg = "storing head";
963 what = _("[new branch]");
964 } else {
965 msg = "storing ref";
966 what = _("[new ref]");
969 r = s_update_ref(msg, ref, transaction, 0);
970 display_ref_update(display_state, r ? '!' : '*', what,
971 r ? _("unable to update local ref") : NULL,
972 remote_ref->name, ref->name,
973 &ref->old_oid, &ref->new_oid, summary_width);
974 return r;
977 if (config->show_forced_updates) {
978 uint64_t t_before = getnanotime();
979 fast_forward = repo_in_merge_bases(the_repository, current,
980 updated);
981 forced_updates_ms += (getnanotime() - t_before) / 1000000;
982 } else {
983 fast_forward = 1;
986 if (fast_forward) {
987 struct strbuf quickref = STRBUF_INIT;
988 int r;
990 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
991 strbuf_addstr(&quickref, "..");
992 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
993 r = s_update_ref("fast-forward", ref, transaction, 1);
994 display_ref_update(display_state, r ? '!' : ' ', quickref.buf,
995 r ? _("unable to update local ref") : NULL,
996 remote_ref->name, ref->name,
997 &ref->old_oid, &ref->new_oid, summary_width);
998 strbuf_release(&quickref);
999 return r;
1000 } else if (force || ref->force) {
1001 struct strbuf quickref = STRBUF_INIT;
1002 int r;
1003 strbuf_add_unique_abbrev(&quickref, &current->object.oid, DEFAULT_ABBREV);
1004 strbuf_addstr(&quickref, "...");
1005 strbuf_add_unique_abbrev(&quickref, &ref->new_oid, DEFAULT_ABBREV);
1006 r = s_update_ref("forced-update", ref, transaction, 1);
1007 display_ref_update(display_state, r ? '!' : '+', quickref.buf,
1008 r ? _("unable to update local ref") : _("forced update"),
1009 remote_ref->name, ref->name,
1010 &ref->old_oid, &ref->new_oid, summary_width);
1011 strbuf_release(&quickref);
1012 return r;
1013 } else {
1014 display_ref_update(display_state, '!', _("[rejected]"), _("non-fast-forward"),
1015 remote_ref->name, ref->name,
1016 &ref->old_oid, &ref->new_oid, summary_width);
1017 return 1;
1021 static const struct object_id *iterate_ref_map(void *cb_data)
1023 struct ref **rm = cb_data;
1024 struct ref *ref = *rm;
1026 while (ref && ref->status == REF_STATUS_REJECT_SHALLOW)
1027 ref = ref->next;
1028 if (!ref)
1029 return NULL;
1030 *rm = ref->next;
1031 return &ref->old_oid;
1034 struct fetch_head {
1035 FILE *fp;
1036 struct strbuf buf;
1039 static int open_fetch_head(struct fetch_head *fetch_head)
1041 const char *filename = git_path_fetch_head(the_repository);
1043 if (write_fetch_head) {
1044 fetch_head->fp = fopen(filename, "a");
1045 if (!fetch_head->fp)
1046 return error_errno(_("cannot open '%s'"), filename);
1047 strbuf_init(&fetch_head->buf, 0);
1048 } else {
1049 fetch_head->fp = NULL;
1052 return 0;
1055 static void append_fetch_head(struct fetch_head *fetch_head,
1056 const struct object_id *old_oid,
1057 enum fetch_head_status fetch_head_status,
1058 const char *note,
1059 const char *url, size_t url_len)
1061 char old_oid_hex[GIT_MAX_HEXSZ + 1];
1062 const char *merge_status_marker;
1063 size_t i;
1065 if (!fetch_head->fp)
1066 return;
1068 switch (fetch_head_status) {
1069 case FETCH_HEAD_NOT_FOR_MERGE:
1070 merge_status_marker = "not-for-merge";
1071 break;
1072 case FETCH_HEAD_MERGE:
1073 merge_status_marker = "";
1074 break;
1075 default:
1076 /* do not write anything to FETCH_HEAD */
1077 return;
1080 strbuf_addf(&fetch_head->buf, "%s\t%s\t%s",
1081 oid_to_hex_r(old_oid_hex, old_oid), merge_status_marker, note);
1082 for (i = 0; i < url_len; ++i)
1083 if ('\n' == url[i])
1084 strbuf_addstr(&fetch_head->buf, "\\n");
1085 else
1086 strbuf_addch(&fetch_head->buf, url[i]);
1087 strbuf_addch(&fetch_head->buf, '\n');
1090 * When using an atomic fetch, we do not want to update FETCH_HEAD if
1091 * any of the reference updates fails. We thus have to write all
1092 * updates to a buffer first and only commit it as soon as all
1093 * references have been successfully updated.
1095 if (!atomic_fetch) {
1096 strbuf_write(&fetch_head->buf, fetch_head->fp);
1097 strbuf_reset(&fetch_head->buf);
1101 static void commit_fetch_head(struct fetch_head *fetch_head)
1103 if (!fetch_head->fp || !atomic_fetch)
1104 return;
1105 strbuf_write(&fetch_head->buf, fetch_head->fp);
1108 static void close_fetch_head(struct fetch_head *fetch_head)
1110 if (!fetch_head->fp)
1111 return;
1113 fclose(fetch_head->fp);
1114 strbuf_release(&fetch_head->buf);
1117 static const char warn_show_forced_updates[] =
1118 N_("fetch normally indicates which branches had a forced update,\n"
1119 "but that check has been disabled; to re-enable, use '--show-forced-updates'\n"
1120 "flag or run 'git config fetch.showForcedUpdates true'");
1121 static const char warn_time_show_forced_updates[] =
1122 N_("it took %.2f seconds to check forced updates; you can use\n"
1123 "'--no-show-forced-updates' or run 'git config fetch.showForcedUpdates false'\n"
1124 "to avoid this check\n");
1126 static int store_updated_refs(struct display_state *display_state,
1127 const char *remote_name,
1128 int connectivity_checked,
1129 struct ref_transaction *transaction, struct ref *ref_map,
1130 struct fetch_head *fetch_head,
1131 const struct fetch_config *config)
1133 int rc = 0;
1134 struct strbuf note = STRBUF_INIT;
1135 const char *what, *kind;
1136 struct ref *rm;
1137 int want_status;
1138 int summary_width = 0;
1140 if (verbosity >= 0)
1141 summary_width = transport_summary_width(ref_map);
1143 if (!connectivity_checked) {
1144 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1146 opt.exclude_hidden_refs_section = "fetch";
1147 rm = ref_map;
1148 if (check_connected(iterate_ref_map, &rm, &opt)) {
1149 rc = error(_("%s did not send all necessary objects\n"),
1150 display_state->url);
1151 goto abort;
1156 * We do a pass for each fetch_head_status type in their enum order, so
1157 * merged entries are written before not-for-merge. That lets readers
1158 * use FETCH_HEAD as a refname to refer to the ref to be merged.
1160 for (want_status = FETCH_HEAD_MERGE;
1161 want_status <= FETCH_HEAD_IGNORE;
1162 want_status++) {
1163 for (rm = ref_map; rm; rm = rm->next) {
1164 struct ref *ref = NULL;
1166 if (rm->status == REF_STATUS_REJECT_SHALLOW) {
1167 if (want_status == FETCH_HEAD_MERGE)
1168 warning(_("rejected %s because shallow roots are not allowed to be updated"),
1169 rm->peer_ref ? rm->peer_ref->name : rm->name);
1170 continue;
1174 * When writing FETCH_HEAD we need to determine whether
1175 * we already have the commit or not. If not, then the
1176 * reference is not for merge and needs to be written
1177 * to the reflog after other commits which we already
1178 * have. We're not interested in this property though
1179 * in case FETCH_HEAD is not to be updated, so we can
1180 * skip the classification in that case.
1182 if (fetch_head->fp) {
1183 struct commit *commit = NULL;
1186 * References in "refs/tags/" are often going to point
1187 * to annotated tags, which are not part of the
1188 * commit-graph. We thus only try to look up refs in
1189 * the graph which are not in that namespace to not
1190 * regress performance in repositories with many
1191 * annotated tags.
1193 if (!starts_with(rm->name, "refs/tags/"))
1194 commit = lookup_commit_in_graph(the_repository, &rm->old_oid);
1195 if (!commit) {
1196 commit = lookup_commit_reference_gently(the_repository,
1197 &rm->old_oid,
1199 if (!commit)
1200 rm->fetch_head_status = FETCH_HEAD_NOT_FOR_MERGE;
1204 if (rm->fetch_head_status != want_status)
1205 continue;
1207 if (rm->peer_ref) {
1208 ref = alloc_ref(rm->peer_ref->name);
1209 oidcpy(&ref->old_oid, &rm->peer_ref->old_oid);
1210 oidcpy(&ref->new_oid, &rm->old_oid);
1211 ref->force = rm->peer_ref->force;
1214 if (config->recurse_submodules != RECURSE_SUBMODULES_OFF &&
1215 (!rm->peer_ref || !oideq(&ref->old_oid, &ref->new_oid))) {
1216 check_for_new_submodule_commits(&rm->old_oid);
1219 if (!strcmp(rm->name, "HEAD")) {
1220 kind = "";
1221 what = "";
1222 } else if (skip_prefix(rm->name, "refs/heads/", &what)) {
1223 kind = "branch";
1224 } else if (skip_prefix(rm->name, "refs/tags/", &what)) {
1225 kind = "tag";
1226 } else if (skip_prefix(rm->name, "refs/remotes/", &what)) {
1227 kind = "remote-tracking branch";
1228 } else {
1229 kind = "";
1230 what = rm->name;
1233 strbuf_reset(&note);
1234 if (*what) {
1235 if (*kind)
1236 strbuf_addf(&note, "%s ", kind);
1237 strbuf_addf(&note, "'%s' of ", what);
1240 append_fetch_head(fetch_head, &rm->old_oid,
1241 rm->fetch_head_status,
1242 note.buf, display_state->url,
1243 display_state->url_len);
1245 if (ref) {
1246 rc |= update_local_ref(ref, transaction, display_state,
1247 rm, summary_width, config);
1248 free(ref);
1249 } else if (write_fetch_head || dry_run) {
1251 * Display fetches written to FETCH_HEAD (or
1252 * would be written to FETCH_HEAD, if --dry-run
1253 * is set).
1255 display_ref_update(display_state, '*',
1256 *kind ? kind : "branch", NULL,
1257 rm->name,
1258 "FETCH_HEAD",
1259 &rm->new_oid, &rm->old_oid,
1260 summary_width);
1265 if (rc & STORE_REF_ERROR_DF_CONFLICT)
1266 error(_("some local refs could not be updated; try running\n"
1267 " 'git remote prune %s' to remove any old, conflicting "
1268 "branches"), remote_name);
1270 if (advice_enabled(ADVICE_FETCH_SHOW_FORCED_UPDATES)) {
1271 if (!config->show_forced_updates) {
1272 warning(_(warn_show_forced_updates));
1273 } else if (forced_updates_ms > FORCED_UPDATES_DELAY_WARNING_IN_MS) {
1274 warning(_(warn_time_show_forced_updates),
1275 forced_updates_ms / 1000.0);
1279 abort:
1280 strbuf_release(&note);
1281 return rc;
1285 * We would want to bypass the object transfer altogether if
1286 * everything we are going to fetch already exists and is connected
1287 * locally.
1289 static int check_exist_and_connected(struct ref *ref_map)
1291 struct ref *rm = ref_map;
1292 struct check_connected_options opt = CHECK_CONNECTED_INIT;
1293 struct ref *r;
1296 * If we are deepening a shallow clone we already have these
1297 * objects reachable. Running rev-list here will return with
1298 * a good (0) exit status and we'll bypass the fetch that we
1299 * really need to perform. Claiming failure now will ensure
1300 * we perform the network exchange to deepen our history.
1302 if (deepen)
1303 return -1;
1306 * Similarly, if we need to refetch, we always want to perform a full
1307 * fetch ignoring existing objects.
1309 if (refetch)
1310 return -1;
1314 * check_connected() allows objects to merely be promised, but
1315 * we need all direct targets to exist.
1317 for (r = rm; r; r = r->next) {
1318 if (!repo_has_object_file_with_flags(the_repository, &r->old_oid,
1319 OBJECT_INFO_SKIP_FETCH_OBJECT))
1320 return -1;
1323 opt.quiet = 1;
1324 opt.exclude_hidden_refs_section = "fetch";
1325 return check_connected(iterate_ref_map, &rm, &opt);
1328 static int fetch_and_consume_refs(struct display_state *display_state,
1329 struct transport *transport,
1330 struct ref_transaction *transaction,
1331 struct ref *ref_map,
1332 struct fetch_head *fetch_head,
1333 const struct fetch_config *config)
1335 int connectivity_checked = 1;
1336 int ret;
1339 * We don't need to perform a fetch in case we can already satisfy all
1340 * refs.
1342 ret = check_exist_and_connected(ref_map);
1343 if (ret) {
1344 trace2_region_enter("fetch", "fetch_refs", the_repository);
1345 ret = transport_fetch_refs(transport, ref_map);
1346 trace2_region_leave("fetch", "fetch_refs", the_repository);
1347 if (ret)
1348 goto out;
1349 connectivity_checked = transport->smart_options ?
1350 transport->smart_options->connectivity_checked : 0;
1353 trace2_region_enter("fetch", "consume_refs", the_repository);
1354 ret = store_updated_refs(display_state, transport->remote->name,
1355 connectivity_checked, transaction, ref_map,
1356 fetch_head, config);
1357 trace2_region_leave("fetch", "consume_refs", the_repository);
1359 out:
1360 transport_unlock_pack(transport, 0);
1361 return ret;
1364 static int prune_refs(struct display_state *display_state,
1365 struct refspec *rs,
1366 struct ref_transaction *transaction,
1367 struct ref *ref_map)
1369 int result = 0;
1370 struct ref *ref, *stale_refs = get_stale_heads(rs, ref_map);
1371 struct strbuf err = STRBUF_INIT;
1372 const char *dangling_msg = dry_run
1373 ? _(" (%s will become dangling)")
1374 : _(" (%s has become dangling)");
1376 if (!dry_run) {
1377 if (transaction) {
1378 for (ref = stale_refs; ref; ref = ref->next) {
1379 result = ref_transaction_delete(transaction, ref->name, NULL, 0,
1380 "fetch: prune", &err);
1381 if (result)
1382 goto cleanup;
1384 } else {
1385 struct string_list refnames = STRING_LIST_INIT_NODUP;
1387 for (ref = stale_refs; ref; ref = ref->next)
1388 string_list_append(&refnames, ref->name);
1390 result = delete_refs("fetch: prune", &refnames, 0);
1391 string_list_clear(&refnames, 0);
1395 if (verbosity >= 0) {
1396 int summary_width = transport_summary_width(stale_refs);
1398 for (ref = stale_refs; ref; ref = ref->next) {
1399 display_ref_update(display_state, '-', _("[deleted]"), NULL,
1400 _("(none)"), ref->name,
1401 &ref->new_oid, &ref->old_oid,
1402 summary_width);
1403 warn_dangling_symref(stderr, dangling_msg, ref->name);
1407 cleanup:
1408 strbuf_release(&err);
1409 free_refs(stale_refs);
1410 return result;
1413 static void check_not_current_branch(struct ref *ref_map)
1415 const char *path;
1416 for (; ref_map; ref_map = ref_map->next)
1417 if (ref_map->peer_ref &&
1418 starts_with(ref_map->peer_ref->name, "refs/heads/") &&
1419 (path = branch_checked_out(ref_map->peer_ref->name)))
1420 die(_("refusing to fetch into branch '%s' "
1421 "checked out at '%s'"),
1422 ref_map->peer_ref->name, path);
1425 static int truncate_fetch_head(void)
1427 const char *filename = git_path_fetch_head(the_repository);
1428 FILE *fp = fopen_for_writing(filename);
1430 if (!fp)
1431 return error_errno(_("cannot open '%s'"), filename);
1432 fclose(fp);
1433 return 0;
1436 static void set_option(struct transport *transport, const char *name, const char *value)
1438 int r = transport_set_option(transport, name, value);
1439 if (r < 0)
1440 die(_("option \"%s\" value \"%s\" is not valid for %s"),
1441 name, value, transport->url);
1442 if (r > 0)
1443 warning(_("option \"%s\" is ignored for %s\n"),
1444 name, transport->url);
1448 static int add_oid(const char *refname UNUSED,
1449 const struct object_id *oid,
1450 int flags UNUSED, void *cb_data)
1452 struct oid_array *oids = cb_data;
1454 oid_array_append(oids, oid);
1455 return 0;
1458 static void add_negotiation_tips(struct git_transport_options *smart_options)
1460 struct oid_array *oids = xcalloc(1, sizeof(*oids));
1461 int i;
1463 for (i = 0; i < negotiation_tip.nr; i++) {
1464 const char *s = negotiation_tip.items[i].string;
1465 int old_nr;
1466 if (!has_glob_specials(s)) {
1467 struct object_id oid;
1468 if (repo_get_oid(the_repository, s, &oid))
1469 die(_("%s is not a valid object"), s);
1470 if (!has_object(the_repository, &oid, 0))
1471 die(_("the object %s does not exist"), s);
1472 oid_array_append(oids, &oid);
1473 continue;
1475 old_nr = oids->nr;
1476 for_each_glob_ref(add_oid, s, oids);
1477 if (old_nr == oids->nr)
1478 warning("ignoring --negotiation-tip=%s because it does not match any refs",
1481 smart_options->negotiation_tips = oids;
1484 static struct transport *prepare_transport(struct remote *remote, int deepen)
1486 struct transport *transport;
1488 transport = transport_get(remote, NULL);
1489 transport_set_verbosity(transport, verbosity, progress);
1490 transport->family = family;
1491 if (upload_pack)
1492 set_option(transport, TRANS_OPT_UPLOADPACK, upload_pack);
1493 if (keep)
1494 set_option(transport, TRANS_OPT_KEEP, "yes");
1495 if (depth)
1496 set_option(transport, TRANS_OPT_DEPTH, depth);
1497 if (deepen && deepen_since)
1498 set_option(transport, TRANS_OPT_DEEPEN_SINCE, deepen_since);
1499 if (deepen && deepen_not.nr)
1500 set_option(transport, TRANS_OPT_DEEPEN_NOT,
1501 (const char *)&deepen_not);
1502 if (deepen_relative)
1503 set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, "yes");
1504 if (update_shallow)
1505 set_option(transport, TRANS_OPT_UPDATE_SHALLOW, "yes");
1506 if (refetch)
1507 set_option(transport, TRANS_OPT_REFETCH, "yes");
1508 if (filter_options.choice) {
1509 const char *spec =
1510 expand_list_objects_filter_spec(&filter_options);
1511 set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER, spec);
1512 set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1514 if (negotiation_tip.nr) {
1515 if (transport->smart_options)
1516 add_negotiation_tips(transport->smart_options);
1517 else
1518 warning("ignoring --negotiation-tip because the protocol does not support it");
1520 return transport;
1523 static int backfill_tags(struct display_state *display_state,
1524 struct transport *transport,
1525 struct ref_transaction *transaction,
1526 struct ref *ref_map,
1527 struct fetch_head *fetch_head,
1528 const struct fetch_config *config)
1530 int retcode, cannot_reuse;
1533 * Once we have set TRANS_OPT_DEEPEN_SINCE, we can't unset it
1534 * when remote helper is used (setting it to an empty string
1535 * is not unsetting). We could extend the remote helper
1536 * protocol for that, but for now, just force a new connection
1537 * without deepen-since. Similar story for deepen-not.
1539 cannot_reuse = transport->cannot_reuse ||
1540 deepen_since || deepen_not.nr;
1541 if (cannot_reuse) {
1542 gsecondary = prepare_transport(transport->remote, 0);
1543 transport = gsecondary;
1546 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, NULL);
1547 transport_set_option(transport, TRANS_OPT_DEPTH, "0");
1548 transport_set_option(transport, TRANS_OPT_DEEPEN_RELATIVE, NULL);
1549 retcode = fetch_and_consume_refs(display_state, transport, transaction, ref_map,
1550 fetch_head, config);
1552 if (gsecondary) {
1553 transport_disconnect(gsecondary);
1554 gsecondary = NULL;
1557 return retcode;
1560 static int do_fetch(struct transport *transport,
1561 struct refspec *rs,
1562 const struct fetch_config *config)
1564 struct ref_transaction *transaction = NULL;
1565 struct ref *ref_map = NULL;
1566 struct display_state display_state = { 0 };
1567 int autotags = (transport->remote->fetch_tags == 1);
1568 int retcode = 0;
1569 const struct ref *remote_refs;
1570 struct transport_ls_refs_options transport_ls_refs_options =
1571 TRANSPORT_LS_REFS_OPTIONS_INIT;
1572 int must_list_refs = 1;
1573 struct fetch_head fetch_head = { 0 };
1574 struct strbuf err = STRBUF_INIT;
1576 if (tags == TAGS_DEFAULT) {
1577 if (transport->remote->fetch_tags == 2)
1578 tags = TAGS_SET;
1579 if (transport->remote->fetch_tags == -1)
1580 tags = TAGS_UNSET;
1583 /* if not appending, truncate FETCH_HEAD */
1584 if (!append && write_fetch_head) {
1585 retcode = truncate_fetch_head();
1586 if (retcode)
1587 goto cleanup;
1590 if (rs->nr) {
1591 int i;
1593 refspec_ref_prefixes(rs, &transport_ls_refs_options.ref_prefixes);
1596 * We can avoid listing refs if all of them are exact
1597 * OIDs
1599 must_list_refs = 0;
1600 for (i = 0; i < rs->nr; i++) {
1601 if (!rs->items[i].exact_sha1) {
1602 must_list_refs = 1;
1603 break;
1606 } else {
1607 struct branch *branch = branch_get(NULL);
1609 if (transport->remote->fetch.nr)
1610 refspec_ref_prefixes(&transport->remote->fetch,
1611 &transport_ls_refs_options.ref_prefixes);
1612 if (branch_has_merge_config(branch) &&
1613 !strcmp(branch->remote_name, transport->remote->name)) {
1614 int i;
1615 for (i = 0; i < branch->merge_nr; i++) {
1616 strvec_push(&transport_ls_refs_options.ref_prefixes,
1617 branch->merge[i]->src);
1622 if (tags == TAGS_SET || tags == TAGS_DEFAULT) {
1623 must_list_refs = 1;
1624 if (transport_ls_refs_options.ref_prefixes.nr)
1625 strvec_push(&transport_ls_refs_options.ref_prefixes,
1626 "refs/tags/");
1629 if (must_list_refs) {
1630 trace2_region_enter("fetch", "remote_refs", the_repository);
1631 remote_refs = transport_get_remote_refs(transport,
1632 &transport_ls_refs_options);
1633 trace2_region_leave("fetch", "remote_refs", the_repository);
1634 } else
1635 remote_refs = NULL;
1637 transport_ls_refs_options_release(&transport_ls_refs_options);
1639 ref_map = get_ref_map(transport->remote, remote_refs, rs,
1640 tags, &autotags);
1641 if (!update_head_ok)
1642 check_not_current_branch(ref_map);
1644 retcode = open_fetch_head(&fetch_head);
1645 if (retcode)
1646 goto cleanup;
1648 display_state_init(&display_state, ref_map, transport->url,
1649 config->display_format);
1651 if (atomic_fetch) {
1652 transaction = ref_transaction_begin(&err);
1653 if (!transaction) {
1654 retcode = error("%s", err.buf);
1655 goto cleanup;
1659 if (tags == TAGS_DEFAULT && autotags)
1660 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1661 if (prune) {
1663 * We only prune based on refspecs specified
1664 * explicitly (via command line or configuration); we
1665 * don't care whether --tags was specified.
1667 if (rs->nr) {
1668 retcode = prune_refs(&display_state, rs, transaction, ref_map);
1669 } else {
1670 retcode = prune_refs(&display_state, &transport->remote->fetch,
1671 transaction, ref_map);
1673 if (retcode != 0)
1674 retcode = 1;
1677 if (fetch_and_consume_refs(&display_state, transport, transaction, ref_map,
1678 &fetch_head, config)) {
1679 retcode = 1;
1680 goto cleanup;
1684 * If neither --no-tags nor --tags was specified, do automated tag
1685 * following.
1687 if (tags == TAGS_DEFAULT && autotags) {
1688 struct ref *tags_ref_map = NULL, **tail = &tags_ref_map;
1690 find_non_local_tags(remote_refs, transaction, &tags_ref_map, &tail);
1691 if (tags_ref_map) {
1693 * If backfilling of tags fails then we want to tell
1694 * the user so, but we have to continue regardless to
1695 * populate upstream information of the references we
1696 * have already fetched above. The exception though is
1697 * when `--atomic` is passed: in that case we'll abort
1698 * the transaction and don't commit anything.
1700 if (backfill_tags(&display_state, transport, transaction, tags_ref_map,
1701 &fetch_head, config))
1702 retcode = 1;
1705 free_refs(tags_ref_map);
1708 if (transaction) {
1709 if (retcode)
1710 goto cleanup;
1712 retcode = ref_transaction_commit(transaction, &err);
1713 if (retcode) {
1714 error("%s", err.buf);
1715 ref_transaction_free(transaction);
1716 transaction = NULL;
1717 goto cleanup;
1721 commit_fetch_head(&fetch_head);
1723 if (set_upstream) {
1724 struct branch *branch = branch_get("HEAD");
1725 struct ref *rm;
1726 struct ref *source_ref = NULL;
1729 * We're setting the upstream configuration for the
1730 * current branch. The relevant upstream is the
1731 * fetched branch that is meant to be merged with the
1732 * current one, i.e. the one fetched to FETCH_HEAD.
1734 * When there are several such branches, consider the
1735 * request ambiguous and err on the safe side by doing
1736 * nothing and just emit a warning.
1738 for (rm = ref_map; rm; rm = rm->next) {
1739 if (!rm->peer_ref) {
1740 if (source_ref) {
1741 warning(_("multiple branches detected, incompatible with --set-upstream"));
1742 goto cleanup;
1743 } else {
1744 source_ref = rm;
1748 if (source_ref) {
1749 if (!branch) {
1750 const char *shortname = source_ref->name;
1751 skip_prefix(shortname, "refs/heads/", &shortname);
1753 warning(_("could not set upstream of HEAD to '%s' from '%s' when "
1754 "it does not point to any branch."),
1755 shortname, transport->remote->name);
1756 goto cleanup;
1759 if (!strcmp(source_ref->name, "HEAD") ||
1760 starts_with(source_ref->name, "refs/heads/"))
1761 install_branch_config(0,
1762 branch->name,
1763 transport->remote->name,
1764 source_ref->name);
1765 else if (starts_with(source_ref->name, "refs/remotes/"))
1766 warning(_("not setting upstream for a remote remote-tracking branch"));
1767 else if (starts_with(source_ref->name, "refs/tags/"))
1768 warning(_("not setting upstream for a remote tag"));
1769 else
1770 warning(_("unknown branch type"));
1771 } else {
1772 warning(_("no source branch found;\n"
1773 "you need to specify exactly one branch with the --set-upstream option"));
1777 cleanup:
1778 if (retcode && transaction) {
1779 ref_transaction_abort(transaction, &err);
1780 error("%s", err.buf);
1783 display_state_release(&display_state);
1784 close_fetch_head(&fetch_head);
1785 strbuf_release(&err);
1786 free_refs(ref_map);
1787 return retcode;
1790 static int get_one_remote_for_fetch(struct remote *remote, void *priv)
1792 struct string_list *list = priv;
1793 if (!remote->skip_default_update)
1794 string_list_append(list, remote->name);
1795 return 0;
1798 struct remote_group_data {
1799 const char *name;
1800 struct string_list *list;
1803 static int get_remote_group(const char *key, const char *value,
1804 const struct config_context *ctx UNUSED,
1805 void *priv)
1807 struct remote_group_data *g = priv;
1809 if (skip_prefix(key, "remotes.", &key) && !strcmp(key, g->name)) {
1810 /* split list by white space */
1811 while (*value) {
1812 size_t wordlen = strcspn(value, " \t\n");
1814 if (wordlen >= 1)
1815 string_list_append_nodup(g->list,
1816 xstrndup(value, wordlen));
1817 value += wordlen + (value[wordlen] != '\0');
1821 return 0;
1824 static int add_remote_or_group(const char *name, struct string_list *list)
1826 int prev_nr = list->nr;
1827 struct remote_group_data g;
1828 g.name = name; g.list = list;
1830 git_config(get_remote_group, &g);
1831 if (list->nr == prev_nr) {
1832 struct remote *remote = remote_get(name);
1833 if (!remote_is_configured(remote, 0))
1834 return 0;
1835 string_list_append(list, remote->name);
1837 return 1;
1840 static void add_options_to_argv(struct strvec *argv,
1841 const struct fetch_config *config)
1843 if (dry_run)
1844 strvec_push(argv, "--dry-run");
1845 if (prune != -1)
1846 strvec_push(argv, prune ? "--prune" : "--no-prune");
1847 if (prune_tags != -1)
1848 strvec_push(argv, prune_tags ? "--prune-tags" : "--no-prune-tags");
1849 if (update_head_ok)
1850 strvec_push(argv, "--update-head-ok");
1851 if (force)
1852 strvec_push(argv, "--force");
1853 if (keep)
1854 strvec_push(argv, "--keep");
1855 if (config->recurse_submodules == RECURSE_SUBMODULES_ON)
1856 strvec_push(argv, "--recurse-submodules");
1857 else if (config->recurse_submodules == RECURSE_SUBMODULES_OFF)
1858 strvec_push(argv, "--no-recurse-submodules");
1859 else if (config->recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND)
1860 strvec_push(argv, "--recurse-submodules=on-demand");
1861 if (tags == TAGS_SET)
1862 strvec_push(argv, "--tags");
1863 else if (tags == TAGS_UNSET)
1864 strvec_push(argv, "--no-tags");
1865 if (verbosity >= 2)
1866 strvec_push(argv, "-v");
1867 if (verbosity >= 1)
1868 strvec_push(argv, "-v");
1869 else if (verbosity < 0)
1870 strvec_push(argv, "-q");
1871 if (family == TRANSPORT_FAMILY_IPV4)
1872 strvec_push(argv, "--ipv4");
1873 else if (family == TRANSPORT_FAMILY_IPV6)
1874 strvec_push(argv, "--ipv6");
1875 if (!write_fetch_head)
1876 strvec_push(argv, "--no-write-fetch-head");
1877 if (config->display_format == DISPLAY_FORMAT_PORCELAIN)
1878 strvec_pushf(argv, "--porcelain");
1881 /* Fetch multiple remotes in parallel */
1883 struct parallel_fetch_state {
1884 const char **argv;
1885 struct string_list *remotes;
1886 int next, result;
1887 const struct fetch_config *config;
1890 static int fetch_next_remote(struct child_process *cp,
1891 struct strbuf *out UNUSED,
1892 void *cb, void **task_cb)
1894 struct parallel_fetch_state *state = cb;
1895 char *remote;
1897 if (state->next < 0 || state->next >= state->remotes->nr)
1898 return 0;
1900 remote = state->remotes->items[state->next++].string;
1901 *task_cb = remote;
1903 strvec_pushv(&cp->args, state->argv);
1904 strvec_push(&cp->args, remote);
1905 cp->git_cmd = 1;
1907 if (verbosity >= 0 && state->config->display_format != DISPLAY_FORMAT_PORCELAIN)
1908 printf(_("Fetching %s\n"), remote);
1910 return 1;
1913 static int fetch_failed_to_start(struct strbuf *out UNUSED,
1914 void *cb, void *task_cb)
1916 struct parallel_fetch_state *state = cb;
1917 const char *remote = task_cb;
1919 state->result = error(_("could not fetch %s"), remote);
1921 return 0;
1924 static int fetch_finished(int result, struct strbuf *out,
1925 void *cb, void *task_cb)
1927 struct parallel_fetch_state *state = cb;
1928 const char *remote = task_cb;
1930 if (result) {
1931 strbuf_addf(out, _("could not fetch '%s' (exit code: %d)\n"),
1932 remote, result);
1933 state->result = -1;
1936 return 0;
1939 static int fetch_multiple(struct string_list *list, int max_children,
1940 const struct fetch_config *config)
1942 int i, result = 0;
1943 struct strvec argv = STRVEC_INIT;
1945 if (!append && write_fetch_head) {
1946 int errcode = truncate_fetch_head();
1947 if (errcode)
1948 return errcode;
1952 * Cancel out the fetch.bundleURI config when running subprocesses,
1953 * to avoid fetching from the same bundle list multiple times.
1955 strvec_pushl(&argv, "-c", "fetch.bundleURI=",
1956 "fetch", "--append", "--no-auto-gc",
1957 "--no-write-commit-graph", NULL);
1958 add_options_to_argv(&argv, config);
1960 if (max_children != 1 && list->nr != 1) {
1961 struct parallel_fetch_state state = { argv.v, list, 0, 0, config };
1962 const struct run_process_parallel_opts opts = {
1963 .tr2_category = "fetch",
1964 .tr2_label = "parallel/fetch",
1966 .processes = max_children,
1968 .get_next_task = &fetch_next_remote,
1969 .start_failure = &fetch_failed_to_start,
1970 .task_finished = &fetch_finished,
1971 .data = &state,
1974 strvec_push(&argv, "--end-of-options");
1976 run_processes_parallel(&opts);
1977 result = state.result;
1978 } else
1979 for (i = 0; i < list->nr; i++) {
1980 const char *name = list->items[i].string;
1981 struct child_process cmd = CHILD_PROCESS_INIT;
1983 strvec_pushv(&cmd.args, argv.v);
1984 strvec_push(&cmd.args, name);
1985 if (verbosity >= 0 && config->display_format != DISPLAY_FORMAT_PORCELAIN)
1986 printf(_("Fetching %s\n"), name);
1987 cmd.git_cmd = 1;
1988 if (run_command(&cmd)) {
1989 error(_("could not fetch %s"), name);
1990 result = 1;
1994 strvec_clear(&argv);
1995 return !!result;
1999 * Fetching from the promisor remote should use the given filter-spec
2000 * or inherit the default filter-spec from the config.
2002 static inline void fetch_one_setup_partial(struct remote *remote)
2005 * Explicit --no-filter argument overrides everything, regardless
2006 * of any prior partial clones and fetches.
2008 if (filter_options.no_filter)
2009 return;
2012 * If no prior partial clone/fetch and the current fetch DID NOT
2013 * request a partial-fetch, do a normal fetch.
2015 if (!repo_has_promisor_remote(the_repository) && !filter_options.choice)
2016 return;
2019 * If this is a partial-fetch request, we enable partial on
2020 * this repo if not already enabled and remember the given
2021 * filter-spec as the default for subsequent fetches to this
2022 * remote if there is currently no default filter-spec.
2024 if (filter_options.choice) {
2025 partial_clone_register(remote->name, &filter_options);
2026 return;
2030 * Do a partial-fetch from the promisor remote using either the
2031 * explicitly given filter-spec or inherit the filter-spec from
2032 * the config.
2034 if (!filter_options.choice)
2035 partial_clone_get_default_filter_spec(&filter_options, remote->name);
2036 return;
2039 static int fetch_one(struct remote *remote, int argc, const char **argv,
2040 int prune_tags_ok, int use_stdin_refspecs,
2041 const struct fetch_config *config)
2043 struct refspec rs = REFSPEC_INIT_FETCH;
2044 int i;
2045 int exit_code;
2046 int maybe_prune_tags;
2047 int remote_via_config = remote_is_configured(remote, 0);
2049 if (!remote)
2050 die(_("no remote repository specified; please specify either a URL or a\n"
2051 "remote name from which new revisions should be fetched"));
2053 gtransport = prepare_transport(remote, 1);
2055 if (prune < 0) {
2056 /* no command line request */
2057 if (0 <= remote->prune)
2058 prune = remote->prune;
2059 else if (0 <= config->prune)
2060 prune = config->prune;
2061 else
2062 prune = PRUNE_BY_DEFAULT;
2065 if (prune_tags < 0) {
2066 /* no command line request */
2067 if (0 <= remote->prune_tags)
2068 prune_tags = remote->prune_tags;
2069 else if (0 <= config->prune_tags)
2070 prune_tags = config->prune_tags;
2071 else
2072 prune_tags = PRUNE_TAGS_BY_DEFAULT;
2075 maybe_prune_tags = prune_tags_ok && prune_tags;
2076 if (maybe_prune_tags && remote_via_config)
2077 refspec_append(&remote->fetch, TAG_REFSPEC);
2079 if (maybe_prune_tags && (argc || !remote_via_config))
2080 refspec_append(&rs, TAG_REFSPEC);
2082 for (i = 0; i < argc; i++) {
2083 if (!strcmp(argv[i], "tag")) {
2084 i++;
2085 if (i >= argc)
2086 die(_("you need to specify a tag name"));
2088 refspec_appendf(&rs, "refs/tags/%s:refs/tags/%s",
2089 argv[i], argv[i]);
2090 } else {
2091 refspec_append(&rs, argv[i]);
2095 if (use_stdin_refspecs) {
2096 struct strbuf line = STRBUF_INIT;
2097 while (strbuf_getline_lf(&line, stdin) != EOF)
2098 refspec_append(&rs, line.buf);
2099 strbuf_release(&line);
2102 if (server_options.nr)
2103 gtransport->server_options = &server_options;
2105 sigchain_push_common(unlock_pack_on_signal);
2106 atexit(unlock_pack_atexit);
2107 sigchain_push(SIGPIPE, SIG_IGN);
2108 exit_code = do_fetch(gtransport, &rs, config);
2109 sigchain_pop(SIGPIPE);
2110 refspec_clear(&rs);
2111 transport_disconnect(gtransport);
2112 gtransport = NULL;
2113 return exit_code;
2116 int cmd_fetch(int argc, const char **argv, const char *prefix)
2118 struct fetch_config config = {
2119 .display_format = DISPLAY_FORMAT_FULL,
2120 .prune = -1,
2121 .prune_tags = -1,
2122 .show_forced_updates = 1,
2123 .recurse_submodules = RECURSE_SUBMODULES_DEFAULT,
2124 .parallel = 1,
2125 .submodule_fetch_jobs = -1,
2127 const char *submodule_prefix = "";
2128 const char *bundle_uri;
2129 struct string_list list = STRING_LIST_INIT_DUP;
2130 struct remote *remote = NULL;
2131 int all = 0, multiple = 0;
2132 int result = 0;
2133 int prune_tags_ok = 1;
2134 int enable_auto_gc = 1;
2135 int unshallow = 0;
2136 int max_jobs = -1;
2137 int recurse_submodules_cli = RECURSE_SUBMODULES_DEFAULT;
2138 int recurse_submodules_default = RECURSE_SUBMODULES_ON_DEMAND;
2139 int fetch_write_commit_graph = -1;
2140 int stdin_refspecs = 0;
2141 int negotiate_only = 0;
2142 int porcelain = 0;
2143 int i;
2145 struct option builtin_fetch_options[] = {
2146 OPT__VERBOSITY(&verbosity),
2147 OPT_BOOL(0, "all", &all,
2148 N_("fetch from all remotes")),
2149 OPT_BOOL(0, "set-upstream", &set_upstream,
2150 N_("set upstream for git pull/fetch")),
2151 OPT_BOOL('a', "append", &append,
2152 N_("append to .git/FETCH_HEAD instead of overwriting")),
2153 OPT_BOOL(0, "atomic", &atomic_fetch,
2154 N_("use atomic transaction to update references")),
2155 OPT_STRING(0, "upload-pack", &upload_pack, N_("path"),
2156 N_("path to upload pack on remote end")),
2157 OPT__FORCE(&force, N_("force overwrite of local reference"), 0),
2158 OPT_BOOL('m', "multiple", &multiple,
2159 N_("fetch from multiple remotes")),
2160 OPT_SET_INT('t', "tags", &tags,
2161 N_("fetch all tags and associated objects"), TAGS_SET),
2162 OPT_SET_INT('n', NULL, &tags,
2163 N_("do not fetch all tags (--no-tags)"), TAGS_UNSET),
2164 OPT_INTEGER('j', "jobs", &max_jobs,
2165 N_("number of submodules fetched in parallel")),
2166 OPT_BOOL(0, "prefetch", &prefetch,
2167 N_("modify the refspec to place all refs within refs/prefetch/")),
2168 OPT_BOOL('p', "prune", &prune,
2169 N_("prune remote-tracking branches no longer on remote")),
2170 OPT_BOOL('P', "prune-tags", &prune_tags,
2171 N_("prune local tags no longer on remote and clobber changed tags")),
2172 OPT_CALLBACK_F(0, "recurse-submodules", &recurse_submodules_cli, N_("on-demand"),
2173 N_("control recursive fetching of submodules"),
2174 PARSE_OPT_OPTARG, option_fetch_parse_recurse_submodules),
2175 OPT_BOOL(0, "dry-run", &dry_run,
2176 N_("dry run")),
2177 OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")),
2178 OPT_BOOL(0, "write-fetch-head", &write_fetch_head,
2179 N_("write fetched references to the FETCH_HEAD file")),
2180 OPT_BOOL('k', "keep", &keep, N_("keep downloaded pack")),
2181 OPT_BOOL('u', "update-head-ok", &update_head_ok,
2182 N_("allow updating of HEAD ref")),
2183 OPT_BOOL(0, "progress", &progress, N_("force progress reporting")),
2184 OPT_STRING(0, "depth", &depth, N_("depth"),
2185 N_("deepen history of shallow clone")),
2186 OPT_STRING(0, "shallow-since", &deepen_since, N_("time"),
2187 N_("deepen history of shallow repository based on time")),
2188 OPT_STRING_LIST(0, "shallow-exclude", &deepen_not, N_("revision"),
2189 N_("deepen history of shallow clone, excluding rev")),
2190 OPT_INTEGER(0, "deepen", &deepen_relative,
2191 N_("deepen history of shallow clone")),
2192 OPT_SET_INT_F(0, "unshallow", &unshallow,
2193 N_("convert to a complete repository"),
2194 1, PARSE_OPT_NONEG),
2195 OPT_SET_INT_F(0, "refetch", &refetch,
2196 N_("re-fetch without negotiating common commits"),
2197 1, PARSE_OPT_NONEG),
2198 { OPTION_STRING, 0, "submodule-prefix", &submodule_prefix, N_("dir"),
2199 N_("prepend this to submodule path output"), PARSE_OPT_HIDDEN },
2200 OPT_CALLBACK_F(0, "recurse-submodules-default",
2201 &recurse_submodules_default, N_("on-demand"),
2202 N_("default for recursive fetching of submodules "
2203 "(lower priority than config files)"),
2204 PARSE_OPT_HIDDEN, option_fetch_parse_recurse_submodules),
2205 OPT_BOOL(0, "update-shallow", &update_shallow,
2206 N_("accept refs that update .git/shallow")),
2207 OPT_CALLBACK_F(0, "refmap", &refmap, N_("refmap"),
2208 N_("specify fetch refmap"), PARSE_OPT_NONEG, parse_refmap_arg),
2209 OPT_STRING_LIST('o', "server-option", &server_options, N_("server-specific"), N_("option to transmit")),
2210 OPT_IPVERSION(&family),
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;