]> git.ipfire.org Git - thirdparty/git.git/blame - remote.h
Documentation/git-archive: spell --worktree-attributes correctly
[thirdparty/git.git] / remote.h
CommitLineData
5751f490
DB
1#ifndef REMOTE_H
2#define REMOTE_H
3
89cf4c70
MV
4enum {
5 REMOTE_CONFIG,
6 REMOTE_REMOTES,
7 REMOTE_BRANCHES
8};
9
5751f490
DB
10struct remote {
11 const char *name;
89cf4c70 12 int origin;
5751f490 13
c578f51d
DB
14 const char *foreign_vcs;
15
28b91f8a
SP
16 const char **url;
17 int url_nr;
2d31347b 18 int url_alloc;
5751f490 19
20346234
MG
20 const char **pushurl;
21 int pushurl_nr;
22 int pushurl_alloc;
23
5751f490 24 const char **push_refspec;
6b62816c 25 struct refspec *push;
5751f490 26 int push_refspec_nr;
2d31347b 27 int push_refspec_alloc;
5751f490 28
5d46c9d4
DB
29 const char **fetch_refspec;
30 struct refspec *fetch;
31 int fetch_refspec_nr;
2d31347b 32 int fetch_refspec_alloc;
5d46c9d4 33
d71ab174
DB
34 /*
35 * -1 to never fetch tags
36 * 0 to auto-follow tags on heuristic (default)
37 * 1 to always auto-follow tags
38 * 2 to always fetch tags
39 */
40 int fetch_tags;
211c8968 41 int skip_default_update;
84bb2dfd 42 int mirror;
d71ab174 43
5751f490 44 const char *receivepack;
0012ba21 45 const char *uploadpack;
14c98218
SV
46
47 /*
48 * for curl remotes only
49 */
50 char *http_proxy;
5751f490
DB
51};
52
53struct remote *remote_get(const char *name);
9a23ba33 54int remote_is_configured(const char *name);
5751f490 55
b42f6927
JS
56typedef int each_remote_fn(struct remote *remote, void *priv);
57int for_each_remote(each_remote_fn fn, void *priv);
58
28b91f8a 59int remote_has_url(struct remote *remote, const char *url);
5d46c9d4 60
6b62816c
DB
61struct refspec {
62 unsigned force : 1;
63 unsigned pattern : 1;
a83619d6 64 unsigned matching : 1;
6b62816c 65
b42f6927 66 char *src;
6b62816c
DB
67 char *dst;
68};
69
e0aaa29f
DB
70extern const struct refspec *tag_refspec;
71
59c69c0c 72struct ref *alloc_ref(const char *name);
737922aa 73
4577370e
DB
74struct ref *copy_ref_list(const struct ref *ref);
75
76int check_ref_type(const struct ref *ref, int flags);
77
dfd255dd
DB
78/*
79 * Frees the entire list and peers of elements.
80 */
81void free_refs(struct ref *ref);
82
be885d96 83int resolve_remote_symref(struct ref *ref, struct ref *list);
ec8452d5 84int ref_newer(const unsigned char *new_sha1, const unsigned char *old_sha1);
be885d96 85
2467a4fa
DB
86/*
87 * Removes and frees any duplicate refs in the map.
88 */
89void ref_remove_duplicates(struct ref *ref_map);
90
24b6177e 91int valid_fetch_refspec(const char *refspec);
46220ca1 92struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
d71ab174 93
72ff8943
DB
94void free_refspec(int nr_refspec, struct refspec *refspec);
95
96char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
97 const char *name);
98
6d2bf96e 99int match_refs(struct ref *src, struct ref **dst,
4577370e 100 int nr_refspec, const char **refspec, int all);
20e8b465
TRC
101void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
102 int force_update);
6b62816c 103
d71ab174
DB
104/*
105 * Given a list of the remote refs and the specification of things to
106 * fetch, makes a (separate) list of the refs to fetch and the local
107 * refs to store into.
108 *
109 * *tail is the pointer to the tail pointer of the list of results
110 * beforehand, and will be set to the tail pointer of the list of
111 * results afterward.
9ad7c5ae
JH
112 *
113 * missing_ok is usually false, but when we are adding branch.$name.merge
114 * it is Ok if the branch is not at the remote anymore.
d71ab174 115 */
4577370e 116int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
9ad7c5ae 117 struct ref ***tail, int missing_ok);
d71ab174 118
4577370e 119struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
d71ab174 120
5d46c9d4
DB
121/*
122 * For the given remote, reads the refspec's src and sets the other fields.
123 */
124int remote_find_tracking(struct remote *remote, struct refspec *refspec);
125
cf818348
DB
126struct branch {
127 const char *name;
128 const char *refname;
129
130 const char *remote_name;
131 struct remote *remote;
132
133 const char **merge_name;
134 struct refspec **merge;
135 int merge_nr;
2d31347b 136 int merge_alloc;
cf818348
DB
137};
138
139struct branch *branch_get(const char *name);
140
141int branch_has_merge_config(struct branch *branch);
85682c19 142int branch_merge_matches(struct branch *, int n, const char *);
cf818348 143
28b9d6e5
AW
144/* Flags to match_refs. */
145enum match_refs_flags {
146 MATCH_REFS_NONE = 0,
147 MATCH_REFS_ALL = (1 << 0),
148 MATCH_REFS_MIRROR = (1 << 1),
149};
150
6d21bf96
JH
151/* Reporting of tracking info */
152int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
153int format_tracking_info(struct branch *branch, struct strbuf *sb);
154
454e2025 155struct ref *get_local_heads(void);
8ef51733 156/*
4229f1fa
JS
157 * Find refs from a list which are likely to be pointed to by the given HEAD
158 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
159 * list of all candidate refs. If no match is found (or 'head' is NULL),
160 * returns NULL. All returns are newly allocated and should be freed.
8ef51733 161 */
4229f1fa
JS
162struct ref *guess_remote_head(const struct ref *head,
163 const struct ref *refs,
164 int all);
165
f2ef6075
JS
166/* Return refs which no longer exist on remote */
167struct ref *get_stale_heads(struct remote *remote, struct ref *fetch_map);
168
5751f490 169#endif