🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.20.2 / . / remote.h
blob: da53ad570b91dbd4a820ffc79541fb0a4915ff6b [file] [log] [blame]
Daniel Barkalow5751f492007-05-12 15:45:53[diff] [blame]1#ifndef REMOTE_H
2#define REMOTE_H
3
Elijah Newrenef3ca952018-08-15 17:54:05[diff] [blame]4#include "cache.h"
Junio C Hamano28f5d172013-07-08 22:34:36[diff] [blame]5#include "parse-options.h"
Patrick Reynoldsd0da0032014-07-29 14:43:39[diff] [blame]6#include "hashmap.h"
Brandon Williams6bdb3042018-05-16 22:58:00[diff] [blame]7#include "refspec.h"
Junio C Hamano28f5d172013-07-08 22:34:36[diff] [blame]8
Miklos Vajna89cf4c72008-11-10 20:43:00[diff] [blame]9enum {
Thomas Gummerer674468b2016-02-16 09:47:50[diff] [blame]10 REMOTE_UNCONFIGURED = 0,
Miklos Vajna89cf4c72008-11-10 20:43:00[diff] [blame]11 REMOTE_CONFIG,
12 REMOTE_REMOTES,
13 REMOTE_BRANCHES
14};
15
Daniel Barkalow5751f492007-05-12 15:45:53[diff] [blame]16struct remote {
Patrick Reynoldsd0da0032014-07-29 14:43:39[diff] [blame]17 struct hashmap_entry ent; /* must be first */
18
Daniel Barkalow5751f492007-05-12 15:45:53[diff] [blame]19 const char *name;
Johannes Schindeline459b072017-01-19 21:20:02[diff] [blame]20 int origin, configured_in_repo;
Daniel Barkalow5751f492007-05-12 15:45:53[diff] [blame]21
Daniel Barkalowc578f512009-11-18 01:42:25[diff] [blame]22 const char *foreign_vcs;
23
Shawn O. Pearce28b91f82007-09-19 04:49:27[diff] [blame]24 const char **url;
25 int url_nr;
Daniel Barkalow2d313472008-02-19 04:41:41[diff] [blame]26 int url_alloc;
Daniel Barkalow5751f492007-05-12 15:45:53[diff] [blame]27
Michael J Gruber20346232009-06-09 16:01:34[diff] [blame]28 const char **pushurl;
29 int pushurl_nr;
30 int pushurl_alloc;
31
Brandon Williams6bdb3042018-05-16 22:58:00[diff] [blame]32 struct refspec push;
Daniel Barkalow5751f492007-05-12 15:45:53[diff] [blame]33
Brandon Williamse5349ab2018-05-16 22:58:01[diff] [blame]34 struct refspec fetch;
Daniel Barkalow5d46c9d2007-05-12 15:46:03[diff] [blame]35
Daniel Barkalowd71ab172007-09-11 03:03:08[diff] [blame]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;
Johannes Schindelin211c8962008-02-29 01:45:45[diff] [blame]43 int skip_default_update;
Paolo Bonzini84bb2df2008-04-17 11:17:20[diff] [blame]44 int mirror;
Michael Schubert737c5a92013-07-13 09:36:24[diff] [blame]45 int prune;
Ævar Arnfjörð Bjarmason97716d22018-02-09 20:32:15[diff] [blame]46 int prune_tags;
Daniel Barkalowd71ab172007-09-11 03:03:08[diff] [blame]47
Daniel Barkalow5751f492007-05-12 15:45:53[diff] [blame]48 const char *receivepack;
Daniel Barkalow0012ba22007-09-11 03:02:51[diff] [blame]49 const char *uploadpack;
Sam Vilain14c98212007-12-03 21:48:54[diff] [blame]50
51 /*
52 * for curl remotes only
53 */
54 char *http_proxy;
Knut Frankeef976392016-01-26 13:02:47[diff] [blame]55 char *http_proxy_authmethod;
Daniel Barkalow5751f492007-05-12 15:45:53[diff] [blame]56};
57
58struct remote *remote_get(const char *name);
Ramkumar Ramachandraf24f7152013-04-02 07:40:32[diff] [blame]59struct remote *pushremote_get(const char *name);
Johannes Schindeline459b072017-01-19 21:20:02[diff] [blame]60int remote_is_configured(struct remote *remote, int in_repo);
Daniel Barkalow5751f492007-05-12 15:45:53[diff] [blame]61
Johannes Schindelinb42f6922007-07-10 17:48:40[diff] [blame]62typedef int each_remote_fn(struct remote *remote, void *priv);
63int for_each_remote(each_remote_fn fn, void *priv);
64
Shawn O. Pearce28b91f82007-09-19 04:49:27[diff] [blame]65int remote_has_url(struct remote *remote, const char *url);
Daniel Barkalow5d46c9d2007-05-12 15:46:03[diff] [blame]66
Junio C Hamano47a59182013-07-08 20:56:53[diff] [blame]67struct ref {
68 struct ref *next;
brian m. carlsonf4e54d02015-11-10 02:22:20[diff] [blame]69 struct object_id old_oid;
70 struct object_id new_oid;
71 struct object_id old_oid_expect; /* used by expect-old */
Junio C Hamano47a59182013-07-08 20:56:53[diff] [blame]72 char *symref;
73 unsigned int
74 force:1,
75 forced_update:1,
Junio C Hamano91048a92013-07-09 18:01:06[diff] [blame]76 expect_old_sha1:1,
Brandon Williams73302052018-06-27 22:30:23[diff] [blame]77 exact_oid:1,
Matt McCutchend56583d2017-02-22 16:05:57[diff] [blame]78 deletion:1;
79
80 enum {
81 REF_NOT_MATCHED = 0, /* initial value */
82 REF_MATCHED,
83 REF_UNADVERTISED_NOT_ALLOWED
84 } match_status;
Junio C Hamano47a59182013-07-08 20:56:53[diff] [blame]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,
Junio C Hamano631b5ef2013-07-08 21:42:40[diff] [blame]106 REF_STATUS_REJECT_STALE,
Nguyễn Thái Ngọc Duy4820a332013-12-05 13:02:40[diff] [blame]107 REF_STATUS_REJECT_SHALLOW,
Junio C Hamano47a59182013-07-08 20:56:53[diff] [blame]108 REF_STATUS_UPTODATE,
109 REF_STATUS_REMOTE_REJECT,
Ronnie Sahlberg4ff17f12015-01-08 03:23:22[diff] [blame]110 REF_STATUS_EXPECTING_REPORT,
111 REF_STATUS_ATOMIC_PUSH_FAILED
Junio C Hamano47a59182013-07-08 20:56:53[diff] [blame]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
122extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
123
René Scharfe59c69c02008-10-18 08:44:18[diff] [blame]124struct ref *alloc_ref(const char *name);
Jeff King59a57752011-06-07 23:03:03[diff] [blame]125struct ref *copy_ref(const struct ref *ref);
Daniel Barkalow45773702007-10-30 01:05:40[diff] [blame]126struct ref *copy_ref_list(const struct ref *ref);
Jeff Kinged81c762012-05-21 22:19:28[diff] [blame]127void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
Junio C Hamanoca024652013-12-03 23:41:15[diff] [blame]128extern int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
Jeff Kinged81c762012-05-21 22:19:28[diff] [blame]129int ref_compare_name(const void *, const void *);
Daniel Barkalow45773702007-10-30 01:05:40[diff] [blame]130
131int check_ref_type(const struct ref *ref, int flags);
132
Daniel Barkalowdfd255d2007-07-10 04:47:23[diff] [blame]133/*
134 * Frees the entire list and peers of elements.
135 */
136void free_refs(struct ref *ref);
137
brian m. carlson910650d2017-03-31 01:40:00[diff] [blame]138struct oid_array;
Brandon Williamsad6ac122018-03-14 18:31:45[diff] [blame]139struct packet_reader;
Brandon Williamse52449b2018-03-15 17:31:21[diff] [blame]140struct argv_array;
Brandon Williamsff473222018-04-23 22:46:23[diff] [blame]141struct string_list;
Brandon Williamsad6ac122018-03-14 18:31:45[diff] [blame]142extern struct ref **get_remote_heads(struct packet_reader *reader,
Junio C Hamano47a59182013-07-08 20:56:53[diff] [blame]143 struct ref **list, unsigned int flags,
brian m. carlson910650d2017-03-31 01:40:00[diff] [blame]144 struct oid_array *extra_have,
Brandon Williamsad6ac122018-03-14 18:31:45[diff] [blame]145 struct oid_array *shallow_points);
Junio C Hamano47a59182013-07-08 20:56:53[diff] [blame]146
Brandon Williamse52449b2018-03-15 17:31:21[diff] [blame]147/* Used for protocol v2 in order to retrieve refs from a remote */
148extern struct ref **get_remote_refs(int fd_out, struct packet_reader *reader,
149 struct ref **list, int for_push,
Brandon Williamsff473222018-04-23 22:46:23[diff] [blame]150 const struct argv_array *ref_prefixes,
151 const struct string_list *server_options);
Junio C Hamano47a59182013-07-08 20:56:53[diff] [blame]152
Daniel Barkalowbe885d92008-04-26 19:53:12[diff] [blame]153int resolve_remote_symref(struct ref *ref, struct ref *list);
Daniel Barkalowbe885d92008-04-26 19:53:12[diff] [blame]154
Daniel Barkalow2467a4f2007-10-08 04:25:07[diff] [blame]155/*
Michael Haggertyb9afe662013-10-30 05:33:09[diff] [blame]156 * Remove and free all but the first of any entries in the input list
157 * that map the same remote reference to the same local reference. If
158 * there are two entries that map different remote references to the
159 * same local reference, emit an error message and die. Return a
160 * pointer to the head of the resulting list.
Daniel Barkalow2467a4f2007-10-08 04:25:07[diff] [blame]161 */
Michael Haggertyb9afe662013-10-30 05:33:09[diff] [blame]162struct ref *ref_remove_duplicates(struct ref *ref_map);
Daniel Barkalow2467a4f2007-10-08 04:25:07[diff] [blame]163
Brandon Williams86baf822018-05-16 22:58:12[diff] [blame]164int query_refspecs(struct refspec *rs, struct refspec_item *query);
Brandon Williamsd0004142018-05-16 22:58:11[diff] [blame]165char *apply_refspecs(struct refspec *rs, const char *name);
Daniel Barkalowd71ab172007-09-11 03:03:08[diff] [blame]166
Brandon Williamsafb1aed2018-05-16 22:58:22[diff] [blame]167int check_push_refs(struct ref *src, struct refspec *rs);
Junio C Hamano29753cd2011-09-09 18:54:58[diff] [blame]168int match_push_refs(struct ref *src, struct ref **dst,
Brandon Williams5c7ec842018-05-16 22:58:21[diff] [blame]169 struct refspec *rs, int flags);
Tay Ray Chuan20e8b462010-01-08 02:12:42[diff] [blame]170void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
171 int force_update);
Daniel Barkalow6b628162007-05-12 15:45:59[diff] [blame]172
Daniel Barkalow5d46c9d2007-05-12 15:46:03[diff] [blame]173/*
Daniel Barkalowd71ab172007-09-11 03:03:08[diff] [blame]174 * Given a list of the remote refs and the specification of things to
175 * fetch, makes a (separate) list of the refs to fetch and the local
176 * refs to store into.
177 *
178 * *tail is the pointer to the tail pointer of the list of results
179 * beforehand, and will be set to the tail pointer of the list of
180 * results afterward.
Junio C Hamano9ad7c5a2007-10-27 06:09:48[diff] [blame]181 *
182 * missing_ok is usually false, but when we are adding branch.$name.merge
183 * it is Ok if the branch is not at the remote anymore.
Daniel Barkalowd71ab172007-09-11 03:03:08[diff] [blame]184 */
Brandon Williams0ad4a5f2018-05-16 22:57:49[diff] [blame]185int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec,
Junio C Hamano9ad7c5a2007-10-27 06:09:48[diff] [blame]186 struct ref ***tail, int missing_ok);
Daniel Barkalowd71ab172007-09-11 03:03:08[diff] [blame]187
Daniel Barkalow45773702007-10-30 01:05:40[diff] [blame]188struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
Daniel Barkalowd71ab172007-09-11 03:03:08[diff] [blame]189
190/*
Daniel Barkalow5d46c9d2007-05-12 15:46:03[diff] [blame]191 * For the given remote, reads the refspec's src and sets the other fields.
192 */
Brandon Williams0ad4a5f2018-05-16 22:57:49[diff] [blame]193int remote_find_tracking(struct remote *remote, struct refspec_item *refspec);
Daniel Barkalow5d46c9d2007-05-12 15:46:03[diff] [blame]194
Daniel Barkalowcf818342007-09-11 03:02:56[diff] [blame]195struct branch {
196 const char *name;
197 const char *refname;
198
199 const char *remote_name;
Jeff Kingda66b272015-05-21 04:45:20[diff] [blame]200 const char *pushremote_name;
Daniel Barkalowcf818342007-09-11 03:02:56[diff] [blame]201
202 const char **merge_name;
Brandon Williams0ad4a5f2018-05-16 22:57:49[diff] [blame]203 struct refspec_item **merge;
Daniel Barkalowcf818342007-09-11 03:02:56[diff] [blame]204 int merge_nr;
Daniel Barkalow2d313472008-02-19 04:41:41[diff] [blame]205 int merge_alloc;
Jeff Kinge291c752015-05-21 04:45:36[diff] [blame]206
207 const char *push_tracking_ref;
Daniel Barkalowcf818342007-09-11 03:02:56[diff] [blame]208};
209
210struct branch *branch_get(const char *name);
Jeff Kingf0521542015-05-21 04:45:16[diff] [blame]211const char *remote_for_branch(struct branch *branch, int *explicit);
Jeff Kingda66b272015-05-21 04:45:20[diff] [blame]212const char *pushremote_for_branch(struct branch *branch, int *explicit);
J Wyman9700fae2017-11-07 16:31:08[diff] [blame]213const char *remote_ref_for_branch(struct branch *branch, int for_push,
214 int *explicit);
Daniel Barkalowcf818342007-09-11 03:02:56[diff] [blame]215
216int branch_has_merge_config(struct branch *branch);
Shawn O. Pearce85682c12007-09-18 08:54:53[diff] [blame]217int branch_merge_matches(struct branch *, int n, const char *);
Daniel Barkalowcf818342007-09-11 03:02:56[diff] [blame]218
Jeff Kinga9f9f8c2015-05-21 04:45:28[diff] [blame]219/**
220 * Return the fully-qualified refname of the tracking branch for `branch`.
221 * I.e., what "branch@{upstream}" would give you. Returns NULL if no
222 * upstream is defined.
Jeff King3a429d02015-05-21 04:45:32[diff] [blame]223 *
224 * If `err` is not NULL and no upstream is defined, a more specific error
225 * message is recorded there (if the function does not return NULL, then
226 * `err` is not touched).
Jeff Kinga9f9f8c2015-05-21 04:45:28[diff] [blame]227 */
Jeff King3a429d02015-05-21 04:45:32[diff] [blame]228const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
Jeff Kinga9f9f8c2015-05-21 04:45:28[diff] [blame]229
Jeff Kinge291c752015-05-21 04:45:36[diff] [blame]230/**
231 * Return the tracking branch that corresponds to the ref we would push to
232 * given a bare `git push` while `branch` is checked out.
233 *
234 * The return value and `err` conventions match those of `branch_get_upstream`.
235 */
236const char *branch_get_push(struct branch *branch, struct strbuf *err);
237
Andy Whitcroft28b9d6e2007-11-09 23:32:10[diff] [blame]238/* Flags to match_refs. */
239enum match_refs_flags {
240 MATCH_REFS_NONE = 0,
241 MATCH_REFS_ALL = (1 << 0),
Felipe Contreras6ddba5e2012-02-22 22:43:41[diff] [blame]242 MATCH_REFS_MIRROR = (1 << 1),
Junio C Hamanoc2aba152013-03-04 20:09:50[diff] [blame]243 MATCH_REFS_PRUNE = (1 << 2),
244 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
Andy Whitcroft28b9d6e2007-11-09 23:32:10[diff] [blame]245};
246
Jeff Hostetlerd7d1b492018-01-09 18:50:15[diff] [blame]247/* Flags for --ahead-behind option. */
248enum ahead_behind_flags {
Jeff Hostetlerfd9b5442018-01-09 18:50:16[diff] [blame]249 AHEAD_BEHIND_UNSPECIFIED = -1,
250 AHEAD_BEHIND_QUICK = 0, /* just eq/neq reporting */
251 AHEAD_BEHIND_FULL = 1, /* traditional a/b reporting */
Jeff Hostetlerd7d1b492018-01-09 18:50:15[diff] [blame]252};
253
Junio C Hamano6d21bf92008-07-02 07:51:18[diff] [blame]254/* Reporting of tracking info */
Jeff King979cb242015-05-22 00:49:11[diff] [blame]255int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
Jeff Hostetlerd7d1b492018-01-09 18:50:15[diff] [blame]256 const char **upstream_name, enum ahead_behind_flags abf);
Jeff Hostetlerf39a7572018-01-09 18:50:18[diff] [blame]257int format_tracking_info(struct branch *branch, struct strbuf *sb,
258 enum ahead_behind_flags abf);
Junio C Hamano6d21bf92008-07-02 07:51:18[diff] [blame]259
Jay Soffian454e2022009-02-25 08:32:11[diff] [blame]260struct ref *get_local_heads(void);
Jay Soffian6cb4e6c2009-02-25 08:32:14[diff] [blame]261/*
Jay Soffian4229f1f2009-02-27 19:10:05[diff] [blame]262 * Find refs from a list which are likely to be pointed to by the given HEAD
263 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
264 * list of all candidate refs. If no match is found (or 'head' is NULL),
265 * returns NULL. All returns are newly allocated and should be freed.
Jay Soffian6cb4e6c2009-02-25 08:32:14[diff] [blame]266 */
Jay Soffian4229f1f2009-02-27 19:10:05[diff] [blame]267struct ref *guess_remote_head(const struct ref *head,
268 const struct ref *refs,
269 int all);
270
Jay Soffianf2ef6072009-11-10 05:03:31[diff] [blame]271/* Return refs which no longer exist on remote */
Brandon Williamsa2ac50c2018-05-16 22:58:10[diff] [blame]272struct ref *get_stale_heads(struct refspec *rs, struct ref *fetch_map);
Jay Soffianf2ef6072009-11-10 05:03:31[diff] [blame]273
Junio C Hamano28f5d172013-07-08 22:34:36[diff] [blame]274/*
275 * Compare-and-swap
276 */
277#define CAS_OPT_NAME "force-with-lease"
278
279struct push_cas_option {
280 unsigned use_tracking_for_rest:1;
281 struct push_cas {
brian m. carlsonb8566f82017-07-13 23:49:21[diff] [blame]282 struct object_id expect;
Junio C Hamano28f5d172013-07-08 22:34:36[diff] [blame]283 unsigned use_tracking:1;
284 char *refname;
285 } *entry;
286 int nr;
287 int alloc;
288};
289
290extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
Junio C Hamano28f5d172013-07-08 22:34:36[diff] [blame]291
Junio C Hamano91048a92013-07-09 18:01:06[diff] [blame]292extern int is_empty_cas(const struct push_cas_option *);
293void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
294
Daniel Barkalow5751f492007-05-12 15:45:53[diff] [blame]295#endif