From: Nick Mathewson <nickm@torproject.org>
Date: Mon, 15 Jul 2013 17:17:25 +0000 (-0400)
Subject: Document what "escape" means in tor_escape_str_for_pt_args
X-Git-Tag: tor-0.2.5.1-alpha~105^2~2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=713ff2f5efb91adf147edf22ec0def2f4d17badb;p=thirdparty%2Ftor.git

Document what "escape" means in tor_escape_str_for_pt_args
---

diff --git a/src/common/util.c b/src/common/util.c
index eb932f3054..0e8d34eafd 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)
 {