Merge branch 'maint'
[git/mingw.git] / transport.h
blob096f6e9478301395ca05d81eaac6e53e0acd69b0
1 #ifndef TRANSPORT_H
2 #define TRANSPORT_H
4 #include "cache.h"
5 #include "remote.h"
7 struct git_transport_options {
8 unsigned thin : 1;
9 unsigned keep : 1;
10 unsigned followtags : 1;
11 int depth;
12 const char *uploadpack;
13 const char *receivepack;
16 struct transport {
17 struct remote *remote;
18 const char *url;
19 void *data;
20 const struct ref *remote_refs;
22 /**
23 * Indicates whether we already called get_refs_list(); set by
24 * transport.c::transport_get_remote_refs().
26 unsigned got_remote_refs : 1;
28 /**
29 * Returns 0 if successful, positive if the option is not
30 * recognized or is inapplicable, and negative if the option
31 * is applicable but the value is invalid.
32 **/
33 int (*set_option)(struct transport *connection, const char *name,
34 const char *value);
36 /**
37 * Returns a list of the remote side's refs. In order to allow
38 * the transport to try to share connections, for_push is a
39 * hint as to whether the ultimate operation is a push or a fetch.
41 * If the transport is able to determine the remote hash for
42 * the ref without a huge amount of effort, it should store it
43 * in the ref's old_sha1 field; otherwise it should be all 0.
44 **/
45 struct ref *(*get_refs_list)(struct transport *transport, int for_push);
47 /**
48 * Fetch the objects for the given refs. Note that this gets
49 * an array, and should ignore the list structure.
51 * If the transport did not get hashes for refs in
52 * get_refs_list(), it should set the old_sha1 fields in the
53 * provided refs now.
54 **/
55 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
57 /**
58 * Push the objects and refs. Send the necessary objects, and
59 * then, for any refs where peer_ref is set and
60 * peer_ref->new_sha1 is different from old_sha1, tell the
61 * remote side to update each ref in the list from old_sha1 to
62 * peer_ref->new_sha1.
64 * Where possible, set the status for each ref appropriately.
66 * The transport must modify new_sha1 in the ref to the new
67 * value if the remote accepted the change. Note that this
68 * could be a different value from peer_ref->new_sha1 if the
69 * process involved generating new commits.
70 **/
71 int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
72 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
73 int (*connect)(struct transport *connection, const char *name,
74 const char *executable, int fd[2]);
76 /** get_refs_list(), fetch(), and push_refs() can keep
77 * resources (such as a connection) reserved for futher
78 * use. disconnect() releases these resources.
79 **/
80 int (*disconnect)(struct transport *connection);
81 char *pack_lockfile;
82 signed verbose : 3;
83 /* Force progress even if stderr is not a tty */
84 unsigned progress : 1;
86 * If transport is at least potentially smart, this points to
87 * git_transport_options structure to use in case transport
88 * actually turns out to be smart.
90 struct git_transport_options *smart_options;
93 #define TRANSPORT_PUSH_ALL 1
94 #define TRANSPORT_PUSH_FORCE 2
95 #define TRANSPORT_PUSH_DRY_RUN 4
96 #define TRANSPORT_PUSH_MIRROR 8
97 #define TRANSPORT_PUSH_VERBOSE 16
98 #define TRANSPORT_PUSH_PORCELAIN 32
99 #define TRANSPORT_PUSH_QUIET 64
100 #define TRANSPORT_PUSH_SET_UPSTREAM 128
101 #define TRANSPORT_SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3)
103 /* Returns a transport suitable for the url */
104 struct transport *transport_get(struct remote *, const char *);
106 /* Transport options which apply to git:// and scp-style URLs */
108 /* The program to use on the remote side to send a pack */
109 #define TRANS_OPT_UPLOADPACK "uploadpack"
111 /* The program to use on the remote side to receive a pack */
112 #define TRANS_OPT_RECEIVEPACK "receivepack"
114 /* Transfer the data as a thin pack if not null */
115 #define TRANS_OPT_THIN "thin"
117 /* Keep the pack that was transferred if not null */
118 #define TRANS_OPT_KEEP "keep"
120 /* Limit the depth of the fetch if not null */
121 #define TRANS_OPT_DEPTH "depth"
123 /* Aggressively fetch annotated tags if possible */
124 #define TRANS_OPT_FOLLOWTAGS "followtags"
127 * Returns 0 if the option was used, non-zero otherwise. Prints a
128 * message to stderr if the option is not used.
130 int transport_set_option(struct transport *transport, const char *name,
131 const char *value);
133 int transport_push(struct transport *connection,
134 int refspec_nr, const char **refspec, int flags,
135 int * nonfastforward);
137 const struct ref *transport_get_remote_refs(struct transport *transport);
139 int transport_fetch_refs(struct transport *transport, struct ref *refs);
140 void transport_unlock_pack(struct transport *transport);
141 int transport_disconnect(struct transport *transport);
142 char *transport_anonymize_url(const char *url);
143 void transport_take_over(struct transport *transport,
144 struct child_process *child);
146 int transport_connect(struct transport *transport, const char *name,
147 const char *exec, int fd[2]);
149 /* Transport methods defined outside transport.c */
150 int transport_helper_init(struct transport *transport, const char *name);
152 /* common methods used by transport.c and builtin-send-pack.c */
153 void transport_verify_remote_names(int nr_heads, const char **heads);
155 void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
157 int transport_refs_pushed(struct ref *ref);
159 void transport_print_push_status(const char *dest, struct ref *refs,
160 int verbose, int porcelain, int *nonfastforward);
162 #endif