5 #include "parse-options.h"
10 * The API gives access to the configuration related to remotes. It handles
11 * all three configuration mechanisms historically and currently used by Git,
12 * and presents the information in a uniform fashion. Note that the code also
13 * handles plain URLs without any configuration, giving them just the default
18 REMOTE_UNCONFIGURED = 0,
25 struct hashmap_entry ent;
27 /* The user's nickname for the remote */
30 int origin, configured_in_repo;
32 const char *foreign_vcs;
34 /* An array of all of the url_nr URLs configured for the remote */
40 /* An array of all of the pushurl_nr push URLs configured for the remote */
51 * The setting for whether to fetch tags (as a separate rule from the
52 * configured refspecs);
53 * -1 to never fetch tags
54 * 0 to auto-follow tags on heuristic (default)
55 * 1 to always auto-follow tags
56 * 2 to always fetch tags
60 int skip_default_update;
66 * The configured helper programs to run on the remote side, for
67 * Git-native protocols.
69 const char *receivepack;
70 const char *uploadpack;
72 /* The proxy to use for curl (http, https, ftp, etc.) URLs. */
75 /* The method used for authenticating against `http_proxy`. */
76 char *http_proxy_authmethod;
80 * struct remotes can be found by name with remote_get().
81 * remote_get(NULL) will return the default remote, given the current branch
84 struct remote *remote_get(const char *name);
86 struct remote *pushremote_get(const char *name);
87 int remote_is_configured(struct remote *remote, int in_repo);
89 typedef int each_remote_fn(struct remote *remote, void *priv);
91 /* iterate through struct remotes */
92 int for_each_remote(each_remote_fn fn, void *priv);
94 int remote_has_url(struct remote *remote, const char *url);
96 struct ref_push_report {
98 struct object_id *old_oid;
99 struct object_id *new_oid;
100 unsigned int forced_update:1;
101 struct ref_push_report *next;
106 struct object_id old_oid;
107 struct object_id new_oid;
108 struct object_id old_oid_expect; /* used by expect-old */
118 REF_NOT_MATCHED = 0, /* initial value */
120 REF_UNADVERTISED_NOT_ALLOWED
124 * Order is important here, as we write to FETCH_HEAD
125 * in numeric order. And the default NOT_FOR_MERGE
126 * should be 0, so that xcalloc'd structures get it
130 FETCH_HEAD_MERGE = -1,
131 FETCH_HEAD_NOT_FOR_MERGE = 0,
132 FETCH_HEAD_IGNORE = 1
138 REF_STATUS_REJECT_NONFASTFORWARD,
139 REF_STATUS_REJECT_ALREADY_EXISTS,
140 REF_STATUS_REJECT_NODELETE,
141 REF_STATUS_REJECT_FETCH_FIRST,
142 REF_STATUS_REJECT_NEEDS_FORCE,
143 REF_STATUS_REJECT_STALE,
144 REF_STATUS_REJECT_SHALLOW,
146 REF_STATUS_REMOTE_REJECT,
147 REF_STATUS_EXPECTING_REPORT,
148 REF_STATUS_ATOMIC_PUSH_FAILED
151 struct ref_push_report *report;
152 struct ref *peer_ref; /* when renaming */
153 char name[FLEX_ARRAY]; /* more */
156 #define REF_NORMAL (1u << 0)
157 #define REF_HEADS (1u << 1)
158 #define REF_TAGS (1u << 2)
160 struct ref *find_ref_by_name(const struct ref *list, const char *name);
162 struct ref *alloc_ref(const char *name);
163 struct ref *copy_ref(const struct ref *ref);
164 struct ref *copy_ref_list(const struct ref *ref);
165 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
166 int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
167 int ref_compare_name(const void *, const void *);
169 int check_ref_type(const struct ref *ref, int flags);
172 * Free a single ref and its peer, or an entire list of refs and their peers,
175 void free_one_ref(struct ref *ref);
176 void free_refs(struct ref *ref);
179 struct packet_reader;
182 struct ref **get_remote_heads(struct packet_reader *reader,
183 struct ref **list, unsigned int flags,
184 struct oid_array *extra_have,
185 struct oid_array *shallow_points);
187 /* Used for protocol v2 in order to retrieve refs from a remote */
188 struct ref **get_remote_refs(int fd_out, struct packet_reader *reader,
189 struct ref **list, int for_push,
190 const struct strvec *ref_prefixes,
191 const struct string_list *server_options,
194 int resolve_remote_symref(struct ref *ref, struct ref *list);
197 * Remove and free all but the first of any entries in the input list
198 * that map the same remote reference to the same local reference. If
199 * there are two entries that map different remote references to the
200 * same local reference, emit an error message and die. Return a
201 * pointer to the head of the resulting list.
203 struct ref *ref_remove_duplicates(struct ref *ref_map);
205 int query_refspecs(struct refspec *rs, struct refspec_item *query);
206 char *apply_refspecs(struct refspec *rs, const char *name);
208 int check_push_refs(struct ref *src, struct refspec *rs);
209 int match_push_refs(struct ref *src, struct ref **dst,
210 struct refspec *rs, int flags);
211 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
215 * Given a list of the remote refs and the specification of things to
216 * fetch, makes a (separate) list of the refs to fetch and the local
217 * refs to store into.
219 * *tail is the pointer to the tail pointer of the list of results
220 * beforehand, and will be set to the tail pointer of the list of
223 * missing_ok is usually false, but when we are adding branch.$name.merge
224 * it is Ok if the branch is not at the remote anymore.
226 int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec,
227 struct ref ***tail, int missing_ok);
229 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
232 * For the given remote, reads the refspec's src and sets the other fields.
234 int remote_find_tracking(struct remote *remote, struct refspec_item *refspec);
237 * struct branch holds the configuration for a branch. It can be looked up with
238 * branch_get(name) for "refs/heads/{name}", or with branch_get(NULL) for HEAD.
242 /* The short name of the branch. */
245 /* The full path for the branch ref. */
248 /* The name of the remote listed in the configuration. */
249 const char *remote_name;
251 const char *pushremote_name;
253 /* An array of the "merge" lines in the configuration. */
254 const char **merge_name;
257 * An array of the struct refspecs used for the merge lines. That is,
258 * merge[i]->dst is a local tracking ref which should be merged into this
261 struct refspec_item **merge;
263 /* The number of merge configurations */
268 const char *push_tracking_ref;
271 struct branch *branch_get(const char *name);
272 const char *remote_for_branch(struct branch *branch, int *explicit);
273 const char *pushremote_for_branch(struct branch *branch, int *explicit);
274 const char *remote_ref_for_branch(struct branch *branch, int for_push);
276 /* returns true if the given branch has merge configuration given. */
277 int branch_has_merge_config(struct branch *branch);
279 int branch_merge_matches(struct branch *, int n, const char *);
282 * Return the fully-qualified refname of the tracking branch for `branch`.
283 * I.e., what "branch@{upstream}" would give you. Returns NULL if no
284 * upstream is defined.
286 * If `err` is not NULL and no upstream is defined, a more specific error
287 * message is recorded there (if the function does not return NULL, then
288 * `err` is not touched).
290 const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
293 * Return the tracking branch that corresponds to the ref we would push to
294 * given a bare `git push` while `branch` is checked out.
296 * The return value and `err` conventions match those of `branch_get_upstream`.
298 const char *branch_get_push(struct branch *branch, struct strbuf *err);
300 /* Flags to match_refs. */
301 enum match_refs_flags {
303 MATCH_REFS_ALL = (1 << 0),
304 MATCH_REFS_MIRROR = (1 << 1),
305 MATCH_REFS_PRUNE = (1 << 2),
306 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
309 /* Flags for --ahead-behind option. */
310 enum ahead_behind_flags {
311 AHEAD_BEHIND_UNSPECIFIED = -1,
312 AHEAD_BEHIND_QUICK = 0, /* just eq/neq reporting */
313 AHEAD_BEHIND_FULL = 1, /* traditional a/b reporting */
316 /* Reporting of tracking info */
317 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
318 const char **upstream_name, int for_push,
319 enum ahead_behind_flags abf);
320 int format_tracking_info(struct branch *branch, struct strbuf *sb,
321 enum ahead_behind_flags abf);
323 struct ref *get_local_heads(void);
325 * Find refs from a list which are likely to be pointed to by the given HEAD
326 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
327 * list of all candidate refs. If no match is found (or 'head' is NULL),
328 * returns NULL. All returns are newly allocated and should be freed.
330 struct ref *guess_remote_head(const struct ref *head,
331 const struct ref *refs,
334 /* Return refs which no longer exist on remote */
335 struct ref *get_stale_heads(struct refspec *rs, struct ref *fetch_map);
340 #define CAS_OPT_NAME "force-with-lease"
342 struct push_cas_option {
343 unsigned use_tracking_for_rest:1;
345 struct object_id expect;
346 unsigned use_tracking:1;
353 int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
355 int is_empty_cas(const struct push_cas_option *);
356 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);