add a section on restricted support of environment variables to README.md

This commit is contained in:
Yi Jin 2018-12-19 17:06:56 -08:00
parent 26a9ae3f5f
commit 29c7d82390

View File

@ -172,6 +172,10 @@ Benchmark arguments :
--priority=rt : set process priority to real-time
```
#### Restricted usage of Environment Variables
Using environment variables to set compression/decompression parameters has security implications. Therefore,
we intentionally restrict its usage. Currently, only `ZSTD_CLEVEL` is supported for setting compression level.
If the value of `ZSTD_CLEVEL` is not a valid integer, it will be ignored with a warning message.
#### Long distance matching mode
The long distance matching mode, enabled with `--long`, is designed to improve