git.1: switch homepage for stats
[git.git] / remote.h
blob917d383a80ddbfa377f10c3d1a4e132336065c2c
1 #ifndef REMOTE_H
2 #define REMOTE_H
4 #include "parse-options.h"
6 enum {
7 REMOTE_CONFIG,
8 REMOTE_REMOTES,
9 REMOTE_BRANCHES
12 struct remote {
13 const char *name;
14 int origin;
16 const char *foreign_vcs;
18 const char **url;
19 int url_nr;
20 int url_alloc;
22 const char **pushurl;
23 int pushurl_nr;
24 int pushurl_alloc;
26 const char **push_refspec;
27 struct refspec *push;
28 int push_refspec_nr;
29 int push_refspec_alloc;
31 const char **fetch_refspec;
32 struct refspec *fetch;
33 int fetch_refspec_nr;
34 int fetch_refspec_alloc;
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
42 int fetch_tags;
43 int skip_default_update;
44 int mirror;
45 int prune;
47 const char *receivepack;
48 const char *uploadpack;
51 * for curl remotes only
53 char *http_proxy;
56 struct remote *remote_get(const char *name);
57 struct remote *pushremote_get(const char *name);
58 int remote_is_configured(const char *name);
60 typedef int each_remote_fn(struct remote *remote, void *priv);
61 int for_each_remote(each_remote_fn fn, void *priv);
63 int remote_has_url(struct remote *remote, const char *url);
65 struct refspec {
66 unsigned force : 1;
67 unsigned pattern : 1;
68 unsigned matching : 1;
69 unsigned exact_sha1 : 1;
71 char *src;
72 char *dst;
75 extern const struct refspec *tag_refspec;
77 struct ref {
78 struct ref *next;
79 unsigned char old_sha1[20];
80 unsigned char new_sha1[20];
81 unsigned char old_sha1_expect[20]; /* used by expect-old */
82 char *symref;
83 unsigned int
84 force:1,
85 forced_update:1,
86 expect_old_sha1:1,
87 expect_old_no_trackback:1,
88 deletion:1,
89 matched:1;
92 * Order is important here, as we write to FETCH_HEAD
93 * in numeric order. And the default NOT_FOR_MERGE
94 * should be 0, so that xcalloc'd structures get it
95 * by default.
97 enum {
98 FETCH_HEAD_MERGE = -1,
99 FETCH_HEAD_NOT_FOR_MERGE = 0,
100 FETCH_HEAD_IGNORE = 1
101 } fetch_head_status;
103 enum {
104 REF_STATUS_NONE = 0,
105 REF_STATUS_OK,
106 REF_STATUS_REJECT_NONFASTFORWARD,
107 REF_STATUS_REJECT_ALREADY_EXISTS,
108 REF_STATUS_REJECT_NODELETE,
109 REF_STATUS_REJECT_FETCH_FIRST,
110 REF_STATUS_REJECT_NEEDS_FORCE,
111 REF_STATUS_REJECT_STALE,
112 REF_STATUS_REJECT_SHALLOW,
113 REF_STATUS_UPTODATE,
114 REF_STATUS_REMOTE_REJECT,
115 REF_STATUS_EXPECTING_REPORT
116 } status;
117 char *remote_status;
118 struct ref *peer_ref; /* when renaming */
119 char name[FLEX_ARRAY]; /* more */
122 #define REF_NORMAL (1u << 0)
123 #define REF_HEADS (1u << 1)
124 #define REF_TAGS (1u << 2)
126 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
128 struct ref *alloc_ref(const char *name);
129 struct ref *copy_ref(const struct ref *ref);
130 struct ref *copy_ref_list(const struct ref *ref);
131 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
132 extern int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
133 int ref_compare_name(const void *, const void *);
135 int check_ref_type(const struct ref *ref, int flags);
138 * Frees the entire list and peers of elements.
140 void free_refs(struct ref *ref);
142 struct sha1_array;
143 extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
144 struct ref **list, unsigned int flags,
145 struct sha1_array *extra_have,
146 struct sha1_array *shallow);
148 int resolve_remote_symref(struct ref *ref, struct ref *list);
149 int ref_newer(const unsigned char *new_sha1, const unsigned char *old_sha1);
152 * Remove and free all but the first of any entries in the input list
153 * that map the same remote reference to the same local reference. If
154 * there are two entries that map different remote references to the
155 * same local reference, emit an error message and die. Return a
156 * pointer to the head of the resulting list.
158 struct ref *ref_remove_duplicates(struct ref *ref_map);
160 int valid_fetch_refspec(const char *refspec);
161 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
163 void free_refspec(int nr_refspec, struct refspec *refspec);
165 extern int query_refspecs(struct refspec *specs, int nr, struct refspec *query);
166 char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
167 const char *name);
169 int check_push_refs(struct ref *src, int nr_refspec, const char **refspec);
170 int match_push_refs(struct ref *src, struct ref **dst,
171 int nr_refspec, const char **refspec, int all);
172 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
173 int force_update);
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.
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.
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.
187 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
188 struct ref ***tail, int missing_ok);
190 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
193 * For the given remote, reads the refspec's src and sets the other fields.
195 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
197 struct branch {
198 const char *name;
199 const char *refname;
201 const char *remote_name;
202 struct remote *remote;
204 const char **merge_name;
205 struct refspec **merge;
206 int merge_nr;
207 int merge_alloc;
210 struct branch *branch_get(const char *name);
212 int branch_has_merge_config(struct branch *branch);
213 int branch_merge_matches(struct branch *, int n, const char *);
215 /* Flags to match_refs. */
216 enum match_refs_flags {
217 MATCH_REFS_NONE = 0,
218 MATCH_REFS_ALL = (1 << 0),
219 MATCH_REFS_MIRROR = (1 << 1),
220 MATCH_REFS_PRUNE = (1 << 2),
221 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
224 /* Reporting of tracking info */
225 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
226 int format_tracking_info(struct branch *branch, struct strbuf *sb);
228 struct ref *get_local_heads(void);
230 * Find refs from a list which are likely to be pointed to by the given HEAD
231 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
232 * list of all candidate refs. If no match is found (or 'head' is NULL),
233 * returns NULL. All returns are newly allocated and should be freed.
235 struct ref *guess_remote_head(const struct ref *head,
236 const struct ref *refs,
237 int all);
239 /* Return refs which no longer exist on remote */
240 struct ref *get_stale_heads(struct refspec *refs, int ref_count, struct ref *fetch_map);
243 * Compare-and-swap
245 #define CAS_OPT_NAME "force-with-lease"
247 struct push_cas_option {
248 unsigned use_tracking_for_rest:1;
249 struct push_cas {
250 unsigned char expect[20];
251 unsigned use_tracking:1;
252 char *refname;
253 } *entry;
254 int nr;
255 int alloc;
258 extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
259 extern int parse_push_cas_option(struct push_cas_option *, const char *arg, int unset);
260 extern void clear_cas_option(struct push_cas_option *);
262 extern int is_empty_cas(const struct push_cas_option *);
263 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
265 #endif