git-add documentation: Fix shell quoting example
[git/gitweb.git] / remote.h
blob6878c52ce0e3fa57693e919a9cdb66748bb6e6e3
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;
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
27 int fetch_tags;
28 int skip_default_update;
29 int mirror;
31 const char *receivepack;
32 const char *uploadpack;
35 * for curl remotes only
37 char *http_proxy;
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;
51 char *src;
52 char *dst;
55 struct ref *alloc_ref(unsigned namelen);
57 struct ref *copy_ref_list(const struct ref *ref);
59 int check_ref_type(const struct ref *ref, int flags);
62 * Frees the entire list and peers of elements.
64 void free_refs(struct ref *ref);
67 * Removes and frees any duplicate refs in the map.
69 void ref_remove_duplicates(struct ref *ref_map);
71 int valid_fetch_refspec(const char *refspec);
72 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
73 struct refspec *parse_push_refspec(int nr_refspec, const char **refspec);
75 int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
76 int nr_refspec, const char **refspec, int all);
79 * Given a list of the remote refs and the specification of things to
80 * fetch, makes a (separate) list of the refs to fetch and the local
81 * refs to store into.
83 * *tail is the pointer to the tail pointer of the list of results
84 * beforehand, and will be set to the tail pointer of the list of
85 * results afterward.
87 * missing_ok is usually false, but when we are adding branch.$name.merge
88 * it is Ok if the branch is not at the remote anymore.
90 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
91 struct ref ***tail, int missing_ok);
93 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
96 * For the given remote, reads the refspec's src and sets the other fields.
98 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
100 struct branch {
101 const char *name;
102 const char *refname;
104 const char *remote_name;
105 struct remote *remote;
107 const char **merge_name;
108 struct refspec **merge;
109 int merge_nr;
110 int merge_alloc;
113 struct branch *branch_get(const char *name);
115 int branch_has_merge_config(struct branch *branch);
116 int branch_merge_matches(struct branch *, int n, const char *);
118 /* Flags to match_refs. */
119 enum match_refs_flags {
120 MATCH_REFS_NONE = 0,
121 MATCH_REFS_ALL = (1 << 0),
122 MATCH_REFS_MIRROR = (1 << 1),
125 #endif