summaryrefslogtreecommitdiff
path: root/lzf.h
diff options
context:
space:
mode:
Diffstat (limited to 'lzf.h')
-rw-r--r--lzf.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/lzf.h b/lzf.h
index 74095de..54cc054 100644
--- a/lzf.h
+++ b/lzf.h
@@ -56,7 +56,8 @@
* If the output buffer is not large enough or any error occurs
* return 0, otherwise return the number of bytes used (which might
* be considerably larger than in_len, so it makes sense to always
- * use out_len == in_len).
+ * use out_len == in_len - 1), to ensure _some_ compression, and store
+ * the data uncompressed otherwise.
*
* lzf_compress might use different algorithms on different systems and
* thus might result in different compressed strings depending on the