remote: add promisor and partial clone config to the doc

diff --git a/pkt-line.c b/pkt-line.c
index 04d10bbd037b393574f8453cbd00f94e0b2e7e99..a0e87b1e81408e17b4bb8e99bc162b6e7bce4012 100644 (file)
--- a/pkt-line.c
+++ b/pkt-line.c
@@ -88,13 +88,15 @@ static void packet_trace(const char *buf, unsigned int len, int write)
 void packet_flush(int fd)
 {
        packet_trace("0000", 4, 1);
-       write_or_die(fd, "0000", 4);
+       if (write_in_full(fd, "0000", 4) < 0)
+               die_errno(_("unable to write flush packet"));
 }
 
 void packet_delim(int fd)
 {
        packet_trace("0001", 4, 1);
-       write_or_die(fd, "0001", 4);
+       if (write_in_full(fd, "0001", 4) < 0)
+               die_errno(_("unable to write delim packet"));
 }
 
 int packet_flush_gently(int fd)
@@ -117,7 +119,7 @@ void packet_buf_delim(struct strbuf *buf)
        strbuf_add(buf, "0001", 4);
 }
 
-static void set_packet_header(char *buf, const int size)
+void set_packet_header(char *buf, int size)
 {
        static char hexchar[] = "0123456789abcdef";
 
@@ -129,12 +131,14 @@ static void set_packet_header(char *buf, const int size)
        #undef hex
 }
 
-static void format_packet(struct strbuf *out, const char *fmt, va_list args)
+static void format_packet(struct strbuf *out, const char *prefix,
+                         const char *fmt, va_list args)
 {
        size_t orig_len, n;
 
        orig_len = out->len;
        strbuf_addstr(out, "0000");
+       strbuf_addstr(out, prefix);
        strbuf_vaddf(out, fmt, args);
        n = out->len - orig_len;
 
@@ -145,13 +149,13 @@ static void format_packet(struct strbuf *out, const char *fmt, va_list args)
        packet_trace(out->buf + orig_len + 4, n - 4, 1);
 }
 
-static int packet_write_fmt_1(int fd, int gently,
+static int packet_write_fmt_1(int fd, int gently, const char *prefix,
                              const char *fmt, va_list args)
 {
        static struct strbuf buf = STRBUF_INIT;
 
        strbuf_reset(&buf);
-       format_packet(&buf, fmt, args);
+       format_packet(&buf, prefix, fmt, args);
        if (write_in_full(fd, buf.buf, buf.len) < 0) {
                if (!gently) {
                        check_pipe(errno);
@@ -168,7 +172,7 @@ void packet_write_fmt(int fd, const char *fmt, ...)
        va_list args;
 
        va_start(args, fmt);
-       packet_write_fmt_1(fd, 0, fmt, args);
+       packet_write_fmt_1(fd, 0, "", fmt, args);
        va_end(args);
 }
 
@@ -178,7 +182,7 @@ int packet_write_fmt_gently(int fd, const char *fmt, ...)
        va_list args;
 
        va_start(args, fmt);
-       status = packet_write_fmt_1(fd, 1, fmt, args);
+       status = packet_write_fmt_1(fd, 1, "", fmt, args);
        va_end(args);
        return status;
 }
@@ -211,7 +215,7 @@ void packet_buf_write(struct strbuf *buf, const char *fmt, ...)
        va_list args;
 
        va_start(args, fmt);
-       format_packet(buf, fmt, args);
+       format_packet(buf, "", fmt, args);
        va_end(args);
 }
 
@@ -352,6 +356,11 @@ enum packet_read_status packet_read_with_status(int fd, char **src_buffer,
 
        buffer[len] = 0;
        packet_trace(buffer, len, 0);
+
+       if ((options & PACKET_READ_DIE_ON_ERR_PACKET) &&
+           starts_with(buffer, "ERR "))
+               die(_("remote error: %s"), buffer + 4);
+
        *pktlen = len;
        return PACKET_READ_NORMAL;
 }
@@ -433,6 +442,29 @@ ssize_t read_packetized_to_strbuf(int fd_in, struct strbuf *sb_out)
        return sb_out->len - orig_len;
 }
 
+int recv_sideband(const char *me, int in_stream, int out)
+{
+       char buf[LARGE_PACKET_MAX + 1];
+       int len;
+       struct strbuf scratch = STRBUF_INIT;
+       enum sideband_type sideband_type;
+
+       while (1) {
+               len = packet_read(in_stream, NULL, NULL, buf, LARGE_PACKET_MAX,
+                                 0);
+               if (!demultiplex_sideband(me, buf, len, 0, &scratch,
+                                         &sideband_type))
+                       continue;
+               switch (sideband_type) {
+               case SIDEBAND_PRIMARY:
+                       write_or_die(out, buf + 1, len - 1);
+                       break;
+               default: /* errors: message already written */
+                       return sideband_type;
+               }
+       }
+}
+
 /* Packet Reader Functions */
 void packet_reader_init(struct packet_reader *reader, int fd,
                        char *src_buffer, size_t src_len,
@@ -446,25 +478,43 @@ void packet_reader_init(struct packet_reader *reader, int fd,
        reader->buffer = packet_buffer;
        reader->buffer_size = sizeof(packet_buffer);
        reader->options = options;
+       reader->me = "git";
 }
 
 enum packet_read_status packet_reader_read(struct packet_reader *reader)
 {
+       struct strbuf scratch = STRBUF_INIT;
+
        if (reader->line_peeked) {
                reader->line_peeked = 0;
                return reader->status;
        }
 
-       reader->status = packet_read_with_status(reader->fd,
-                                                &reader->src_buffer,
-                                                &reader->src_len,
-                                                reader->buffer,
-                                                reader->buffer_size,
-                                                &reader->pktlen,
-                                                reader->options);
+       /*
+        * Consume all progress packets until a primary payload packet is
+        * received
+        */
+       while (1) {
+               enum sideband_type sideband_type;
+               reader->status = packet_read_with_status(reader->fd,
+                                                        &reader->src_buffer,
+                                                        &reader->src_len,
+                                                        reader->buffer,
+                                                        reader->buffer_size,
+                                                        &reader->pktlen,
+                                                        reader->options);
+               if (!reader->use_sideband)
+                       break;
+               if (demultiplex_sideband(reader->me, reader->buffer,
+                                        reader->pktlen, 1, &scratch,
+                                        &sideband_type))
+                       break;
+       }
 
        if (reader->status == PACKET_READ_NORMAL)
-               reader->line = reader->buffer;
+               /* Skip the sideband designator if sideband is used */
+               reader->line = reader->use_sideband ?
+                       reader->buffer + 1 : reader->buffer;
        else
                reader->line = NULL;
 
@@ -482,3 +532,39 @@ enum packet_read_status packet_reader_peek(struct packet_reader *reader)
        reader->line_peeked = 1;
        return reader->status;
 }
+
+void packet_writer_init(struct packet_writer *writer, int dest_fd)
+{
+       writer->dest_fd = dest_fd;
+       writer->use_sideband = 0;
+}
+
+void packet_writer_write(struct packet_writer *writer, const char *fmt, ...)
+{
+       va_list args;
+
+       va_start(args, fmt);
+       packet_write_fmt_1(writer->dest_fd, 0,
+                          writer->use_sideband ? "\001" : "", fmt, args);
+       va_end(args);
+}
+
+void packet_writer_error(struct packet_writer *writer, const char *fmt, ...)
+{
+       va_list args;
+
+       va_start(args, fmt);
+       packet_write_fmt_1(writer->dest_fd, 0,
+                          writer->use_sideband ? "\003" : "ERR ", fmt, args);
+       va_end(args);
+}
+
+void packet_writer_delim(struct packet_writer *writer)
+{
+       packet_delim(writer->dest_fd);
+}
+
+void packet_writer_flush(struct packet_writer *writer)
+{
+       packet_flush(writer->dest_fd);
+}