aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2013-07-15 13:17:25 -0400
committerNick Mathewson <nickm@torproject.org>2013-07-18 08:45:03 -0400
commit713ff2f5efb91adf147edf22ec0def2f4d17badb (patch)
tree415b9d148ec8911f8ce6200b52af320d80b0a601 /src
parentc71809d403f1fe84105748583ef0f66b6c778db2 (diff)
downloadtor-713ff2f5efb91adf147edf22ec0def2f4d17badb.tar
tor-713ff2f5efb91adf147edf22ec0def2f4d17badb.tar.gz
Document what "escape" means in tor_escape_str_for_pt_args
Diffstat (limited to 'src')
-rw-r--r--src/common/util.c5
1 files changed, 2 insertions, 3 deletions
diff --git a/src/common/util.c b/src/common/util.c
index eb932f305..0e8d34eaf 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)
{