summaryrefslogtreecommitdiffstats
path: root/lib/README.md
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2020-11-07 00:43:14 (GMT)
committerYann Collet <cyan@fb.com>2020-11-07 00:43:14 (GMT)
commit211d653ff866ee98a51ab135067369f52f6bdc7b (patch)
tree08203431f5b74519c2e410ffa34082c7d082f4d6 /lib/README.md
parent0c56f838edfb1eb06553985a141e5243f740ef27 (diff)
downloadlz4-211d653ff866ee98a51ab135067369f52f6bdc7b.zip
lz4-211d653ff866ee98a51ab135067369f52f6bdc7b.tar.gz
lz4-211d653ff866ee98a51ab135067369f52f6bdc7b.tar.bz2
re-enable alignment test on all targets
Diffstat (limited to 'lib/README.md')
-rw-r--r--lib/README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/README.md b/lib/README.md
index 7a9e4fd..ee5d3ba 100644
--- a/lib/README.md
+++ b/lib/README.md
@@ -77,8 +77,9 @@ The following build macro can be selected to adjust source code behavior at comp
In most cases, it's not expected to be necessary,
but it can be legitimately considered for less common platforms.
-- `LZ4_ALIGN_TEST` : disable state alignment test when set to 0.
- Is generally enabled by default, except on win32+visual.
+- `LZ4_ALIGN_TEST` : alignment test ensures that the memory area
+ passed as argument to become a compression state is suitable aligned.
+ This test can be disabled, if it proves flaky, by setting this value to 0.
#### Amalgamation