summaryrefslogtreecommitdiff
path: root/lzf.h
diff options
context:
space:
mode:
authorroot <root>2008-08-25 01:40:31 +0000
committerroot <root>2008-08-25 01:40:31 +0000
commitd52302e9cb04a26c03219da3be74ed68d37cf5d3 (patch)
tree325f8af8e2b7294d557e44fb456f5e263b5ee71b /lzf.h
parent95b63bcf4dfbc28630ee68784f7619b34c1db30b (diff)
*** empty log message ***rel-3_3
Diffstat (limited to 'lzf.h')
-rw-r--r--lzf.h15
1 files changed, 8 insertions, 7 deletions
diff --git a/lzf.h b/lzf.h
index 1b6da21..919b6e6 100644
--- a/lzf.h
+++ b/lzf.h
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 2000-2007 Marc Alexander Lehmann <schmorp@schmorp.de>
+ * Copyright (c) 2000-2008 Marc Alexander Lehmann <schmorp@schmorp.de>
*
* Redistribution and use in source and binary forms, with or without modifica-
* tion, are permitted provided that the following conditions are met:
@@ -46,18 +46,19 @@
**
***********************************************************************/
-#define LZF_VERSION 0x0105 /* 1.5 */
+#define LZF_VERSION 0x0105 /* 1.5, API version */
/*
* Compress in_len bytes stored at the memory block starting at
* in_data and write the result to out_data, up to a maximum length
* of out_len bytes.
*
- * 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 - 1), to ensure _some_ compression, and store
- * the data uncompressed otherwise.
+ * 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
+ * more than in_len (but less than 104% of the original size), so it
+ * makes sense to always use out_len == in_len - 1), to ensure _some_
+ * compression, and store the data uncompressed otherwise (with a flag, of
+ * course.
*
* lzf_compress might use different algorithms on different systems and
* even different runs, thus might result in different compressed strings