stash: remove now superfluos help for "stash push"
[git.git] / remote.h
blob2ecf4c8c74ce590c9bcc917d997b3c7acf9c07c1
1 #ifndef REMOTE_H
2 #define REMOTE_H
4 #include "parse-options.h"
5 #include "hashmap.h"
7 enum {
8 REMOTE_UNCONFIGURED = 0,
9 REMOTE_CONFIG,
10 REMOTE_REMOTES,
11 REMOTE_BRANCHES
14 struct remote {
15 struct hashmap_entry ent; /* must be first */
17 const char *name;
18 int origin, configured_in_repo;
20 const char *foreign_vcs;
22 const char **url;
23 int url_nr;
24 int url_alloc;
26 const char **pushurl;
27 int pushurl_nr;
28 int pushurl_alloc;
30 const char **push_refspec;
31 struct refspec *push;
32 int push_refspec_nr;
33 int push_refspec_alloc;
35 const char **fetch_refspec;
36 struct refspec *fetch;
37 int fetch_refspec_nr;
38 int fetch_refspec_alloc;
41 * -1 to never fetch tags
42 * 0 to auto-follow tags on heuristic (default)
43 * 1 to always auto-follow tags
44 * 2 to always fetch tags
46 int fetch_tags;
47 int skip_default_update;
48 int mirror;
49 int prune;
51 const char *receivepack;
52 const char *uploadpack;
55 * for curl remotes only
57 char *http_proxy;
58 char *http_proxy_authmethod;
61 struct remote *remote_get(const char *name);
62 struct remote *pushremote_get(const char *name);
63 int remote_is_configured(struct remote *remote, int in_repo);
65 typedef int each_remote_fn(struct remote *remote, void *priv);
66 int for_each_remote(each_remote_fn fn, void *priv);
68 int remote_has_url(struct remote *remote, const char *url);
70 struct refspec {
71 unsigned force : 1;
72 unsigned pattern : 1;
73 unsigned matching : 1;
74 unsigned exact_sha1 : 1;
76 char *src;
77 char *dst;
80 extern const struct refspec *tag_refspec;
82 struct ref {
83 struct ref *next;
84 struct object_id old_oid;
85 struct object_id new_oid;
86 struct object_id old_oid_expect; /* used by expect-old */
87 char *symref;
88 unsigned int
89 force:1,
90 forced_update:1,
91 expect_old_sha1:1,
92 deletion:1;
94 enum {
95 REF_NOT_MATCHED = 0, /* initial value */
96 REF_MATCHED,
97 REF_UNADVERTISED_NOT_ALLOWED
98 } match_status;
101 * Order is important here, as we write to FETCH_HEAD
102 * in numeric order. And the default NOT_FOR_MERGE
103 * should be 0, so that xcalloc'd structures get it
104 * by default.
106 enum {
107 FETCH_HEAD_MERGE = -1,
108 FETCH_HEAD_NOT_FOR_MERGE = 0,
109 FETCH_HEAD_IGNORE = 1
110 } fetch_head_status;
112 enum {
113 REF_STATUS_NONE = 0,
114 REF_STATUS_OK,
115 REF_STATUS_REJECT_NONFASTFORWARD,
116 REF_STATUS_REJECT_ALREADY_EXISTS,
117 REF_STATUS_REJECT_NODELETE,
118 REF_STATUS_REJECT_FETCH_FIRST,
119 REF_STATUS_REJECT_NEEDS_FORCE,
120 REF_STATUS_REJECT_STALE,
121 REF_STATUS_REJECT_SHALLOW,
122 REF_STATUS_UPTODATE,
123 REF_STATUS_REMOTE_REJECT,
124 REF_STATUS_EXPECTING_REPORT,
125 REF_STATUS_ATOMIC_PUSH_FAILED
126 } status;
127 char *remote_status;
128 struct ref *peer_ref; /* when renaming */
129 char name[FLEX_ARRAY]; /* more */
132 #define REF_NORMAL (1u << 0)
133 #define REF_HEADS (1u << 1)
134 #define REF_TAGS (1u << 2)
136 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
138 struct ref *alloc_ref(const char *name);
139 struct ref *copy_ref(const struct ref *ref);
140 struct ref *copy_ref_list(const struct ref *ref);
141 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
142 extern int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
143 int ref_compare_name(const void *, const void *);
145 int check_ref_type(const struct ref *ref, int flags);
148 * Frees the entire list and peers of elements.
150 void free_refs(struct ref *ref);
152 struct oid_array;
153 extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
154 struct ref **list, unsigned int flags,
155 struct oid_array *extra_have,
156 struct oid_array *shallow);
158 int resolve_remote_symref(struct ref *ref, struct ref *list);
159 int ref_newer(const struct object_id *new_oid, const struct object_id *old_oid);
162 * Remove and free all but the first of any entries in the input list
163 * that map the same remote reference to the same local reference. If
164 * there are two entries that map different remote references to the
165 * same local reference, emit an error message and die. Return a
166 * pointer to the head of the resulting list.
168 struct ref *ref_remove_duplicates(struct ref *ref_map);
170 int valid_fetch_refspec(const char *refspec);
171 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
172 extern struct refspec *parse_push_refspec(int nr_refspec, const char **refspec);
174 void free_refspec(int nr_refspec, struct refspec *refspec);
176 extern int query_refspecs(struct refspec *specs, int nr, struct refspec *query);
177 char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
178 const char *name);
180 int check_push_refs(struct ref *src, int nr_refspec, const char **refspec);
181 int match_push_refs(struct ref *src, struct ref **dst,
182 int nr_refspec, const char **refspec, int all);
183 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
184 int force_update);
187 * Given a list of the remote refs and the specification of things to
188 * fetch, makes a (separate) list of the refs to fetch and the local
189 * refs to store into.
191 * *tail is the pointer to the tail pointer of the list of results
192 * beforehand, and will be set to the tail pointer of the list of
193 * results afterward.
195 * missing_ok is usually false, but when we are adding branch.$name.merge
196 * it is Ok if the branch is not at the remote anymore.
198 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
199 struct ref ***tail, int missing_ok);
201 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
204 * For the given remote, reads the refspec's src and sets the other fields.
206 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
208 struct branch {
209 const char *name;
210 const char *refname;
212 const char *remote_name;
213 const char *pushremote_name;
215 const char **merge_name;
216 struct refspec **merge;
217 int merge_nr;
218 int merge_alloc;
220 const char *push_tracking_ref;
223 struct branch *branch_get(const char *name);
224 const char *remote_for_branch(struct branch *branch, int *explicit);
225 const char *pushremote_for_branch(struct branch *branch, int *explicit);
227 int branch_has_merge_config(struct branch *branch);
228 int branch_merge_matches(struct branch *, int n, const char *);
231 * Return the fully-qualified refname of the tracking branch for `branch`.
232 * I.e., what "branch@{upstream}" would give you. Returns NULL if no
233 * upstream is defined.
235 * If `err` is not NULL and no upstream is defined, a more specific error
236 * message is recorded there (if the function does not return NULL, then
237 * `err` is not touched).
239 const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
242 * Return the tracking branch that corresponds to the ref we would push to
243 * given a bare `git push` while `branch` is checked out.
245 * The return value and `err` conventions match those of `branch_get_upstream`.
247 const char *branch_get_push(struct branch *branch, struct strbuf *err);
249 /* Flags to match_refs. */
250 enum match_refs_flags {
251 MATCH_REFS_NONE = 0,
252 MATCH_REFS_ALL = (1 << 0),
253 MATCH_REFS_MIRROR = (1 << 1),
254 MATCH_REFS_PRUNE = (1 << 2),
255 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
258 /* Reporting of tracking info */
259 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
260 const char **upstream_name);
261 int format_tracking_info(struct branch *branch, struct strbuf *sb);
263 struct ref *get_local_heads(void);
265 * Find refs from a list which are likely to be pointed to by the given HEAD
266 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
267 * list of all candidate refs. If no match is found (or 'head' is NULL),
268 * returns NULL. All returns are newly allocated and should be freed.
270 struct ref *guess_remote_head(const struct ref *head,
271 const struct ref *refs,
272 int all);
274 /* Return refs which no longer exist on remote */
275 struct ref *get_stale_heads(struct refspec *refs, int ref_count, struct ref *fetch_map);
278 * Compare-and-swap
280 #define CAS_OPT_NAME "force-with-lease"
282 struct push_cas_option {
283 unsigned use_tracking_for_rest:1;
284 struct push_cas {
285 struct object_id expect;
286 unsigned use_tracking:1;
287 char *refname;
288 } *entry;
289 int nr;
290 int alloc;
293 extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
295 extern int is_empty_cas(const struct push_cas_option *);
296 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
298 #endif