From 2aa28e7cb7ec5b540bf4dcdd9e61a345f5c16262 Mon Sep 17 00:00:00 2001 From: Alexander Færøy Date: Wed, 26 Apr 2017 03:21:03 +0200 Subject: 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(-) (limited to 'src/common/compress.c') diff --git a/src/common/compress.c b/src/common/compress.c index ec9ded6f7f..4c10a2b61e 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 - * in_len bytes at in, uncompress them into a newly allocated - * buffer, using the method described in method. Store the uncompressed - * string in *out, and its length in *out_len. Return 0 on - * success, -1 on failure. +/** Given zero or more compressed strings of total length in_len bytes + * at in, uncompress them into a newly allocated buffer, using the + * method described in method. Store the uncompressed string in + * *out, and its length in *out_len. Return 0 on success, -1 on + * failure. * * If complete_only is true, we consider a truncated input as a * failure; otherwise we decompress as much as we can. Warn about truncated -- cgit v1.2.3-54-g00ecf