[tor-commits] [tor/master] Better documentation for `tor_uncompress()`.

[nickm at torproject.org]

commit 2aa28e7cb7ec5b540bf4dcdd9e61a345f5c16262
Author: Alexander Færøy <ahf at torproject.org>
Date:   Wed Apr 26 03:21:03 2017 +0200

    Better documentation for `tor_uncompress()`.
    
    This patch fixes the documentation string for `tor_uncompress()` to
    ensure that it does not explicitly mention zlib or gzip since we now
    support multiple compression backends.
---
 src/common/compress.c | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/src/common/compress.c b/src/common/compress.c
index ec9ded6..4c10a2b 100644
--- a/src/common/compress.c
+++ b/src/common/compress.c
@@ -215,12 +215,11 @@ tor_compress(char **out, size_t *out_len,
                            1, LOG_WARN);
 }
 
-/** Given zero or more zlib-compressed or gzip-compressed strings of
- * total length
- * <b>in_len</b> bytes at <b>in</b>, uncompress them into a newly allocated
- * buffer, using the method described in <b>method</b>.  Store the uncompressed
- * string in *<b>out</b>, and its length in *<b>out_len</b>.  Return 0 on
- * success, -1 on failure.
+/** Given zero or more compressed strings of total length <b>in_len</b> bytes
+ * at <b>in</b>, uncompress them into a newly allocated buffer, using the
+ * method described in <b>method</b>.  Store the uncompressed string in
+ * *<b>out</b>, and its length in *<b>out_len</b>.  Return 0 on success, -1 on
+ * failure.
  *
  * If <b>complete_only</b> is true, we consider a truncated input as a
  * failure; otherwise we decompress as much as we can.  Warn about truncated