summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2021-08-16 23:43:17 (GMT)
committerYann Collet <cyan@fb.com>2021-08-16 23:43:17 (GMT)
commit596c7472116a9204c5a32cc3d9e588fa8a4b6feb (patch)
tree803f4bcc089a4e05979a2bbc2618278c4ad7795d /doc
parente78eeec86e696f318a0ad1e71d6ad50555d1c0a9 (diff)
downloadlz4-596c7472116a9204c5a32cc3d9e588fa8a4b6feb.zip
lz4-596c7472116a9204c5a32cc3d9e588fa8a4b6feb.tar.gz
lz4-596c7472116a9204c5a32cc3d9e588fa8a4b6feb.tar.bz2
make UNAME externally definable
on top of providing a central definition place, which eases maintenance, it might also help for #1021. Also : updated doc
Diffstat (limited to 'doc')
-rw-r--r--doc/lz4_manual.html4
-rw-r--r--doc/lz4frame_manual.html6
2 files changed, 5 insertions, 5 deletions
diff --git a/doc/lz4_manual.html b/doc/lz4_manual.html
index 47fe18d..b6f304b 100644
--- a/doc/lz4_manual.html
+++ b/doc/lz4_manual.html
@@ -393,7 +393,7 @@ int LZ4_freeStreamDecode (LZ4_streamDecode_t* LZ4_stream);
<pre><b></b><p>
It's possible to have input and output sharing the same buffer,
- for highly contrained memory environments.
+ for highly constrained memory environments.
In both cases, it requires input to lay at the end of the buffer,
and decompression to start at beginning of the buffer.
Buffer size must feature some margin, hence be larger than final size.
@@ -459,7 +459,7 @@ int LZ4_freeStreamDecode (LZ4_streamDecode_t* LZ4_stream);
size_t prefixSize;
} LZ4_streamDecode_t_internal;
</b></pre><BR>
-<pre><b>#define LZ4_STREAMSIZE 16416 </b>/* static size, for inter-version compatibility */<b>
+<pre><b>#define LZ4_STREAMSIZE ((1UL << LZ4_MEMORY_USAGE) + 32) </b>/* static size, for inter-version compatibility */<b>
#define LZ4_STREAMSIZE_VOIDP (LZ4_STREAMSIZE / sizeof(void*))
union LZ4_stream_u {
void* table[LZ4_STREAMSIZE_VOIDP];
diff --git a/doc/lz4frame_manual.html b/doc/lz4frame_manual.html
index 57a165c..281c0d6 100644
--- a/doc/lz4frame_manual.html
+++ b/doc/lz4frame_manual.html
@@ -140,7 +140,8 @@ LZ4F_errorCode_t LZ4F_freeCompressionContext(LZ4F_cctx* cctx);
The version provided MUST be LZ4F_VERSION. It is intended to track potential version mismatch, notably when using DLL.
The function will provide a pointer to a fully allocated LZ4F_cctx object.
If @return != zero, there was an error during context creation.
- Object can release its memory using LZ4F_freeCompressionContext();
+ Object can be released using LZ4F_freeCompressionContext();
+ Note: LZ4F_freeCompressionContext() works with NULL pointers (do nothing).
</p></pre><BR>
@@ -182,8 +183,7 @@ LZ4F_errorCode_t LZ4F_freeCompressionContext(LZ4F_cctx* cctx);
Important rule: dstCapacity MUST be large enough to ensure operation success even in worst case situations.
This value is provided by LZ4F_compressBound().
If this condition is not respected, LZ4F_compress() will fail (result is an errorCode).
- LZ4F_compressUpdate() doesn't guarantee error recovery.
- When an error occurs, compression context must be freed or resized.
+ After an error, the state is left in a UB state, and must be re-initialized or freed.
`cOptPtr` is optional : NULL can be provided, in which case all options are set to default.
@return : number of bytes written into `dstBuffer` (it can be zero, meaning input data was just buffered).
or an error code if it fails (which can be tested using LZ4F_isError())