From: Bimba Shrestha <bimbashrestha@fb.com>
Date: Tue, 3 Mar 2020 21:12:02 +0000 (-0800)
Subject: Fixing ZSTD_c_compressionLevel confusing note
X-Git-Tag: v1.4.5^2~84^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cba46e9b7b3702e76073fe6c24ff490d17630a50;p=thirdparty%2Fzstd.git

Fixing ZSTD_c_compressionLevel confusing note
---

diff --git a/lib/zstd.h b/lib/zstd.h
index 73cb3d315..fcd509864 100644
--- a/lib/zstd.h
+++ b/lib/zstd.h
@@ -274,7 +274,10 @@ typedef enum {
                               * Default level is ZSTD_CLEVEL_DEFAULT==3.
                               * Special: value 0 means default, which is controlled by ZSTD_CLEVEL_DEFAULT.
                               * Note 1 : it's possible to pass a negative compression level.
-                              * Note 2 : setting a level resets all other compression parameters to default */
+                              * Note 2 : setting a level does not automatically set all other compression parameters 
+                              *   to default. Setting this will however eventually dynamically impact the compression 
+                              *   parameters which have not been manually set. The manually set 
+                              *   ones will 'stick'. */
     /* Advanced compression parameters :
      * It's possible to pin down compression parameters to some specific values.
      * In which case, these values are no longer dynamically selected by the compressor */