]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
Fixing ZSTD_c_compressionLevel confusing note 2025/head
authorBimba Shrestha <bimbashrestha@fb.com>
Tue, 3 Mar 2020 21:12:02 +0000 (13:12 -0800)
committerBimba Shrestha <bimbashrestha@fb.com>
Tue, 3 Mar 2020 21:12:02 +0000 (13:12 -0800)
lib/zstd.h

index 73cb3d315d0e87b56059a0d07206b96d4690b108..fcd50986415ba7a9191b7dd88c4c8e03516bb09f 100644 (file)
@@ -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 */