[tor/master] Document what "escape" means in tor_escape_str_for_pt_args

commit 713ff2f5efb91adf147edf22ec0def2f4d17badb Author: Nick Mathewson <nickm@torproject.org> Date: Mon Jul 15 13:17:25 2013 -0400 Document what "escape" means in tor_escape_str_for_pt_args --- src/common/util.c | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/common/util.c b/src/common/util.c index eb932f3..0e8d34e 100644 --- a/src/common/util.c +++ b/src/common/util.c @@ -1223,9 +1223,8 @@ escaped(const char *s) return escaped_val_; } -/** Escape every character of <b>string</b> that is in - * <b>chars_to_escape</b>. The returned string is allocated on the - * heap and it's the responsibility of the caller to free it. */ +/** Return a newly allocated string equal to <b>string</b>, except that every + * character in <b>chars_to_escape</b> is preceded by a backslash. */ char * tor_escape_str_for_pt_args(const char *string, const char *chars_to_escape) {
participants (1)
-
nickm@torproject.org