[PATCHv2 01/10] pkt-line: move a misplaced comment
- From
Jeff King <peff@peff.net>
- Date
- Feb 18, 2013, 09:14 UTC
- Message-ID
- <20130218091430.GA5096@sigill.intra.peff.net>
- In-Reply-To
- <20130218091203.GB17003@sigill.intra.peff.net>
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> --- I just left the comment intact as I moved it. It kind of implies to me that you hand a big buffer to these functions and they would packetize it for you, which is not true. I don't know if anybody else sees that; it might be worth tweaking the text.
pkt-line.c | 15 --------------- pkt-line.h | 14 +++++++++++++- 2 files changed, 13 insertions(+), 16 deletions(-)
diff --git a/pkt-line.c b/pkt-line.c index eaba15f..5138f47 100644 --- a/pkt-line.c +++ b/pkt-line.c @@ -46,21 +46,6 @@ static void packet_trace(const char *buf, unsigned int len, int write) strbuf_release(&out); } -/* - * 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. - */ ssize_t safe_write(int fd, const void *buf, ssize_t n) { ssize_t nn = n; diff --git a/pkt-line.h b/pkt-line.h index 8cfeb0c..7a67e9c 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)));
-- 1.8.1.20.g7078b03