fetch: add a --prune-tags option and fetch.pruneTags config
[git/git.git] / remote.h
CommitLineData
5751f490
DB
1#ifndef REMOTE_H
2#define REMOTE_H
3
28f5d176 4#include "parse-options.h"
d0da003d 5#include "hashmap.h"
28f5d176 6
89cf4c70 7enum {
674468b3 8 REMOTE_UNCONFIGURED = 0,
89cf4c70
MV
9 REMOTE_CONFIG,
10 REMOTE_REMOTES,
11 REMOTE_BRANCHES
12};
13
5751f490 14struct remote {
d0da003d
PR
15 struct hashmap_entry ent; /* must be first */
16
5751f490 17 const char *name;
e459b073 18 int origin, configured_in_repo;
5751f490 19
c578f51d
DB
20 const char *foreign_vcs;
21
28b91f8a
SP
22 const char **url;
23 int url_nr;
2d31347b 24 int url_alloc;
5751f490 25
20346234
MG
26 const char **pushurl;
27 int pushurl_nr;
28 int pushurl_alloc;
29
5751f490 30 const char **push_refspec;
6b62816c 31 struct refspec *push;
5751f490 32 int push_refspec_nr;
2d31347b 33 int push_refspec_alloc;
5751f490 34
5d46c9d4
DB
35 const char **fetch_refspec;
36 struct refspec *fetch;
37 int fetch_refspec_nr;
2d31347b 38 int fetch_refspec_alloc;
5d46c9d4 39
d71ab174
DB
40 /*
41 * -1 to never fetch tags
42 * 0 to auto-follow tags on heuristic (default)
43 * 1 to always auto-follow tags
44 * 2 to always fetch tags
45 */
46 int fetch_tags;
211c8968 47 int skip_default_update;
84bb2dfd 48 int mirror;
737c5a9c 49 int prune;
97716d21 50 int prune_tags;
d71ab174 51
5751f490 52 const char *receivepack;
0012ba21 53 const char *uploadpack;
14c98218
SV
54
55 /*
56 * for curl remotes only
57 */
58 char *http_proxy;
ef976395 59 char *http_proxy_authmethod;
5751f490
DB
60};
61
62struct remote *remote_get(const char *name);
f24f715e 63struct remote *pushremote_get(const char *name);
e459b073 64int remote_is_configured(struct remote *remote, int in_repo);
5751f490 65
b42f6927
JS
66typedef int each_remote_fn(struct remote *remote, void *priv);
67int for_each_remote(each_remote_fn fn, void *priv);
68
28b91f8a 69int remote_has_url(struct remote *remote, const char *url);
5d46c9d4 70
6b62816c
DB
71struct refspec {
72 unsigned force : 1;
73 unsigned pattern : 1;
a83619d6 74 unsigned matching : 1;
6e7b66ee 75 unsigned exact_sha1 : 1;
6b62816c 76
b42f6927 77 char *src;
6b62816c
DB
78 char *dst;
79};
80
e0aaa29f
DB
81extern const struct refspec *tag_refspec;
82
47a59185
JH
83struct ref {
84 struct ref *next;
f4e54d02 85 struct object_id old_oid;
86 struct object_id new_oid;
87 struct object_id old_oid_expect; /* used by expect-old */
47a59185
JH
88 char *symref;
89 unsigned int
90 force:1,
91 forced_update:1,
91048a95 92 expect_old_sha1:1,
d56583de
MM
93 deletion:1;
94
95 enum {
96 REF_NOT_MATCHED = 0, /* initial value */
97 REF_MATCHED,
98 REF_UNADVERTISED_NOT_ALLOWED
99 } match_status;
47a59185
JH
100
101 /*
102 * Order is important here, as we write to FETCH_HEAD
103 * in numeric order. And the default NOT_FOR_MERGE
104 * should be 0, so that xcalloc'd structures get it
105 * by default.
106 */
107 enum {
108 FETCH_HEAD_MERGE = -1,
109 FETCH_HEAD_NOT_FOR_MERGE = 0,
110 FETCH_HEAD_IGNORE = 1
111 } fetch_head_status;
112
113 enum {
114 REF_STATUS_NONE = 0,
115 REF_STATUS_OK,
116 REF_STATUS_REJECT_NONFASTFORWARD,
117 REF_STATUS_REJECT_ALREADY_EXISTS,
118 REF_STATUS_REJECT_NODELETE,
119 REF_STATUS_REJECT_FETCH_FIRST,
120 REF_STATUS_REJECT_NEEDS_FORCE,
631b5ef2 121 REF_STATUS_REJECT_STALE,
4820a33b 122 REF_STATUS_REJECT_SHALLOW,
47a59185
JH
123 REF_STATUS_UPTODATE,
124 REF_STATUS_REMOTE_REJECT,
4ff17f10
RS
125 REF_STATUS_EXPECTING_REPORT,
126 REF_STATUS_ATOMIC_PUSH_FAILED
47a59185
JH
127 } status;
128 char *remote_status;
129 struct ref *peer_ref; /* when renaming */
130 char name[FLEX_ARRAY]; /* more */
131};
132
133#define REF_NORMAL (1u << 0)
134#define REF_HEADS (1u << 1)
135#define REF_TAGS (1u << 2)
136
137extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
138
59c69c0c 139struct ref *alloc_ref(const char *name);
59a57757 140struct ref *copy_ref(const struct ref *ref);
4577370e 141struct ref *copy_ref_list(const struct ref *ref);
ed81c76b 142void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
ca02465b 143extern int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
ed81c76b 144int ref_compare_name(const void *, const void *);
4577370e
DB
145
146int check_ref_type(const struct ref *ref, int flags);
147
dfd255dd
DB
148/*
149 * Frees the entire list and peers of elements.
150 */
151void free_refs(struct ref *ref);
152
910650d2 153struct oid_array;
47a59185
JH
154extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
155 struct ref **list, unsigned int flags,
910650d2 156 struct oid_array *extra_have,
157 struct oid_array *shallow);
47a59185 158
be885d96 159int resolve_remote_symref(struct ref *ref, struct ref *list);
6f3d57b6 160int ref_newer(const struct object_id *new_oid, const struct object_id *old_oid);
be885d96 161
2467a4fa 162/*
b9afe665
MH
163 * Remove and free all but the first of any entries in the input list
164 * that map the same remote reference to the same local reference. If
165 * there are two entries that map different remote references to the
166 * same local reference, emit an error message and die. Return a
167 * pointer to the head of the resulting list.
2467a4fa 168 */
b9afe665 169struct ref *ref_remove_duplicates(struct ref *ref_map);
2467a4fa 170
24b6177e 171int valid_fetch_refspec(const char *refspec);
46220ca1 172struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
c19ae47a 173extern struct refspec *parse_push_refspec(int nr_refspec, const char **refspec);
d71ab174 174
72ff8943
DB
175void free_refspec(int nr_refspec, struct refspec *refspec);
176
ca02465b 177extern int query_refspecs(struct refspec *specs, int nr, struct refspec *query);
72ff8943
DB
178char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
179 const char *name);
180
ba928c13 181int check_push_refs(struct ref *src, int nr_refspec, const char **refspec);
29753cdd
JH
182int match_push_refs(struct ref *src, struct ref **dst,
183 int nr_refspec, const char **refspec, int all);
20e8b465
TRC
184void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
185 int force_update);
6b62816c 186
d71ab174
DB
187/*
188 * Given a list of the remote refs and the specification of things to
189 * fetch, makes a (separate) list of the refs to fetch and the local
190 * refs to store into.
191 *
192 * *tail is the pointer to the tail pointer of the list of results
193 * beforehand, and will be set to the tail pointer of the list of
194 * results afterward.
9ad7c5ae
JH
195 *
196 * missing_ok is usually false, but when we are adding branch.$name.merge
197 * it is Ok if the branch is not at the remote anymore.
d71ab174 198 */
4577370e 199int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
9ad7c5ae 200 struct ref ***tail, int missing_ok);
d71ab174 201
4577370e 202struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
d71ab174 203
5d46c9d4
DB
204/*
205 * For the given remote, reads the refspec's src and sets the other fields.
206 */
207int remote_find_tracking(struct remote *remote, struct refspec *refspec);
208
cf818348
DB
209struct branch {
210 const char *name;
211 const char *refname;
212
213 const char *remote_name;
da66b274 214 const char *pushremote_name;
cf818348
DB
215
216 const char **merge_name;
217 struct refspec **merge;
218 int merge_nr;
2d31347b 219 int merge_alloc;
e291c75a
JK
220
221 const char *push_tracking_ref;
cf818348
DB
222};
223
224struct branch *branch_get(const char *name);
f052154d 225const char *remote_for_branch(struct branch *branch, int *explicit);
da66b274 226const char *pushremote_for_branch(struct branch *branch, int *explicit);
9700fae5
W
227const char *remote_ref_for_branch(struct branch *branch, int for_push,
228 int *explicit);
cf818348
DB
229
230int branch_has_merge_config(struct branch *branch);
85682c19 231int branch_merge_matches(struct branch *, int n, const char *);
cf818348 232
a9f9f8cc
JK
233/**
234 * Return the fully-qualified refname of the tracking branch for `branch`.
235 * I.e., what "branch@{upstream}" would give you. Returns NULL if no
236 * upstream is defined.
3a429d0a
JK
237 *
238 * If `err` is not NULL and no upstream is defined, a more specific error
239 * message is recorded there (if the function does not return NULL, then
240 * `err` is not touched).
a9f9f8cc 241 */
3a429d0a 242const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
a9f9f8cc 243
e291c75a
JK
244/**
245 * Return the tracking branch that corresponds to the ref we would push to
246 * given a bare `git push` while `branch` is checked out.
247 *
248 * The return value and `err` conventions match those of `branch_get_upstream`.
249 */
250const char *branch_get_push(struct branch *branch, struct strbuf *err);
251
28b9d6e5
AW
252/* Flags to match_refs. */
253enum match_refs_flags {
254 MATCH_REFS_NONE = 0,
255 MATCH_REFS_ALL = (1 << 0),
6ddba5e2 256 MATCH_REFS_MIRROR = (1 << 1),
c2aba155
JH
257 MATCH_REFS_PRUNE = (1 << 2),
258 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
28b9d6e5
AW
259};
260
6d21bf96 261/* Reporting of tracking info */
979cb245
JK
262int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
263 const char **upstream_name);
6d21bf96
JH
264int format_tracking_info(struct branch *branch, struct strbuf *sb);
265
454e2025 266struct ref *get_local_heads(void);
8ef51733 267/*
4229f1fa
JS
268 * Find refs from a list which are likely to be pointed to by the given HEAD
269 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
270 * list of all candidate refs. If no match is found (or 'head' is NULL),
271 * returns NULL. All returns are newly allocated and should be freed.
8ef51733 272 */
4229f1fa
JS
273struct ref *guess_remote_head(const struct ref *head,
274 const struct ref *refs,
275 int all);
276
f2ef6075 277/* Return refs which no longer exist on remote */
ed43de6e 278struct ref *get_stale_heads(struct refspec *refs, int ref_count, struct ref *fetch_map);
f2ef6075 279
28f5d176
JH
280/*
281 * Compare-and-swap
282 */
283#define CAS_OPT_NAME "force-with-lease"
284
285struct push_cas_option {
286 unsigned use_tracking_for_rest:1;
287 struct push_cas {
b8566f8f 288 struct object_id expect;
28f5d176
JH
289 unsigned use_tracking:1;
290 char *refname;
291 } *entry;
292 int nr;
293 int alloc;
294};
295
296extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
28f5d176 297
91048a95
JH
298extern int is_empty_cas(const struct push_cas_option *);
299void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
300
750d0da9
ÆAB
301#define TAG_REFSPEC "refs/tags/*:refs/tags/*"
302
97716d21
ÆAB
303void add_prune_tags_to_fetch_refspec(struct remote *remote);
304
5751f490 305#endif