Update draft release notes to 1.8.3
[git/jnareb-git.git] / remote.h
blob8743d6ef9df69167c08f3ea9b79b91fbd6ab09d3
1 #ifndef REMOTE_H
2 #define REMOTE_H
4 enum {
5 REMOTE_CONFIG,
6 REMOTE_REMOTES,
7 REMOTE_BRANCHES
8 };
10 struct remote {
11 const char *name;
12 int origin;
14 const char *foreign_vcs;
16 const char **url;
17 int url_nr;
18 int url_alloc;
20 const char **pushurl;
21 int pushurl_nr;
22 int pushurl_alloc;
24 const char **push_refspec;
25 struct refspec *push;
26 int push_refspec_nr;
27 int push_refspec_alloc;
29 const char **fetch_refspec;
30 struct refspec *fetch;
31 int fetch_refspec_nr;
32 int fetch_refspec_alloc;
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
40 int fetch_tags;
41 int skip_default_update;
42 int mirror;
44 const char *receivepack;
45 const char *uploadpack;
48 * for curl remotes only
50 char *http_proxy;
53 struct remote *remote_get(const char *name);
54 int remote_is_configured(const char *name);
56 typedef int each_remote_fn(struct remote *remote, void *priv);
57 int for_each_remote(each_remote_fn fn, void *priv);
59 int remote_has_url(struct remote *remote, const char *url);
61 struct refspec {
62 unsigned force : 1;
63 unsigned pattern : 1;
64 unsigned matching : 1;
65 unsigned exact_sha1 : 1;
67 char *src;
68 char *dst;
71 extern const struct refspec *tag_refspec;
73 struct ref *alloc_ref(const char *name);
74 struct ref *copy_ref(const struct ref *ref);
75 struct ref *copy_ref_list(const struct ref *ref);
76 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
77 int ref_compare_name(const void *, const void *);
79 int check_ref_type(const struct ref *ref, int flags);
82 * Frees the entire list and peers of elements.
84 void free_refs(struct ref *ref);
86 int resolve_remote_symref(struct ref *ref, struct ref *list);
87 int ref_newer(const unsigned char *new_sha1, const unsigned char *old_sha1);
90 * Removes and frees any duplicate refs in the map.
92 void ref_remove_duplicates(struct ref *ref_map);
94 int valid_fetch_refspec(const char *refspec);
95 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
97 void free_refspec(int nr_refspec, struct refspec *refspec);
99 char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
100 const char *name);
102 int match_push_refs(struct ref *src, struct ref **dst,
103 int nr_refspec, const char **refspec, int all);
104 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
105 int force_update);
108 * Given a list of the remote refs and the specification of things to
109 * fetch, makes a (separate) list of the refs to fetch and the local
110 * refs to store into.
112 * *tail is the pointer to the tail pointer of the list of results
113 * beforehand, and will be set to the tail pointer of the list of
114 * results afterward.
116 * missing_ok is usually false, but when we are adding branch.$name.merge
117 * it is Ok if the branch is not at the remote anymore.
119 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
120 struct ref ***tail, int missing_ok);
122 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
125 * For the given remote, reads the refspec's src and sets the other fields.
127 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
129 struct branch {
130 const char *name;
131 const char *refname;
133 const char *remote_name;
134 struct remote *remote;
136 const char **merge_name;
137 struct refspec **merge;
138 int merge_nr;
139 int merge_alloc;
142 struct branch *branch_get(const char *name);
144 int branch_has_merge_config(struct branch *branch);
145 int branch_merge_matches(struct branch *, int n, const char *);
147 /* Flags to match_refs. */
148 enum match_refs_flags {
149 MATCH_REFS_NONE = 0,
150 MATCH_REFS_ALL = (1 << 0),
151 MATCH_REFS_MIRROR = (1 << 1),
152 MATCH_REFS_PRUNE = (1 << 2),
153 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
156 /* Reporting of tracking info */
157 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
158 int format_tracking_info(struct branch *branch, struct strbuf *sb);
160 struct ref *get_local_heads(void);
162 * Find refs from a list which are likely to be pointed to by the given HEAD
163 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
164 * list of all candidate refs. If no match is found (or 'head' is NULL),
165 * returns NULL. All returns are newly allocated and should be freed.
167 struct ref *guess_remote_head(const struct ref *head,
168 const struct ref *refs,
169 int all);
171 /* Return refs which no longer exist on remote */
172 struct ref *get_stale_heads(struct refspec *refs, int ref_count, struct ref *fetch_map);
174 #endif