Documentation: minor grammatical fixes.
[git/kirr.git] / remote.h
bloba46a5be131caf1d1d71f97cab3c3ba2cebb6386c
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 **url;
15 int url_nr;
16 int url_alloc;
18 const char **push_refspec;
19 struct refspec *push;
20 int push_refspec_nr;
21 int push_refspec_alloc;
23 const char **fetch_refspec;
24 struct refspec *fetch;
25 int fetch_refspec_nr;
26 int fetch_refspec_alloc;
29 * -1 to never fetch tags
30 * 0 to auto-follow tags on heuristic (default)
31 * 1 to always auto-follow tags
32 * 2 to always fetch tags
34 int fetch_tags;
35 int skip_default_update;
36 int mirror;
38 const char *receivepack;
39 const char *uploadpack;
42 * for curl remotes only
44 char *http_proxy;
47 struct remote *remote_get(const char *name);
49 typedef int each_remote_fn(struct remote *remote, void *priv);
50 int for_each_remote(each_remote_fn fn, void *priv);
52 int remote_has_url(struct remote *remote, const char *url);
54 struct refspec {
55 unsigned force : 1;
56 unsigned pattern : 1;
57 unsigned matching : 1;
59 char *src;
60 char *dst;
63 extern const struct refspec *tag_refspec;
65 struct ref *alloc_ref(const char *name);
67 struct ref *copy_ref_list(const struct ref *ref);
69 int check_ref_type(const struct ref *ref, int flags);
72 * Frees the entire list and peers of elements.
74 void free_refs(struct ref *ref);
76 int resolve_remote_symref(struct ref *ref, struct ref *list);
79 * Removes and frees any duplicate refs in the map.
81 void ref_remove_duplicates(struct ref *ref_map);
83 int valid_fetch_refspec(const char *refspec);
84 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
86 int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
87 int nr_refspec, const char **refspec, int all);
90 * Given a list of the remote refs and the specification of things to
91 * fetch, makes a (separate) list of the refs to fetch and the local
92 * refs to store into.
94 * *tail is the pointer to the tail pointer of the list of results
95 * beforehand, and will be set to the tail pointer of the list of
96 * results afterward.
98 * missing_ok is usually false, but when we are adding branch.$name.merge
99 * it is Ok if the branch is not at the remote anymore.
101 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
102 struct ref ***tail, int missing_ok);
104 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
107 * For the given remote, reads the refspec's src and sets the other fields.
109 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
111 struct branch {
112 const char *name;
113 const char *refname;
115 const char *remote_name;
116 struct remote *remote;
118 const char **merge_name;
119 struct refspec **merge;
120 int merge_nr;
121 int merge_alloc;
124 struct branch *branch_get(const char *name);
126 int branch_has_merge_config(struct branch *branch);
127 int branch_merge_matches(struct branch *, int n, const char *);
129 /* Flags to match_refs. */
130 enum match_refs_flags {
131 MATCH_REFS_NONE = 0,
132 MATCH_REFS_ALL = (1 << 0),
133 MATCH_REFS_MIRROR = (1 << 1),
136 /* Reporting of tracking info */
137 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
138 int format_tracking_info(struct branch *branch, struct strbuf *sb);
140 #endif