gitweb: Update and improve gitweb/README file
[git/repo.git] / remote.h
blobb10036cae6f89e087da56979e2248e1e5c5d42d3
1 #ifndef REMOTE_H
2 #define REMOTE_H
4 struct remote {
5 const char *name;
7 const char **url;
8 int url_nr;
10 const char **push_refspec;
11 struct refspec *push;
12 int push_refspec_nr;
14 const char **fetch_refspec;
15 struct refspec *fetch;
16 int fetch_refspec_nr;
19 * -1 to never fetch tags
20 * 0 to auto-follow tags on heuristic (default)
21 * 1 to always auto-follow tags
22 * 2 to always fetch tags
24 int fetch_tags;
26 const char *receivepack;
27 const char *uploadpack;
30 struct remote *remote_get(const char *name);
32 typedef int each_remote_fn(struct remote *remote, void *priv);
33 int for_each_remote(each_remote_fn fn, void *priv);
35 int remote_has_url(struct remote *remote, const char *url);
37 struct refspec {
38 unsigned force : 1;
39 unsigned pattern : 1;
41 char *src;
42 char *dst;
45 struct ref *alloc_ref(unsigned namelen);
47 struct ref *copy_ref_list(const struct ref *ref);
49 int check_ref_type(const struct ref *ref, int flags);
52 * Frees the entire list and peers of elements.
54 void free_refs(struct ref *ref);
57 * Removes and frees any duplicate refs in the map.
59 void ref_remove_duplicates(struct ref *ref_map);
61 struct refspec *parse_ref_spec(int nr_refspec, const char **refspec);
63 int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
64 int nr_refspec, const char **refspec, int all);
67 * Given a list of the remote refs and the specification of things to
68 * fetch, makes a (separate) list of the refs to fetch and the local
69 * refs to store into.
71 * *tail is the pointer to the tail pointer of the list of results
72 * beforehand, and will be set to the tail pointer of the list of
73 * results afterward.
75 * missing_ok is usually false, but when we are adding branch.$name.merge
76 * it is Ok if the branch is not at the remote anymore.
78 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
79 struct ref ***tail, int missing_ok);
81 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
84 * For the given remote, reads the refspec's src and sets the other fields.
86 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
88 struct branch {
89 const char *name;
90 const char *refname;
92 const char *remote_name;
93 struct remote *remote;
95 const char **merge_name;
96 struct refspec **merge;
97 int merge_nr;
100 struct branch *branch_get(const char *name);
102 int branch_has_merge_config(struct branch *branch);
103 int branch_merge_matches(struct branch *, int n, const char *);
105 /* Flags to match_refs. */
106 enum match_refs_flags {
107 MATCH_REFS_NONE = 0,
108 MATCH_REFS_ALL = (1 << 0),
109 MATCH_REFS_MIRROR = (1 << 1),
112 #endif