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