summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2022-04-17 17:06:18 (GMT)
committerYann Collet <cyan@fb.com>2022-04-17 17:06:18 (GMT)
commitce8ee024b240befac4ca8ab12c6cd812f4a7e38b (patch)
tree9a4612001e31b98a348f03ced05b6eb8b69be586 /doc
parent69bf033106f7a93693fb739b86c7ce2baf570345 (diff)
downloadlz4-ce8ee024b240befac4ca8ab12c6cd812f4a7e38b.zip
lz4-ce8ee024b240befac4ca8ab12c6cd812f4a7e38b.tar.gz
lz4-ce8ee024b240befac4ca8ab12c6cd812f4a7e38b.tar.bz2
update library version to v1.9.4
to reduce confusion in traces between dev branch and latest v1.9.3 release.
Diffstat (limited to 'doc')
-rw-r--r--doc/lz4_manual.html12
-rw-r--r--doc/lz4frame_manual.html6
2 files changed, 9 insertions, 9 deletions
diff --git a/doc/lz4_manual.html b/doc/lz4_manual.html
index b6f304b..037cfc0 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>1.9.3 Manual</title>
+<title>1.9.4 Manual</title>
</head>
<body>
-<h1>1.9.3 Manual</h1>
+<h1>1.9.4 Manual</h1>
<hr>
<a name="Contents"></a><h2>Contents</h2>
<ol>
@@ -57,11 +57,11 @@
<a name="Chapter3"></a><h2>Tuning parameter</h2><pre></pre>
<pre><b>#ifndef LZ4_MEMORY_USAGE
-# define LZ4_MEMORY_USAGE 14
+# define LZ4_MEMORY_USAGE LZ4_MEMORY_USAGE_DEFAULT
#endif
-</b><p> Memory usage formula : N->2^N Bytes (examples : 10 -> 1KB; 12 -> 4KB ; 16 -> 64KB; 20 -> 1MB; etc.)
- Increasing memory usage improves compression ratio.
- Reduced memory usage may improve speed, thanks to better cache locality.
+</b><p> Memory usage formula : N->2^N Bytes (examples : 10 -> 1KB; 12 -> 4KB ; 16 -> 64KB; 20 -> 1MB; )
+ Increasing memory usage improves compression ratio, at the cost of speed.
+ Reduced memory usage may improve speed at the cost of ratio, thanks to better cache locality.
Default value is 14, for 16KB, which nicely fits into Intel x86 L1 cache
</p></pre><BR>
diff --git a/doc/lz4frame_manual.html b/doc/lz4frame_manual.html
index 281c0d6..0040c98 100644
--- a/doc/lz4frame_manual.html
+++ b/doc/lz4frame_manual.html
@@ -1,10 +1,10 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>1.9.3 Manual</title>
+<title>1.9.4 Manual</title>
</head>
<body>
-<h1>1.9.3 Manual</h1>
+<h1>1.9.4 Manual</h1>
<hr>
<a name="Contents"></a><h2>Contents</h2>
<ol>
@@ -109,7 +109,7 @@
</b><p> Returns the maximum possible compressed size with LZ4F_compressFrame() given srcSize and preferences.
`preferencesPtr` is optional. It can be replaced by NULL, in which case, the function will assume default preferences.
Note : this result is only usable with LZ4F_compressFrame().
- It may also be used with LZ4F_compressUpdate() _if no flush() operation_ is performed.
+ It may also be relevant to LZ4F_compressUpdate() _only if_ no flush() operation is ever performed.
</p></pre><BR>