Documentation/describe: improve one-line summary
[git.git] / remote.h
blob8b62efd2adcb74c7e46d3f918a25658d6f6ce16f
1 #ifndef REMOTE_H
2 #define REMOTE_H
4 #include "parse-options.h"
5 #include "hashmap.h"
7 enum {
8 REMOTE_CONFIG,
9 REMOTE_REMOTES,
10 REMOTE_BRANCHES
13 struct remote {
14 struct hashmap_entry ent; /* must be first */
16 const char *name;
17 int origin;
19 const char *foreign_vcs;
21 const char **url;
22 int url_nr;
23 int url_alloc;
25 const char **pushurl;
26 int pushurl_nr;
27 int pushurl_alloc;
29 const char **push_refspec;
30 struct refspec *push;
31 int push_refspec_nr;
32 int push_refspec_alloc;
34 const char **fetch_refspec;
35 struct refspec *fetch;
36 int fetch_refspec_nr;
37 int fetch_refspec_alloc;
40 * -1 to never fetch tags
41 * 0 to auto-follow tags on heuristic (default)
42 * 1 to always auto-follow tags
43 * 2 to always fetch tags
45 int fetch_tags;
46 int skip_default_update;
47 int mirror;
48 int prune;
50 const char *receivepack;
51 const char *uploadpack;
54 * for curl remotes only
56 char *http_proxy;
59 struct remote *remote_get(const char *name);
60 struct remote *pushremote_get(const char *name);
61 int remote_is_configured(const char *name);
63 typedef int each_remote_fn(struct remote *remote, void *priv);
64 int for_each_remote(each_remote_fn fn, void *priv);
66 int remote_has_url(struct remote *remote, const char *url);
68 struct refspec {
69 unsigned force : 1;
70 unsigned pattern : 1;
71 unsigned matching : 1;
72 unsigned exact_sha1 : 1;
74 char *src;
75 char *dst;
78 extern const struct refspec *tag_refspec;
80 struct ref {
81 struct ref *next;
82 unsigned char old_sha1[20];
83 unsigned char new_sha1[20];
84 unsigned char old_sha1_expect[20]; /* used by expect-old */
85 char *symref;
86 unsigned int
87 force:1,
88 forced_update:1,
89 expect_old_sha1:1,
90 expect_old_no_trackback:1,
91 deletion:1,
92 matched:1;
95 * Order is important here, as we write to FETCH_HEAD
96 * in numeric order. And the default NOT_FOR_MERGE
97 * should be 0, so that xcalloc'd structures get it
98 * by default.
100 enum {
101 FETCH_HEAD_MERGE = -1,
102 FETCH_HEAD_NOT_FOR_MERGE = 0,
103 FETCH_HEAD_IGNORE = 1
104 } fetch_head_status;
106 enum {
107 REF_STATUS_NONE = 0,
108 REF_STATUS_OK,
109 REF_STATUS_REJECT_NONFASTFORWARD,
110 REF_STATUS_REJECT_ALREADY_EXISTS,
111 REF_STATUS_REJECT_NODELETE,
112 REF_STATUS_REJECT_FETCH_FIRST,
113 REF_STATUS_REJECT_NEEDS_FORCE,
114 REF_STATUS_REJECT_STALE,
115 REF_STATUS_REJECT_SHALLOW,
116 REF_STATUS_UPTODATE,
117 REF_STATUS_REMOTE_REJECT,
118 REF_STATUS_EXPECTING_REPORT
119 } status;
120 char *remote_status;
121 struct ref *peer_ref; /* when renaming */
122 char name[FLEX_ARRAY]; /* more */
125 #define REF_NORMAL (1u << 0)
126 #define REF_HEADS (1u << 1)
127 #define REF_TAGS (1u << 2)
129 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
131 struct ref *alloc_ref(const char *name);
132 struct ref *copy_ref(const struct ref *ref);
133 struct ref *copy_ref_list(const struct ref *ref);
134 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
135 extern int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
136 int ref_compare_name(const void *, const void *);
138 int check_ref_type(const struct ref *ref, int flags);
141 * Frees the entire list and peers of elements.
143 void free_refs(struct ref *ref);
145 struct sha1_array;
146 extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
147 struct ref **list, unsigned int flags,
148 struct sha1_array *extra_have,
149 struct sha1_array *shallow);
151 int resolve_remote_symref(struct ref *ref, struct ref *list);
152 int ref_newer(const unsigned char *new_sha1, const unsigned char *old_sha1);
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.
161 struct ref *ref_remove_duplicates(struct ref *ref_map);
163 int valid_fetch_refspec(const char *refspec);
164 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
166 void free_refspec(int nr_refspec, struct refspec *refspec);
168 extern int query_refspecs(struct refspec *specs, int nr, struct refspec *query);
169 char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
170 const char *name);
172 int check_push_refs(struct ref *src, int nr_refspec, const char **refspec);
173 int match_push_refs(struct ref *src, struct ref **dst,
174 int nr_refspec, const char **refspec, int all);
175 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
176 int force_update);
179 * Given a list of the remote refs and the specification of things to
180 * fetch, makes a (separate) list of the refs to fetch and the local
181 * refs to store into.
183 * *tail is the pointer to the tail pointer of the list of results
184 * beforehand, and will be set to the tail pointer of the list of
185 * results afterward.
187 * missing_ok is usually false, but when we are adding branch.$name.merge
188 * it is Ok if the branch is not at the remote anymore.
190 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
191 struct ref ***tail, int missing_ok);
193 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
196 * For the given remote, reads the refspec's src and sets the other fields.
198 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
200 struct branch {
201 const char *name;
202 const char *refname;
204 const char *remote_name;
205 struct remote *remote;
207 const char **merge_name;
208 struct refspec **merge;
209 int merge_nr;
210 int merge_alloc;
213 struct branch *branch_get(const char *name);
215 int branch_has_merge_config(struct branch *branch);
216 int branch_merge_matches(struct branch *, int n, const char *);
218 /* Flags to match_refs. */
219 enum match_refs_flags {
220 MATCH_REFS_NONE = 0,
221 MATCH_REFS_ALL = (1 << 0),
222 MATCH_REFS_MIRROR = (1 << 1),
223 MATCH_REFS_PRUNE = (1 << 2),
224 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
227 /* Reporting of tracking info */
228 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
229 int format_tracking_info(struct branch *branch, struct strbuf *sb);
231 struct ref *get_local_heads(void);
233 * Find refs from a list which are likely to be pointed to by the given HEAD
234 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
235 * list of all candidate refs. If no match is found (or 'head' is NULL),
236 * returns NULL. All returns are newly allocated and should be freed.
238 struct ref *guess_remote_head(const struct ref *head,
239 const struct ref *refs,
240 int all);
242 /* Return refs which no longer exist on remote */
243 struct ref *get_stale_heads(struct refspec *refs, int ref_count, struct ref *fetch_map);
246 * Compare-and-swap
248 #define CAS_OPT_NAME "force-with-lease"
250 struct push_cas_option {
251 unsigned use_tracking_for_rest:1;
252 struct push_cas {
253 unsigned char expect[20];
254 unsigned use_tracking:1;
255 char *refname;
256 } *entry;
257 int nr;
258 int alloc;
261 extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
262 extern int parse_push_cas_option(struct push_cas_option *, const char *arg, int unset);
263 extern void clear_cas_option(struct push_cas_option *);
265 extern int is_empty_cas(const struct push_cas_option *);
266 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
268 #endif