blob: dfd4837e602755806bcfc73a725c04394ef81c6c [file] [log] [blame]
Daniel Barkalow5751f492007-05-12 11:45:53 -04001#ifndef REMOTE_H
2#define REMOTE_H
3
Elijah Newrenb9a7ac22023-05-16 06:34:07 +00004#include "hash-ll.h"
Patrick Reynoldsd0da0032014-07-29 14:43:39 +00005#include "hashmap.h"
Brandon Williams6bdb3042018-05-16 15:58:00 -07006#include "refspec.h"
Junio C Hamano28f5d172013-07-08 15:34:36 -07007
SZEDER Gáborc4d9c792023-03-19 17:27:12 +01008struct option;
Jonathan Tan39835402021-02-05 12:48:48 -08009struct transport_ls_refs_options;
10
Heba Walyd27eb352019-11-17 21:04:45 +000011/**
12 * The API gives access to the configuration related to remotes. It handles
13 * all three configuration mechanisms historically and currently used by Git,
14 * and presents the information in a uniform fashion. Note that the code also
15 * handles plain URLs without any configuration, giving them just the default
16 * information.
17 */
18
Miklos Vajna89cf4c72008-11-10 21:43:00 +010019enum {
Thomas Gummerer674468b2016-02-16 10:47:50 +010020 REMOTE_UNCONFIGURED = 0,
Miklos Vajna89cf4c72008-11-10 21:43:00 +010021 REMOTE_CONFIG,
22 REMOTE_REMOTES,
23 REMOTE_BRANCHES
24};
25
Glen Choofd3cb052021-11-17 16:53:22 -080026struct rewrite {
27 const char *base;
28 size_t baselen;
29 struct counted_string *instead_of;
30 int instead_of_nr;
31 int instead_of_alloc;
32};
33
34struct rewrites {
35 struct rewrite **rewrite;
36 int rewrite_alloc;
37 int rewrite_nr;
38};
39
40struct remote_state {
41 struct remote **remotes;
42 int remotes_alloc;
43 int remotes_nr;
44 struct hashmap remotes_hash;
45
Glen Choo4a2dcb12021-11-17 16:53:25 -080046 struct hashmap branches_hash;
Glen Choofd3cb052021-11-17 16:53:22 -080047
48 struct branch *current_branch;
49 const char *pushremote_name;
50
51 struct rewrites rewrites;
52 struct rewrites rewrites_push;
Glen Choo085b98f2021-11-17 16:53:23 -080053
54 int initialized;
Glen Choofd3cb052021-11-17 16:53:22 -080055};
56
57void remote_state_clear(struct remote_state *remote_state);
58struct remote_state *remote_state_new(void);
59
Daniel Barkalow5751f492007-05-12 11:45:53 -040060struct remote {
Eric Wonge2b50382019-10-06 23:30:43 +000061 struct hashmap_entry ent;
Patrick Reynoldsd0da0032014-07-29 14:43:39 +000062
Heba Walyd27eb352019-11-17 21:04:45 +000063 /* The user's nickname for the remote */
Daniel Barkalow5751f492007-05-12 11:45:53 -040064 const char *name;
Heba Walyd27eb352019-11-17 21:04:45 +000065
Johannes Schindeline459b072017-01-19 22:20:02 +010066 int origin, configured_in_repo;
Daniel Barkalow5751f492007-05-12 11:45:53 -040067
Daniel Barkalowc578f512009-11-18 02:42:25 +010068 const char *foreign_vcs;
69
Heba Walyd27eb352019-11-17 21:04:45 +000070 /* An array of all of the url_nr URLs configured for the remote */
Shawn O. Pearce28b91f82007-09-19 00:49:27 -040071 const char **url;
Heba Walyd27eb352019-11-17 21:04:45 +000072
Shawn O. Pearce28b91f82007-09-19 00:49:27 -040073 int url_nr;
Daniel Barkalow2d313472008-02-18 23:41:41 -050074 int url_alloc;
Daniel Barkalow5751f492007-05-12 11:45:53 -040075
Heba Walyd27eb352019-11-17 21:04:45 +000076 /* An array of all of the pushurl_nr push URLs configured for the remote */
Michael J Gruber20346232009-06-09 18:01:34 +020077 const char **pushurl;
Heba Walyd27eb352019-11-17 21:04:45 +000078
Michael J Gruber20346232009-06-09 18:01:34 +020079 int pushurl_nr;
80 int pushurl_alloc;
81
Brandon Williams6bdb3042018-05-16 15:58:00 -070082 struct refspec push;
Daniel Barkalow5751f492007-05-12 11:45:53 -040083
Brandon Williamse5349ab2018-05-16 15:58:01 -070084 struct refspec fetch;
Daniel Barkalow5d46c9d2007-05-12 11:46:03 -040085
Daniel Barkalowd71ab172007-09-10 23:03:08 -040086 /*
Heba Walyd27eb352019-11-17 21:04:45 +000087 * The setting for whether to fetch tags (as a separate rule from the
88 * configured refspecs);
Daniel Barkalowd71ab172007-09-10 23:03:08 -040089 * -1 to never fetch tags
90 * 0 to auto-follow tags on heuristic (default)
91 * 1 to always auto-follow tags
92 * 2 to always fetch tags
93 */
94 int fetch_tags;
Heba Walyd27eb352019-11-17 21:04:45 +000095
Johannes Schindelin211c8962008-02-29 01:45:45 +000096 int skip_default_update;
Paolo Bonzini84bb2df2008-04-17 13:17:20 +020097 int mirror;
Michael Schubert737c5a92013-07-13 11:36:24 +020098 int prune;
Ævar Arnfjörð Bjarmason97716d22018-02-09 20:32:15 +000099 int prune_tags;
Daniel Barkalowd71ab172007-09-10 23:03:08 -0400100
Heba Walyd27eb352019-11-17 21:04:45 +0000101 /**
102 * The configured helper programs to run on the remote side, for
103 * Git-native protocols.
104 */
Daniel Barkalow5751f492007-05-12 11:45:53 -0400105 const char *receivepack;
Daniel Barkalow0012ba22007-09-10 23:02:51 -0400106 const char *uploadpack;
Sam Vilain14c98212007-12-04 10:48:54 +1300107
Heba Walyd27eb352019-11-17 21:04:45 +0000108 /* The proxy to use for curl (http, https, ftp, etc.) URLs. */
Sam Vilain14c98212007-12-04 10:48:54 +1300109 char *http_proxy;
Heba Walyd27eb352019-11-17 21:04:45 +0000110
111 /* The method used for authenticating against `http_proxy`. */
Knut Frankeef976392016-01-26 13:02:47 +0000112 char *http_proxy_authmethod;
Daniel Barkalow5751f492007-05-12 11:45:53 -0400113};
114
Heba Walyd27eb352019-11-17 21:04:45 +0000115/**
116 * struct remotes can be found by name with remote_get().
117 * remote_get(NULL) will return the default remote, given the current branch
118 * and configuration.
119 */
Daniel Barkalow5751f492007-05-12 11:45:53 -0400120struct remote *remote_get(const char *name);
Patrick Steinhardt3c8f60c2023-12-12 08:01:03 +0100121struct remote *remote_get_early(const char *name);
Heba Walyd27eb352019-11-17 21:04:45 +0000122
Ramkumar Ramachandraf24f7152013-04-02 13:10:32 +0530123struct remote *pushremote_get(const char *name);
Johannes Schindeline459b072017-01-19 22:20:02 +0100124int remote_is_configured(struct remote *remote, int in_repo);
Daniel Barkalow5751f492007-05-12 11:45:53 -0400125
Johannes Schindelinb42f6922007-07-10 18:48:40 +0100126typedef int each_remote_fn(struct remote *remote, void *priv);
Heba Walyd27eb352019-11-17 21:04:45 +0000127
128/* iterate through struct remotes */
Johannes Schindelinb42f6922007-07-10 18:48:40 +0100129int for_each_remote(each_remote_fn fn, void *priv);
130
Shawn O. Pearce28b91f82007-09-19 00:49:27 -0400131int remote_has_url(struct remote *remote, const char *url);
Daniel Barkalow5d46c9d2007-05-12 11:46:03 -0400132
Jiang Xin15d3af52020-08-27 11:45:44 -0400133struct ref_push_report {
134 const char *ref_name;
135 struct object_id *old_oid;
136 struct object_id *new_oid;
137 unsigned int forced_update:1;
138 struct ref_push_report *next;
139};
140
Junio C Hamano47a59182013-07-08 13:56:53 -0700141struct ref {
142 struct ref *next;
brian m. carlsonf4e54d02015-11-10 02:22:20 +0000143 struct object_id old_oid;
144 struct object_id new_oid;
145 struct object_id old_oid_expect; /* used by expect-old */
Junio C Hamano47a59182013-07-08 13:56:53 -0700146 char *symref;
Srinidhi Kaushik99a1f9a2020-10-03 17:40:44 +0530147 char *tracking_ref;
Junio C Hamano47a59182013-07-08 13:56:53 -0700148 unsigned int
149 force:1,
150 forced_update:1,
Junio C Hamano91048a92013-07-09 11:01:06 -0700151 expect_old_sha1:1,
Brandon Williams73302052018-06-27 15:30:23 -0700152 exact_oid:1,
Srinidhi Kaushik99a1f9a2020-10-03 17:40:44 +0530153 deletion:1,
154 /* Need to check if local reflog reaches the remote tip. */
155 check_reachable:1,
156 /*
157 * Store the result of the check enabled by "check_reachable";
158 * implies the local reflog does not reach the remote tip.
159 */
160 unreachable:1;
Matt McCutchend56583d2017-02-22 11:05:57 -0500161
162 enum {
163 REF_NOT_MATCHED = 0, /* initial value */
164 REF_MATCHED,
165 REF_UNADVERTISED_NOT_ALLOWED
166 } match_status;
Junio C Hamano47a59182013-07-08 13:56:53 -0700167
168 /*
169 * Order is important here, as we write to FETCH_HEAD
170 * in numeric order. And the default NOT_FOR_MERGE
171 * should be 0, so that xcalloc'd structures get it
172 * by default.
173 */
Patrick Steinhardt58a646a2021-01-12 13:27:35 +0100174 enum fetch_head_status {
Junio C Hamano47a59182013-07-08 13:56:53 -0700175 FETCH_HEAD_MERGE = -1,
176 FETCH_HEAD_NOT_FOR_MERGE = 0,
177 FETCH_HEAD_IGNORE = 1
178 } fetch_head_status;
179
180 enum {
181 REF_STATUS_NONE = 0,
182 REF_STATUS_OK,
183 REF_STATUS_REJECT_NONFASTFORWARD,
184 REF_STATUS_REJECT_ALREADY_EXISTS,
185 REF_STATUS_REJECT_NODELETE,
186 REF_STATUS_REJECT_FETCH_FIRST,
187 REF_STATUS_REJECT_NEEDS_FORCE,
Junio C Hamano631b5ef2013-07-08 14:42:40 -0700188 REF_STATUS_REJECT_STALE,
Nguyễn Thái Ngọc Duy4820a332013-12-05 20:02:40 +0700189 REF_STATUS_REJECT_SHALLOW,
Srinidhi Kaushik99a1f9a2020-10-03 17:40:44 +0530190 REF_STATUS_REJECT_REMOTE_UPDATED,
Junio C Hamano47a59182013-07-08 13:56:53 -0700191 REF_STATUS_UPTODATE,
192 REF_STATUS_REMOTE_REJECT,
Ronnie Sahlberg4ff17f12015-01-07 19:23:22 -0800193 REF_STATUS_EXPECTING_REPORT,
194 REF_STATUS_ATOMIC_PUSH_FAILED
Junio C Hamano47a59182013-07-08 13:56:53 -0700195 } status;
196 char *remote_status;
Jiang Xin63518a52020-08-27 11:45:46 -0400197 struct ref_push_report *report;
Junio C Hamano47a59182013-07-08 13:56:53 -0700198 struct ref *peer_ref; /* when renaming */
199 char name[FLEX_ARRAY]; /* more */
200};
201
202#define REF_NORMAL (1u << 0)
203#define REF_HEADS (1u << 1)
204#define REF_TAGS (1u << 2)
205
Denton Liu55454422019-04-29 04:28:14 -0400206struct ref *find_ref_by_name(const struct ref *list, const char *name);
Junio C Hamano47a59182013-07-08 13:56:53 -0700207
René Scharfe59c69c02008-10-18 10:44:18 +0200208struct ref *alloc_ref(const char *name);
Jeff King59a57752011-06-07 19:03:03 -0400209struct ref *copy_ref(const struct ref *ref);
Daniel Barkalow45773702007-10-29 21:05:40 -0400210struct ref *copy_ref_list(const struct ref *ref);
Denton Liu55454422019-04-29 04:28:14 -0400211int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
Daniel Barkalow45773702007-10-29 21:05:40 -0400212
213int check_ref_type(const struct ref *ref, int flags);
214
Daniel Barkalowdfd255d2007-07-10 00:47:23 -0400215/*
Jeff King10271862019-04-13 01:54:31 -0400216 * Free a single ref and its peer, or an entire list of refs and their peers,
217 * respectively.
Daniel Barkalowdfd255d2007-07-10 00:47:23 -0400218 */
Jeff King10271862019-04-13 01:54:31 -0400219void free_one_ref(struct ref *ref);
Daniel Barkalowdfd255d2007-07-10 00:47:23 -0400220void free_refs(struct ref *ref);
221
brian m. carlson910650d2017-03-31 01:40:00 +0000222struct oid_array;
Brandon Williamsad6ac122018-03-14 11:31:45 -0700223struct packet_reader;
Jeff King873cd282020-07-28 16:23:25 -0400224struct strvec;
Brandon Williamsff473222018-04-23 15:46:23 -0700225struct string_list;
Denton Liu55454422019-04-29 04:28:14 -0400226struct ref **get_remote_heads(struct packet_reader *reader,
Denton Liuad6dad02019-04-29 04:28:23 -0400227 struct ref **list, unsigned int flags,
228 struct oid_array *extra_have,
229 struct oid_array *shallow_points);
Junio C Hamano47a59182013-07-08 13:56:53 -0700230
Brandon Williamse52449b2018-03-15 10:31:21 -0700231/* Used for protocol v2 in order to retrieve refs from a remote */
Denton Liu55454422019-04-29 04:28:14 -0400232struct ref **get_remote_refs(int fd_out, struct packet_reader *reader,
Denton Liuad6dad02019-04-29 04:28:23 -0400233 struct ref **list, int for_push,
Jonathan Tan39835402021-02-05 12:48:48 -0800234 struct transport_ls_refs_options *transport_options,
Denton Liub0df0c12020-05-19 06:54:00 -0400235 const struct string_list *server_options,
236 int stateless_rpc);
Daniel Barkalow5d46c9d2007-05-12 11:46:03 -0400237
Ævar Arnfjörð Bjarmason0cfde742022-12-22 15:14:09 +0000238/* Used for protocol v2 in order to retrieve refs from a remote */
239struct bundle_list;
240int get_remote_bundle_uri(int fd_out, struct packet_reader *reader,
241 struct bundle_list *bundles, int stateless_rpc);
242
Daniel Barkalowbe885d92008-04-26 15:53:12 -0400243int resolve_remote_symref(struct ref *ref, struct ref *list);
244
Daniel Barkalow2467a4f2007-10-08 00:25:07 -0400245/*
Michael Haggertyb9afe662013-10-30 06:33:09 +0100246 * Remove and free all but the first of any entries in the input list
247 * that map the same remote reference to the same local reference. If
248 * there are two entries that map different remote references to the
249 * same local reference, emit an error message and die. Return a
250 * pointer to the head of the resulting list.
Daniel Barkalow2467a4f2007-10-08 00:25:07 -0400251 */
Michael Haggertyb9afe662013-10-30 06:33:09 +0100252struct ref *ref_remove_duplicates(struct ref *ref_map);
Daniel Barkalow2467a4f2007-10-08 00:25:07 -0400253
Jacob Kellerc0192df2020-09-30 14:25:29 -0700254/*
Jacob Keller2c80a822022-06-16 17:20:31 -0700255 * Check whether a name matches any negative refspec in rs. Returns 1 if the
256 * name matches at least one negative refspec, and 0 otherwise.
257 */
258int omit_name_by_refspec(const char *name, struct refspec *rs);
259
260/*
Jacob Kellerc0192df2020-09-30 14:25:29 -0700261 * Remove all entries in the input list which match any negative refspec in
262 * the refspec list.
263 */
264struct ref *apply_negative_refspecs(struct ref *ref_map, struct refspec *rs);
265
Brandon Williams86baf822018-05-16 15:58:12 -0700266int query_refspecs(struct refspec *rs, struct refspec_item *query);
Brandon Williamsd0004142018-05-16 15:58:11 -0700267char *apply_refspecs(struct refspec *rs, const char *name);
Daniel Barkalowd71ab172007-09-10 23:03:08 -0400268
Brandon Williamsafb1aed2018-05-16 15:58:22 -0700269int check_push_refs(struct ref *src, struct refspec *rs);
Junio C Hamano29753cd2011-09-09 11:54:58 -0700270int match_push_refs(struct ref *src, struct ref **dst,
Brandon Williams5c7ec842018-05-16 15:58:21 -0700271 struct refspec *rs, int flags);
Tay Ray Chuan20e8b462010-01-08 10:12:42 +0800272void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
273 int force_update);
Daniel Barkalow6b628162007-05-12 11:45:59 -0400274
Daniel Barkalow5d46c9d2007-05-12 11:46:03 -0400275/*
Daniel Barkalowd71ab172007-09-10 23:03:08 -0400276 * Given a list of the remote refs and the specification of things to
277 * fetch, makes a (separate) list of the refs to fetch and the local
Jacob Kellerc0192df2020-09-30 14:25:29 -0700278 * refs to store into. Note that negative refspecs are ignored here, and
279 * should be handled separately.
Daniel Barkalowd71ab172007-09-10 23:03:08 -0400280 *
281 * *tail is the pointer to the tail pointer of the list of results
282 * beforehand, and will be set to the tail pointer of the list of
283 * results afterward.
Junio C Hamano9ad7c5a2007-10-26 23:09:48 -0700284 *
285 * missing_ok is usually false, but when we are adding branch.$name.merge
286 * it is Ok if the branch is not at the remote anymore.
Daniel Barkalowd71ab172007-09-10 23:03:08 -0400287 */
Brandon Williams0ad4a5f2018-05-16 15:57:49 -0700288int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec,
Junio C Hamano9ad7c5a2007-10-26 23:09:48 -0700289 struct ref ***tail, int missing_ok);
Daniel Barkalowd71ab172007-09-10 23:03:08 -0400290
Daniel Barkalow45773702007-10-29 21:05:40 -0400291struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
Daniel Barkalowd71ab172007-09-10 23:03:08 -0400292
293/*
Daniel Barkalow5d46c9d2007-05-12 11:46:03 -0400294 * For the given remote, reads the refspec's src and sets the other fields.
295 */
Brandon Williams0ad4a5f2018-05-16 15:57:49 -0700296int remote_find_tracking(struct remote *remote, struct refspec_item *refspec);
Daniel Barkalow5d46c9d2007-05-12 11:46:03 -0400297
Heba Walyd27eb352019-11-17 21:04:45 +0000298/**
299 * struct branch holds the configuration for a branch. It can be looked up with
300 * branch_get(name) for "refs/heads/{name}", or with branch_get(NULL) for HEAD.
301 */
Daniel Barkalowcf818342007-09-10 23:02:56 -0400302struct branch {
Glen Choo4a2dcb12021-11-17 16:53:25 -0800303 struct hashmap_entry ent;
Heba Walyd27eb352019-11-17 21:04:45 +0000304
305 /* The short name of the branch. */
Daniel Barkalowcf818342007-09-10 23:02:56 -0400306 const char *name;
Heba Walyd27eb352019-11-17 21:04:45 +0000307
308 /* The full path for the branch ref. */
Daniel Barkalowcf818342007-09-10 23:02:56 -0400309 const char *refname;
310
Heba Walyd27eb352019-11-17 21:04:45 +0000311 /* The name of the remote listed in the configuration. */
Daniel Barkalowcf818342007-09-10 23:02:56 -0400312 const char *remote_name;
Heba Walyd27eb352019-11-17 21:04:45 +0000313
Jeff Kingda66b272015-05-21 00:45:20 -0400314 const char *pushremote_name;
Daniel Barkalowcf818342007-09-10 23:02:56 -0400315
Heba Walyd27eb352019-11-17 21:04:45 +0000316 /* An array of the "merge" lines in the configuration. */
Daniel Barkalowcf818342007-09-10 23:02:56 -0400317 const char **merge_name;
Heba Walyd27eb352019-11-17 21:04:45 +0000318
319 /**
320 * An array of the struct refspecs used for the merge lines. That is,
321 * merge[i]->dst is a local tracking ref which should be merged into this
322 * branch by default.
323 */
Brandon Williams0ad4a5f2018-05-16 15:57:49 -0700324 struct refspec_item **merge;
Heba Walyd27eb352019-11-17 21:04:45 +0000325
326 /* The number of merge configurations */
Daniel Barkalowcf818342007-09-10 23:02:56 -0400327 int merge_nr;
Heba Walyd27eb352019-11-17 21:04:45 +0000328
Daniel Barkalow2d313472008-02-18 23:41:41 -0500329 int merge_alloc;
Jeff Kinge291c752015-05-21 00:45:36 -0400330
331 const char *push_tracking_ref;
Daniel Barkalowcf818342007-09-10 23:02:56 -0400332};
333
334struct branch *branch_get(const char *name);
Jeff Kingf0521542015-05-21 00:45:16 -0400335const char *remote_for_branch(struct branch *branch, int *explicit);
Jeff Kingda66b272015-05-21 00:45:20 -0400336const char *pushremote_for_branch(struct branch *branch, int *explicit);
Jeff Kingaf8ccd82020-03-03 17:12:22 +0100337const char *remote_ref_for_branch(struct branch *branch, int for_push);
Daniel Barkalowcf818342007-09-10 23:02:56 -0400338
Heba Walyd27eb352019-11-17 21:04:45 +0000339/* returns true if the given branch has merge configuration given. */
Daniel Barkalowcf818342007-09-10 23:02:56 -0400340int branch_has_merge_config(struct branch *branch);
Heba Walyd27eb352019-11-17 21:04:45 +0000341
Shawn O. Pearce85682c12007-09-18 04:54:53 -0400342int branch_merge_matches(struct branch *, int n, const char *);
Daniel Barkalowcf818342007-09-10 23:02:56 -0400343
Jeff Kinga9f9f8c2015-05-21 00:45:28 -0400344/**
345 * Return the fully-qualified refname of the tracking branch for `branch`.
346 * I.e., what "branch@{upstream}" would give you. Returns NULL if no
347 * upstream is defined.
Jeff King3a429d02015-05-21 00:45:32 -0400348 *
349 * If `err` is not NULL and no upstream is defined, a more specific error
350 * message is recorded there (if the function does not return NULL, then
351 * `err` is not touched).
Jeff Kinga9f9f8c2015-05-21 00:45:28 -0400352 */
Jeff King3a429d02015-05-21 00:45:32 -0400353const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
Jeff Kinga9f9f8c2015-05-21 00:45:28 -0400354
Jeff Kinge291c752015-05-21 00:45:36 -0400355/**
356 * Return the tracking branch that corresponds to the ref we would push to
357 * given a bare `git push` while `branch` is checked out.
358 *
359 * The return value and `err` conventions match those of `branch_get_upstream`.
360 */
361const char *branch_get_push(struct branch *branch, struct strbuf *err);
362
Andy Whitcroft28b9d6e2007-11-09 23:32:10 +0000363/* Flags to match_refs. */
364enum match_refs_flags {
365 MATCH_REFS_NONE = 0,
366 MATCH_REFS_ALL = (1 << 0),
Felipe Contreras6ddba5e2012-02-23 00:43:41 +0200367 MATCH_REFS_MIRROR = (1 << 1),
Junio C Hamanoc2aba152013-03-04 12:09:50 -0800368 MATCH_REFS_PRUNE = (1 << 2),
369 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
Andy Whitcroft28b9d6e2007-11-09 23:32:10 +0000370};
371
Jeff Hostetlerd7d1b492018-01-09 18:50:15 +0000372/* Flags for --ahead-behind option. */
373enum ahead_behind_flags {
Jeff Hostetlerfd9b5442018-01-09 18:50:16 +0000374 AHEAD_BEHIND_UNSPECIFIED = -1,
375 AHEAD_BEHIND_QUICK = 0, /* just eq/neq reporting */
376 AHEAD_BEHIND_FULL = 1, /* traditional a/b reporting */
Jeff Hostetlerd7d1b492018-01-09 18:50:15 +0000377};
378
Junio C Hamano6d21bf92008-07-02 00:51:18 -0700379/* Reporting of tracking info */
Jeff King979cb242015-05-21 20:49:11 -0400380int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
Damien Robertc646d092019-04-16 14:16:46 +0200381 const char **upstream_name, int for_push,
382 enum ahead_behind_flags abf);
Jeff Hostetlerf39a7572018-01-09 18:50:18 +0000383int format_tracking_info(struct branch *branch, struct strbuf *sb,
Alex Henrieb6f3da52023-07-12 22:41:13 -0600384 enum ahead_behind_flags abf,
385 int show_divergence_advice);
Junio C Hamano6d21bf92008-07-02 00:51:18 -0700386
Jay Soffian454e2022009-02-25 03:32:11 -0500387struct ref *get_local_heads(void);
Jay Soffian6cb4e6c2009-02-25 03:32:14 -0500388/*
Jay Soffian4229f1f2009-02-27 14:10:05 -0500389 * Find refs from a list which are likely to be pointed to by the given HEAD
390 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
391 * list of all candidate refs. If no match is found (or 'head' is NULL),
392 * returns NULL. All returns are newly allocated and should be freed.
Jay Soffian6cb4e6c2009-02-25 03:32:14 -0500393 */
Jay Soffian4229f1f2009-02-27 14:10:05 -0500394struct ref *guess_remote_head(const struct ref *head,
395 const struct ref *refs,
396 int all);
397
Jay Soffianf2ef6072009-11-10 00:03:31 -0500398/* Return refs which no longer exist on remote */
Brandon Williamsa2ac50c2018-05-16 15:58:10 -0700399struct ref *get_stale_heads(struct refspec *rs, struct ref *fetch_map);
Jay Soffianf2ef6072009-11-10 00:03:31 -0500400
Junio C Hamano28f5d172013-07-08 15:34:36 -0700401/*
402 * Compare-and-swap
403 */
Junio C Hamano28f5d172013-07-08 15:34:36 -0700404struct push_cas_option {
405 unsigned use_tracking_for_rest:1;
Srinidhi Kaushik99a1f9a2020-10-03 17:40:44 +0530406 unsigned use_force_if_includes:1;
Junio C Hamano28f5d172013-07-08 15:34:36 -0700407 struct push_cas {
brian m. carlsonb8566f82017-07-13 23:49:21 +0000408 struct object_id expect;
Junio C Hamano28f5d172013-07-08 15:34:36 -0700409 unsigned use_tracking:1;
410 char *refname;
411 } *entry;
412 int nr;
413 int alloc;
414};
415
Denton Liu55454422019-04-29 04:28:14 -0400416int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
Junio C Hamano28f5d172013-07-08 15:34:36 -0700417
Denton Liu55454422019-04-29 04:28:14 -0400418int is_empty_cas(const struct push_cas_option *);
Junio C Hamano91048a92013-07-09 11:01:06 -0700419void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
420
Derrick Stolee1d04e712022-05-16 20:11:03 +0000421/*
422 * The `url` argument is the URL that navigates to the submodule origin
423 * repo. When relative, this URL is relative to the superproject origin
424 * URL repo. The `up_path` argument, if specified, is the relative
425 * path that navigates from the submodule working tree to the superproject
426 * working tree. Returns the origin URL of the submodule.
427 *
428 * Return either an absolute URL or filesystem path (if the superproject
429 * origin URL is an absolute URL or filesystem path, respectively) or a
430 * relative file system path (if the superproject origin URL is a relative
431 * file system path).
432 *
433 * When the output is a relative file system path, the path is either
434 * relative to the submodule working tree, if up_path is specified, or to
435 * the superproject working tree otherwise.
436 *
437 * NEEDSWORK: This works incorrectly on the domain and protocol part.
438 * remote_url url outcome expectation
439 * http://a.com/b ../c http://a.com/c as is
440 * http://a.com/b/ ../c http://a.com/c same as previous line, but
441 * ignore trailing slash in url
442 * http://a.com/b ../../c http://c error out
443 * http://a.com/b ../../../c http:/c error out
444 * http://a.com/b ../../../../c http:c error out
445 * http://a.com/b ../../../../../c .:c error out
Derrick Stolee834e3522022-05-16 20:11:04 +0000446 * http://a.com/b http://d.org/e http://d.org/e as is
Derrick Stolee1d04e712022-05-16 20:11:03 +0000447 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
448 * when a local part has a colon in its path component, too.
449 */
450char *relative_url(const char *remote_url, const char *url,
451 const char *up_path);
452
Daniel Barkalow5751f492007-05-12 11:45:53 -0400453#endif