summaryrefslogtreecommitdiffstats
path: root/lib/README.md
diff options
context:
space:
mode:
authorYann Collet <Cyan4973@users.noreply.github.com>2020-11-07 04:27:42 (GMT)
committerGitHub <noreply@github.com>2020-11-07 04:27:42 (GMT)
commitb5e2a4acd953fd21fef2c372d9750992d454e76f (patch)
treea877dc0ba0603cae293d241a4362675c62f668a3 /lib/README.md
parent1008b8929e43175b8d772729f4045f7272aad6dc (diff)
parent67e661a2ad39258bcb5c6fcc31c9239ff3aabc71 (diff)
downloadlz4-b5e2a4acd953fd21fef2c372d9750992d454e76f.zip
lz4-b5e2a4acd953fd21fef2c372d9750992d454e76f.tar.gz
lz4-b5e2a4acd953fd21fef2c372d9750992d454e76f.tar.bz2
Merge pull request #936 from lz4/alignTest
More alignment tests
Diffstat (limited to 'lib/README.md')
-rw-r--r--lib/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/README.md b/lib/README.md
index 3653c81..ee5d3ba 100644
--- a/lib/README.md
+++ b/lib/README.md
@@ -77,6 +77,10 @@ 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` : 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