kwset: fix spelling in comments
[git/git.git] / transport.h
CommitLineData
9b288516
DB
1#ifndef TRANSPORT_H
2#define TRANSPORT_H
3
4#include "cache.h"
5#include "remote.h"
6
aa5af974
IL
7struct 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;
14};
15
9b288516 16struct transport {
9b288516
DB
17 struct remote *remote;
18 const char *url;
9b288516 19 void *data;
4577370e 20 const struct ref *remote_refs;
9b288516 21
b0d66e15
TRC
22 /**
23 * Indicates whether we already called get_refs_list(); set by
24 * transport.c::transport_get_remote_refs().
25 */
26 unsigned got_remote_refs : 1;
27
9b288516
DB
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);
35
37148311
DB
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.
40 *
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 **/
64fcef2d 45 struct ref *(*get_refs_list)(struct transport *transport, int for_push);
37148311
DB
46
47 /**
48 * Fetch the objects for the given refs. Note that this gets
49 * an array, and should ignore the list structure.
50 *
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);
56
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.
63 *
64 * Where possible, set the status for each ref appropriately.
65 *
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 **/
64fcef2d 71 int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
9b288516 72 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
b236752a
IL
73 int (*connect)(struct transport *connection, const char *name,
74 const char *executable, int fd[2]);
9b288516 75
37148311
DB
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 **/
9b288516 80 int (*disconnect)(struct transport *connection);
824d5776 81 char *pack_lockfile;
cff7123c 82 signed verbose : 3;
d01b3c02
TRC
83 /**
84 * Transports should not set this directly, and should use this
85 * value without having to check isatty(2), -q/--quiet
86 * (transport->verbose < 0), etc. - checking has already been done
87 * in transport_set_verbosity().
88 **/
21188b1e 89 unsigned progress : 1;
aa5af974
IL
90 /*
91 * If transport is at least potentially smart, this points to
92 * git_transport_options structure to use in case transport
93 * actually turns out to be smart.
94 */
95 struct git_transport_options *smart_options;
9b288516
DB
96};
97
824d5776
SP
98#define TRANSPORT_PUSH_ALL 1
99#define TRANSPORT_PUSH_FORCE 2
2e13e5d8 100#define TRANSPORT_PUSH_DRY_RUN 4
94c89ba6 101#define TRANSPORT_PUSH_MIRROR 8
212cfe15
TRC
102#define TRANSPORT_PUSH_PORCELAIN 16
103#define TRANSPORT_PUSH_SET_UPSTREAM 32
d2b17b32 104#define TRANSPORT_RECURSE_SUBMODULES_CHECK 64
6ddba5e2 105#define TRANSPORT_PUSH_PRUNE 128
eb21c732 106#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND 256
ec55559f 107#define TRANSPORT_PUSH_NO_HOOK 512
824d5776 108
f1863d0d 109#define TRANSPORT_SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3)
754395d3 110#define TRANSPORT_SUMMARY(x) (int)(TRANSPORT_SUMMARY_WIDTH + strlen(x) - gettext_width(x)), (x)
824d5776 111
9b288516 112/* Returns a transport suitable for the url */
e5f4e214 113struct transport *transport_get(struct remote *, const char *);
9b288516
DB
114
115/* Transport options which apply to git:// and scp-style URLs */
116
c29727d5
DB
117/* The program to use on the remote side to send a pack */
118#define TRANS_OPT_UPLOADPACK "uploadpack"
119
9b288516
DB
120/* The program to use on the remote side to receive a pack */
121#define TRANS_OPT_RECEIVEPACK "receivepack"
122
123/* Transfer the data as a thin pack if not null */
124#define TRANS_OPT_THIN "thin"
125
c29727d5
DB
126/* Keep the pack that was transferred if not null */
127#define TRANS_OPT_KEEP "keep"
128
c29727d5
DB
129/* Limit the depth of the fetch if not null */
130#define TRANS_OPT_DEPTH "depth"
131
41fa7d2e
SP
132/* Aggressively fetch annotated tags if possible */
133#define TRANS_OPT_FOLLOWTAGS "followtags"
134
9b288516
DB
135/**
136 * Returns 0 if the option was used, non-zero otherwise. Prints a
137 * message to stderr if the option is not used.
138 **/
139int transport_set_option(struct transport *transport, const char *name,
140 const char *value);
d01b3c02
TRC
141void transport_set_verbosity(struct transport *transport, int verbosity,
142 int force_progress);
9b288516 143
10643d4e
CR
144#define REJECT_NON_FF_HEAD 0x01
145#define REJECT_NON_FF_OTHER 0x02
b24e6047 146#define REJECT_ALREADY_EXISTS 0x04
75e5c0dc
JH
147#define REJECT_FETCH_FIRST 0x08
148#define REJECT_NEEDS_FORCE 0x10
10643d4e 149
9b288516 150int transport_push(struct transport *connection,
07436e43 151 int refspec_nr, const char **refspec, int flags,
10643d4e 152 unsigned int * reject_reasons);
9b288516 153
4577370e 154const struct ref *transport_get_remote_refs(struct transport *transport);
c29727d5 155
37148311 156int transport_fetch_refs(struct transport *transport, struct ref *refs);
1788c39c 157void transport_unlock_pack(struct transport *transport);
9b288516 158int transport_disconnect(struct transport *transport);
47abd85b 159char *transport_anonymize_url(const char *url);
61b075bd
IL
160void transport_take_over(struct transport *transport,
161 struct child_process *child);
9b288516 162
b236752a
IL
163int transport_connect(struct transport *transport, const char *name,
164 const char *exec, int fd[2]);
165
6eb996b5 166/* Transport methods defined outside transport.c */
c9e388bb 167int transport_helper_init(struct transport *transport, const char *name);
419f37db 168int bidirectional_transfer_loop(int input, int output);
6eb996b5 169
f1863d0d
ML
170/* common methods used by transport.c and builtin-send-pack.c */
171void transport_verify_remote_names(int nr_heads, const char **heads);
172
173void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
174
175int transport_refs_pushed(struct ref *ref);
176
177void transport_print_push_status(const char *dest, struct ref *refs,
10643d4e 178 int verbose, int porcelain, unsigned int *reject_reasons);
f1863d0d 179
36cfda15 180typedef void alternate_ref_fn(const struct ref *, void *);
114a6a88 181extern void for_each_alternate_ref(alternate_ref_fn, void *);
36cfda15 182
f5d942e1
NTND
183struct send_pack_args;
184extern int send_pack(struct send_pack_args *args,
185 int fd[], struct child_process *conn,
186 struct ref *remote_refs,
187 struct extra_have_objects *extra_have);
9b288516 188#endif