remote.hon commit correct usage help string for git-hash-object (9ae8e00)
   1#ifndef REMOTE_H
   2#define REMOTE_H
   3
   4struct remote {
   5        const char *name;
   6
   7        const char **url;
   8        int url_nr;
   9        int url_alloc;
  10
  11        const char **push_refspec;
  12        struct refspec *push;
  13        int push_refspec_nr;
  14        int push_refspec_alloc;
  15
  16        const char **fetch_refspec;
  17        struct refspec *fetch;
  18        int fetch_refspec_nr;
  19        int fetch_refspec_alloc;
  20
  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;
  30
  31        const char *receivepack;
  32        const char *uploadpack;
  33
  34        /*
  35         * for curl remotes only
  36         */
  37        char *http_proxy;
  38};
  39
  40struct remote *remote_get(const char *name);
  41
  42typedef int each_remote_fn(struct remote *remote, void *priv);
  43int for_each_remote(each_remote_fn fn, void *priv);
  44
  45int remote_has_url(struct remote *remote, const char *url);
  46
  47struct refspec {
  48        unsigned force : 1;
  49        unsigned pattern : 1;
  50        unsigned matching : 1;
  51
  52        char *src;
  53        char *dst;
  54};
  55
  56extern const struct refspec *tag_refspec;
  57
  58struct ref *alloc_ref(unsigned namelen);
  59
  60struct ref *alloc_ref_from_str(const char* str);
  61
  62struct ref *copy_ref_list(const struct ref *ref);
  63
  64int check_ref_type(const struct ref *ref, int flags);
  65
  66/*
  67 * Frees the entire list and peers of elements.
  68 */
  69void free_refs(struct ref *ref);
  70
  71int resolve_remote_symref(struct ref *ref, struct ref *list);
  72
  73/*
  74 * Removes and frees any duplicate refs in the map.
  75 */
  76void ref_remove_duplicates(struct ref *ref_map);
  77
  78int valid_fetch_refspec(const char *refspec);
  79struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
  80struct refspec *parse_push_refspec(int nr_refspec, const char **refspec);
  81
  82int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
  83               int nr_refspec, const char **refspec, int all);
  84
  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 */
  97int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
  98                  struct ref ***tail, int missing_ok);
  99
 100struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
 101
 102/*
 103 * For the given remote, reads the refspec's src and sets the other fields.
 104 */
 105int remote_find_tracking(struct remote *remote, struct refspec *refspec);
 106
 107struct branch {
 108        const char *name;
 109        const char *refname;
 110
 111        const char *remote_name;
 112        struct remote *remote;
 113
 114        const char **merge_name;
 115        struct refspec **merge;
 116        int merge_nr;
 117        int merge_alloc;
 118};
 119
 120struct branch *branch_get(const char *name);
 121
 122int branch_has_merge_config(struct branch *branch);
 123int branch_merge_matches(struct branch *, int n, const char *);
 124
 125/* Flags to match_refs. */
 126enum match_refs_flags {
 127        MATCH_REFS_NONE         = 0,
 128        MATCH_REFS_ALL          = (1 << 0),
 129        MATCH_REFS_MIRROR       = (1 << 1),
 130};
 131
 132/* Reporting of tracking info */
 133int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
 134int format_tracking_info(struct branch *branch, struct strbuf *sb);
 135
 136#endif