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