diff options
| author | Yann Collet <cyan@fb.com> | 2019-04-12 18:27:44 (GMT) |
|---|---|---|
| committer | Yann Collet <cyan@fb.com> | 2019-04-12 18:27:44 (GMT) |
| commit | 21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0 (patch) | |
| tree | 4318e6bcebc94455ed166cea1b096b7d9bc93fdb /lib/lz4frame.h | |
| parent | 780aac520b69d6369f4e3995624c37e56d75498d (diff) | |
| download | lz4-21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0.zip lz4-21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0.tar.gz lz4-21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0.tar.bz2 | |
updated doc to underline difference between block and frame
as this is a very frequent source of confusion for new users.
Diffstat (limited to 'lib/lz4frame.h')
| -rw-r--r-- | lib/lz4frame.h | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/lib/lz4frame.h b/lib/lz4frame.h index 5c68628..ca20dc9 100644 --- a/lib/lz4frame.h +++ b/lib/lz4frame.h @@ -32,11 +32,14 @@ - LZ4 public forum : https://groups.google.com/forum/#!forum/lz4c */ -/* LZ4F is a stand-alone API to create LZ4-compressed frames - * conformant with specification v1.6.1. - * It also offers streaming capabilities. +/* LZ4F is a stand-alone API able to create and decode LZ4 frames + * conformant with specification v1.6.1 in doc/lz4_Frame_format.md . + * Generated frames are compatible with `lz4` CLI. + * + * LZ4F also offers streaming capabilities. + * * lz4.h is not required when using lz4frame.h, - * except to get constant such as LZ4_VERSION_NUMBER. + * except to extract common constant such as LZ4_VERSION_NUMBER. * */ #ifndef LZ4F_H_09782039843 @@ -195,7 +198,7 @@ typedef struct { * Simple compression function ***********************************/ -LZ4FLIB_API int LZ4F_compressionLevel_max(void); +LZ4FLIB_API int LZ4F_compressionLevel_max(void); /* v1.8.0+ */ /*! LZ4F_compressFrameBound() : * Returns the maximum possible compressed size with LZ4F_compressFrame() given srcSize and preferences. |