commit 482437754a7a30b651f096d4432a42aa61bd3b17 Author: Taylor Yu catalyst@torproject.org Date: Mon Apr 8 13:39:04 2019 -0500
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(-)
diff --git a/src/feature/control/control_proto.c b/src/feature/control/control_proto.c index daf5b1189..4756a0263 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 *<b>out</b>. + * + * 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 <b>data</b> into *<b>out</b>, removing any period * that appears at the start of a line, and replacing all CRLF sequences * with LF. Return the number of - * bytes in *<b>out</b>. */ + * bytes in *<b>out</b>. + * + * This corresponds to CmdData in control-spec.txt. + */ size_t read_escaped_data(const char *data, size_t len, char **out) {