Code

api-parse-options.txt: Introduce documentation for parse options API
[git.git] / remote.h
1 #ifndef REMOTE_H
2 #define REMOTE_H
4 struct remote {
5         const char *name;
7         const char **url;
8         int url_nr;
9         int url_alloc;
11         const char **push_refspec;
12         struct refspec *push;
13         int push_refspec_nr;
14         int push_refspec_alloc;
16         const char **fetch_refspec;
17         struct refspec *fetch;
18         int fetch_refspec_nr;
19         int fetch_refspec_alloc;
21         /*
22          * -1 to never fetch tags
23          * 0 to auto-follow tags on heuristic (default)
24          * 1 to always auto-follow tags
25          * 2 to always fetch tags
26          */
27         int fetch_tags;
28         int skip_default_update;
29         int mirror;
31         const char *receivepack;
32         const char *uploadpack;
34         /*
35          * for curl remotes only
36          */
37         char *http_proxy;
38 };
40 struct remote *remote_get(const char *name);
42 typedef int each_remote_fn(struct remote *remote, void *priv);
43 int for_each_remote(each_remote_fn fn, void *priv);
45 int remote_has_url(struct remote *remote, const char *url);
47 struct refspec {
48         unsigned force : 1;
49         unsigned pattern : 1;
50         unsigned matching : 1;
52         char *src;
53         char *dst;
54 };
56 extern const struct refspec *tag_refspec;
58 struct ref *alloc_ref(unsigned namelen);
60 struct ref *alloc_ref_from_str(const char* str);
62 struct ref *copy_ref_list(const struct ref *ref);
64 int check_ref_type(const struct ref *ref, int flags);
66 /*
67  * Frees the entire list and peers of elements.
68  */
69 void free_refs(struct ref *ref);
71 int resolve_remote_symref(struct ref *ref, struct ref *list);
73 /*
74  * Removes and frees any duplicate refs in the map.
75  */
76 void ref_remove_duplicates(struct ref *ref_map);
78 int valid_fetch_refspec(const char *refspec);
79 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
80 struct refspec *parse_push_refspec(int nr_refspec, const char **refspec);
82 int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
83                int nr_refspec, const char **refspec, int all);
85 /*
86  * Given a list of the remote refs and the specification of things to
87  * fetch, makes a (separate) list of the refs to fetch and the local
88  * refs to store into.
89  *
90  * *tail is the pointer to the tail pointer of the list of results
91  * beforehand, and will be set to the tail pointer of the list of
92  * results afterward.
93  *
94  * missing_ok is usually false, but when we are adding branch.$name.merge
95  * it is Ok if the branch is not at the remote anymore.
96  */
97 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
98                   struct ref ***tail, int missing_ok);
100 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
102 /*
103  * For the given remote, reads the refspec's src and sets the other fields.
104  */
105 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
107 struct branch {
108         const char *name;
109         const char *refname;
111         const char *remote_name;
112         struct remote *remote;
114         const char **merge_name;
115         struct refspec **merge;
116         int merge_nr;
117         int merge_alloc;
118 };
120 struct branch *branch_get(const char *name);
122 int branch_has_merge_config(struct branch *branch);
123 int branch_merge_matches(struct branch *, int n, const char *);
125 /* Flags to match_refs. */
126 enum match_refs_flags {
127         MATCH_REFS_NONE         = 0,
128         MATCH_REFS_ALL          = (1 << 0),
129         MATCH_REFS_MIRROR       = (1 << 1),
130 };
132 #endif