diff options
author | Yann Collet <cyan@fb.com> | 2017-05-10 20:26:04 (GMT) |
---|---|---|
committer | Yann Collet <cyan@fb.com> | 2017-05-10 20:26:04 (GMT) |
commit | b8575f2d2b1e05c20812215759b29bf2d0f7a708 (patch) | |
tree | a026a79e25bd21d158905e92a62ab4096fed8be2 /doc/lz4_manual.html | |
parent | fe932c4527aabd1c642b67fddf90e9be8ea380f8 (diff) | |
download | lz4-b8575f2d2b1e05c20812215759b29bf2d0f7a708.zip lz4-b8575f2d2b1e05c20812215759b29bf2d0f7a708.tar.gz lz4-b8575f2d2b1e05c20812215759b29bf2d0f7a708.tar.bz2 |
updated Makefile
to automatically build manual files with
make all
Diffstat (limited to 'doc/lz4_manual.html')
-rw-r--r-- | doc/lz4_manual.html | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/lz4_manual.html b/doc/lz4_manual.html index ff6e149..4c4174d 100644 --- a/doc/lz4_manual.html +++ b/doc/lz4_manual.html @@ -1,10 +1,10 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> -<title>lz4 1.7.5 Manual</title> +<title>1.7.6 Manual</title> </head> <body> -<h1>lz4 1.7.5 Manual</h1> +<h1>1.7.6 Manual</h1> <hr> <a name="Contents"></a><h2>Contents</h2> <ol> @@ -170,21 +170,21 @@ int LZ4_freeStream (LZ4_stream_t* streamPtr); </p></pre><BR> -<pre><b>int LZ4_compress_fast_continue (LZ4_stream_t* streamPtr, const char* src, char* dst, int srcSize, int maxDstSize, int acceleration); +<pre><b>int LZ4_compress_fast_continue (LZ4_stream_t* streamPtr, const char* src, char* dst, int srcSize, int dstCapacity, int acceleration); </b><p> Compress buffer content 'src', using data from previously compressed blocks as dictionary to improve compression ratio. - Important : Previous data blocks are assumed to still be present and unmodified ! + Important : Previous data blocks are assumed to remain present and unmodified ! 'dst' buffer must be already allocated. - If maxDstSize >= LZ4_compressBound(srcSize), compression is guaranteed to succeed, and runs faster. + If dstCapacity >= LZ4_compressBound(srcSize), compression is guaranteed to succeed, and runs faster. If not, and if compressed data cannot fit into 'dst' buffer size, compression stops, and function returns a zero. + After an error, the stream status is invalid, and it can only be reset or freed. </p></pre><BR> <pre><b>int LZ4_saveDict (LZ4_stream_t* streamPtr, char* safeBuffer, int dictSize); -</b><p> If previously compressed data block is not guaranteed to remain available at its memory location, +</b><p> If previously compressed data block is not guaranteed to remain available at its current memory location, save it into a safer place (char* safeBuffer). - Note : you don't need to call LZ4_loadDict() afterwards, - dictionary is immediately usable, you can therefore call LZ4_compress_fast_continue(). - Return : saved dictionary size in bytes (necessarily <= dictSize), or 0 if error. + Note : it's not necessary to call LZ4_loadDict() after LZ4_saveDict(), dictionary is immediately usable. + @return : saved dictionary size in bytes (necessarily <= dictSize), or 0 if error. </p></pre><BR> |