Add clarifying comments to control_proto.c

Refer to control-spec.txt grammar productions in comments in
control_proto.c for clarity.
This commit is contained in:
Taylor Yu
2019-04-08 13:39:04 -05:00
parent 8e7316bae4
commit 482437754a
+6 -1
View File
@@ -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)
{