format-patch: print in-body "From" only when needed
[git/mingw/4msysgit.git] / transport.h
blobea70ea7e4a1b61c3006c614712ddd1aa41205ac6
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 unsigned check_self_contained_and_connected : 1;
12 unsigned self_contained_and_connected : 1;
13 int depth;
14 const char *uploadpack;
15 const char *receivepack;
18 struct transport {
19 struct remote *remote;
20 const char *url;
21 void *data;
22 const struct ref *remote_refs;
24 /**
25 * Indicates whether we already called get_refs_list(); set by
26 * transport.c::transport_get_remote_refs().
28 unsigned got_remote_refs : 1;
30 /**
31 * Returns 0 if successful, positive if the option is not
32 * recognized or is inapplicable, and negative if the option
33 * is applicable but the value is invalid.
34 **/
35 int (*set_option)(struct transport *connection, const char *name,
36 const char *value);
38 /**
39 * Returns a list of the remote side's refs. In order to allow
40 * the transport to try to share connections, for_push is a
41 * hint as to whether the ultimate operation is a push or a fetch.
43 * If the transport is able to determine the remote hash for
44 * the ref without a huge amount of effort, it should store it
45 * in the ref's old_sha1 field; otherwise it should be all 0.
46 **/
47 struct ref *(*get_refs_list)(struct transport *transport, int for_push);
49 /**
50 * Fetch the objects for the given refs. Note that this gets
51 * an array, and should ignore the list structure.
53 * If the transport did not get hashes for refs in
54 * get_refs_list(), it should set the old_sha1 fields in the
55 * provided refs now.
56 **/
57 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
59 /**
60 * Push the objects and refs. Send the necessary objects, and
61 * then, for any refs where peer_ref is set and
62 * peer_ref->new_sha1 is different from old_sha1, tell the
63 * remote side to update each ref in the list from old_sha1 to
64 * peer_ref->new_sha1.
66 * Where possible, set the status for each ref appropriately.
68 * The transport must modify new_sha1 in the ref to the new
69 * value if the remote accepted the change. Note that this
70 * could be a different value from peer_ref->new_sha1 if the
71 * process involved generating new commits.
72 **/
73 int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
74 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
75 int (*connect)(struct transport *connection, const char *name,
76 const char *executable, int fd[2]);
78 /** get_refs_list(), fetch(), and push_refs() can keep
79 * resources (such as a connection) reserved for further
80 * use. disconnect() releases these resources.
81 **/
82 int (*disconnect)(struct transport *connection);
83 char *pack_lockfile;
84 signed verbose : 3;
85 /**
86 * Transports should not set this directly, and should use this
87 * value without having to check isatty(2), -q/--quiet
88 * (transport->verbose < 0), etc. - checking has already been done
89 * in transport_set_verbosity().
90 **/
91 unsigned progress : 1;
93 * If transport is at least potentially smart, this points to
94 * git_transport_options structure to use in case transport
95 * actually turns out to be smart.
97 struct git_transport_options *smart_options;
100 #define TRANSPORT_PUSH_ALL 1
101 #define TRANSPORT_PUSH_FORCE 2
102 #define TRANSPORT_PUSH_DRY_RUN 4
103 #define TRANSPORT_PUSH_MIRROR 8
104 #define TRANSPORT_PUSH_PORCELAIN 16
105 #define TRANSPORT_PUSH_SET_UPSTREAM 32
106 #define TRANSPORT_RECURSE_SUBMODULES_CHECK 64
107 #define TRANSPORT_PUSH_PRUNE 128
108 #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND 256
109 #define TRANSPORT_PUSH_NO_HOOK 512
110 #define TRANSPORT_PUSH_FOLLOW_TAGS 1024
112 #define TRANSPORT_SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3)
113 #define TRANSPORT_SUMMARY(x) (int)(TRANSPORT_SUMMARY_WIDTH + strlen(x) - gettext_width(x)), (x)
115 /* Returns a transport suitable for the url */
116 struct transport *transport_get(struct remote *, const char *);
118 /* Transport options which apply to git:// and scp-style URLs */
120 /* The program to use on the remote side to send a pack */
121 #define TRANS_OPT_UPLOADPACK "uploadpack"
123 /* The program to use on the remote side to receive a pack */
124 #define TRANS_OPT_RECEIVEPACK "receivepack"
126 /* Transfer the data as a thin pack if not null */
127 #define TRANS_OPT_THIN "thin"
129 /* Keep the pack that was transferred if not null */
130 #define TRANS_OPT_KEEP "keep"
132 /* Limit the depth of the fetch if not null */
133 #define TRANS_OPT_DEPTH "depth"
135 /* Aggressively fetch annotated tags if possible */
136 #define TRANS_OPT_FOLLOWTAGS "followtags"
139 * Returns 0 if the option was used, non-zero otherwise. Prints a
140 * message to stderr if the option is not used.
142 int transport_set_option(struct transport *transport, const char *name,
143 const char *value);
144 void transport_set_verbosity(struct transport *transport, int verbosity,
145 int force_progress);
147 #define REJECT_NON_FF_HEAD 0x01
148 #define REJECT_NON_FF_OTHER 0x02
149 #define REJECT_ALREADY_EXISTS 0x04
150 #define REJECT_FETCH_FIRST 0x08
151 #define REJECT_NEEDS_FORCE 0x10
153 int transport_push(struct transport *connection,
154 int refspec_nr, const char **refspec, int flags,
155 unsigned int * reject_reasons);
157 const struct ref *transport_get_remote_refs(struct transport *transport);
159 int transport_fetch_refs(struct transport *transport, struct ref *refs);
160 void transport_unlock_pack(struct transport *transport);
161 int transport_disconnect(struct transport *transport);
162 char *transport_anonymize_url(const char *url);
163 void transport_take_over(struct transport *transport,
164 struct child_process *child);
166 int transport_connect(struct transport *transport, const char *name,
167 const char *exec, int fd[2]);
169 /* Transport methods defined outside transport.c */
170 int transport_helper_init(struct transport *transport, const char *name);
171 int bidirectional_transfer_loop(int input, int output);
173 /* common methods used by transport.c and builtin/send-pack.c */
174 void transport_verify_remote_names(int nr_heads, const char **heads);
176 void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
178 int transport_refs_pushed(struct ref *ref);
180 void transport_print_push_status(const char *dest, struct ref *refs,
181 int verbose, int porcelain, unsigned int *reject_reasons);
183 typedef void alternate_ref_fn(const struct ref *, void *);
184 extern void for_each_alternate_ref(alternate_ref_fn, void *);
186 struct send_pack_args;
187 extern int send_pack(struct send_pack_args *args,
188 int fd[], struct child_process *conn,
189 struct ref *remote_refs,
190 struct extra_have_objects *extra_have);
191 #endif