nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-10 13:13:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Better documentation for tor_uncompress().

Browse Source 
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.
This commit is contained in:
Alexander Færøy 2017-04-26 03:21:03 +02:00
parent 341824687a
commit 2aa28e7cb7
No known key found for this signature in database
GPG Key ID: E15081D5D3C3DB53
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/common/compress.c
View File

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