From 29c7d82390bc052bd8d40b1801d96d1655bcc5d8 Mon Sep 17 00:00:00 2001 From: Yi Jin Date: Wed, 19 Dec 2018 17:06:56 -0800 Subject: [PATCH] add a section on restricted support of environment variables to README.md --- programs/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/programs/README.md b/programs/README.md index ca9056eaa..baf90e88f 100644 --- a/programs/README.md +++ b/programs/README.md @@ -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 -- 2.47.2