doc: fix want-capability separator
[gitweb.git] / transport-internal.h
index 3c1a29d7274465b977d9285781673f235e66ad21..eeb6c340e51eab341b7f089bf2b425697759f3cd 100644 (file)
@@ -3,6 +3,7 @@
 
 struct ref;
 struct transport;
+struct argv_array;
 
 struct transport_vtable {
        /**
@@ -17,21 +18,36 @@ struct transport_vtable {
         * the transport to try to share connections, for_push is a
         * hint as to whether the ultimate operation is a push or a fetch.
         *
+        * If communicating using protocol v2 a list of prefixes can be
+        * provided to be sent to the server to enable it to limit the ref
+        * advertisement.  Since ref filtering is done on the server's end, and
+        * only when using protocol v2, this list will be ignored when not
+        * using protocol v2 meaning this function can return refs which don't
+        * match the provided ref_prefixes.
+        *
         * If the transport is able to determine the remote hash for
         * the ref without a huge amount of effort, it should store it
         * in the ref's old_sha1 field; otherwise it should be all 0.
         **/
-       struct ref *(*get_refs_list)(struct transport *transport, int for_push);
+       struct ref *(*get_refs_list)(struct transport *transport, int for_push,
+                                    const struct argv_array *ref_prefixes);
 
        /**
         * Fetch the objects for the given refs. Note that this gets
         * an array, and should ignore the list structure.
         *
+        * The transport *may* provide, in fetched_refs, the list of refs that
+        * it fetched.  If the transport knows anything about the fetched refs
+        * that the caller does not know (for example, shallow status), it
+        * should provide that list of refs and include that information in the
+        * list.
+        *
         * If the transport did not get hashes for refs in
         * get_refs_list(), it should set the old_sha1 fields in the
         * provided refs now.
         **/
-       int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
+       int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs,
+                    struct ref **fetched_refs);
 
        /**
         * Push the objects and refs. Send the necessary objects, and