summaryrefslogtreecommitdiff
path: root/pkt-line.h
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2013-02-20 15:01:46 -0500
committerJunio C Hamano <gitster@pobox.com>2013-02-20 13:42:21 -0800
commite148542870013e40d02490e692818a62691c1a10 (patch)
tree6055d3addab386c8a7077a7f293fc77870618a92 /pkt-line.h
parent756e676ca011083dd15264ec29e281c47297ae40 (diff)
downloadgit-e148542870013e40d02490e692818a62691c1a10.tar.gz
pkt-line: move a misplaced comment
The comment describing the packet writing interface was originally written above packet_write, but migrated to be above safe_write in f3a3214, probably because it is meant to generally describe the packet writing interface and not a single function. Let's move it into the header file, where users of the interface are more likely to see it. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'pkt-line.h')
-rw-r--r--pkt-line.h14
1 files changed, 13 insertions, 1 deletions
diff --git a/pkt-line.h b/pkt-line.h
index 8cfeb0c31c..7a67e9c65b 100644
--- a/pkt-line.h
+++ b/pkt-line.h
@@ -5,7 +5,19 @@
#include "strbuf.h"
/*
- * Silly packetized line writing interface
+ * Write a packetized stream, where each line is preceded by
+ * its length (including the header) as a 4-byte hex number.
+ * A length of 'zero' means end of stream (and a length of 1-3
+ * would be an error).
+ *
+ * This is all pretty stupid, but we use this packetized line
+ * format to make a streaming format possible without ever
+ * over-running the read buffers. That way we'll never read
+ * into what might be the pack data (which should go to another
+ * process entirely).
+ *
+ * The writing side could use stdio, but since the reading
+ * side can't, we stay with pure read/write interfaces.
*/
void packet_flush(int fd);
void packet_write(int fd, const char *fmt, ...) __attribute__((format (printf, 2, 3)));