diff options
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/lz4.h | 3 | ||||
| -rw-r--r-- | lib/lz4hc.h | 6 |
2 files changed, 7 insertions, 2 deletions
@@ -526,7 +526,7 @@ union LZ4_stream_u { LZ4_stream_t_internal internal_donotuse; } ; /* previously typedef'd to LZ4_stream_t */ -/*! LZ4_initStream() : +/*! LZ4_initStream() : v1.9.0+ * An LZ4_stream_t structure must be initialized at least once. * This is automatically done when invoking LZ4_createStream(), * but it's not when the structure is simply declared on stack (for example). @@ -538,6 +538,7 @@ union LZ4_stream_u { * Note : initialization fails if size and alignment conditions are not respected. * In which case, the function will @return NULL. * Note2: An LZ4_stream_t structure guarantees correct alignment and size. + * Note3: Before v1.9.0, use LZ4_resetStream() instead */ LZ4LIB_API LZ4_stream_t* LZ4_initStream (void* buffer, size_t size); diff --git a/lib/lz4hc.h b/lib/lz4hc.h index ea90230..cdc6d89 100644 --- a/lib/lz4hc.h +++ b/lib/lz4hc.h @@ -265,6 +265,10 @@ union LZ4_streamHC_u { * Static allocation shall only be used in combination with static linking. */ +/* LZ4_initStreamHC() : v1.9.0+ + * Required before first use of a statically allocated LZ4_streamHC_t. + * Before v1.9.0 : use LZ4_resetStreamHC() instead + */ LZ4LIB_API LZ4_streamHC_t* LZ4_initStreamHC (void* buffer, size_t size); @@ -351,7 +355,7 @@ LZ4LIB_STATIC_API void LZ4_setCompressionLevel( LZ4LIB_STATIC_API void LZ4_favorDecompressionSpeed( LZ4_streamHC_t* LZ4_streamHCPtr, int favor); -/*! LZ4_resetStreamHC_fast() : +/*! LZ4_resetStreamHC_fast() : v1.9.0+ * When an LZ4_streamHC_t is known to be in a internally coherent state, * it can often be prepared for a new compression with almost no work, only * sometimes falling back to the full, expensive reset that is always required |