remote.hon commit Documentation/git-checkout: Update summary to reflect current abilities (76ce946)
   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
  30        const char *receivepack;
  31        const char *uploadpack;
  32
  33        /*
  34         * for curl remotes only
  35         */
  36        char *http_proxy;
  37};
  38
  39struct remote *remote_get(const char *name);
  40
  41typedef int each_remote_fn(struct remote *remote, void *priv);
  42int for_each_remote(each_remote_fn fn, void *priv);
  43
  44int remote_has_url(struct remote *remote, const char *url);
  45
  46struct refspec {
  47        unsigned force : 1;
  48        unsigned pattern : 1;
  49
  50        char *src;
  51        char *dst;
  52};
  53
  54struct ref *alloc_ref(unsigned namelen);
  55
  56struct ref *copy_ref_list(const struct ref *ref);
  57
  58int check_ref_type(const struct ref *ref, int flags);
  59
  60/*
  61 * Frees the entire list and peers of elements.
  62 */
  63void free_refs(struct ref *ref);
  64
  65/*
  66 * Removes and frees any duplicate refs in the map.
  67 */
  68void ref_remove_duplicates(struct ref *ref_map);
  69
  70struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
  71struct refspec *parse_push_refspec(int nr_refspec, const char **refspec);
  72
  73int match_refs(struct ref *src, struct ref *dst, struct ref ***dst_tail,
  74               int nr_refspec, const char **refspec, int all);
  75
  76/*
  77 * Given a list of the remote refs and the specification of things to
  78 * fetch, makes a (separate) list of the refs to fetch and the local
  79 * refs to store into.
  80 *
  81 * *tail is the pointer to the tail pointer of the list of results
  82 * beforehand, and will be set to the tail pointer of the list of
  83 * results afterward.
  84 *
  85 * missing_ok is usually false, but when we are adding branch.$name.merge
  86 * it is Ok if the branch is not at the remote anymore.
  87 */
  88int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
  89                  struct ref ***tail, int missing_ok);
  90
  91struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
  92
  93/*
  94 * For the given remote, reads the refspec's src and sets the other fields.
  95 */
  96int remote_find_tracking(struct remote *remote, struct refspec *refspec);
  97
  98struct branch {
  99        const char *name;
 100        const char *refname;
 101
 102        const char *remote_name;
 103        struct remote *remote;
 104
 105        const char **merge_name;
 106        struct refspec **merge;
 107        int merge_nr;
 108        int merge_alloc;
 109};
 110
 111struct branch *branch_get(const char *name);
 112
 113int branch_has_merge_config(struct branch *branch);
 114int branch_merge_matches(struct branch *, int n, const char *);
 115
 116/* Flags to match_refs. */
 117enum match_refs_flags {
 118        MATCH_REFS_NONE         = 0,
 119        MATCH_REFS_ALL          = (1 << 0),
 120        MATCH_REFS_MIRROR       = (1 << 1),
 121};
 122
 123#endif