From 482437754a7a30b651f096d4432a42aa61bd3b17 Mon Sep 17 00:00:00 2001 From: Taylor Yu Date: Mon, 8 Apr 2019 13:39:04 -0500 Subject: Add clarifying comments to control_proto.c Refer to control-spec.txt grammar productions in comments in control_proto.c for clarity. --- src/feature/control/control_proto.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'src/feature/control/control_proto.c') diff --git a/src/feature/control/control_proto.c b/src/feature/control/control_proto.c index daf5b1189e..4756a02632 100644 --- a/src/feature/control/control_proto.c +++ b/src/feature/control/control_proto.c @@ -62,6 +62,8 @@ connection_printf_to_buf(control_connection_t *conn, const char *format, ...) * that appears at the start of a line, and adding a period-CRLF line at * the end. Replace all LF characters sequences with CRLF. Return the number * of bytes in *out. + * + * This corresponds to CmdData in control-spec.txt. */ size_t write_escaped_data(const char *data, size_t len, char **out) @@ -118,7 +120,10 @@ write_escaped_data(const char *data, size_t len, char **out) * the contents of data into *out, removing any period * that appears at the start of a line, and replacing all CRLF sequences * with LF. Return the number of - * bytes in *out. */ + * bytes in *out. + * + * This corresponds to CmdData in control-spec.txt. + */ size_t read_escaped_data(const char *data, size_t len, char **out) { -- cgit v1.2.3-54-g00ecf