Expose ZSTD_CLEVEL_DEFAULT and update documentation

This commit is contained in:
Duc Ngo 2018-06-08 11:29:51 -07:00
parent 8ef75547ef
commit e34c000e44
2 changed files with 9 additions and 10 deletions

View File

@ -8,15 +8,6 @@
* You may select, at your option, one of the above-listed licenses. * You may select, at your option, one of the above-listed licenses.
*/ */
/*-*************************************
* Tuning parameters
***************************************/
#ifndef ZSTD_CLEVEL_DEFAULT
# define ZSTD_CLEVEL_DEFAULT 3
#endif
/*-************************************* /*-*************************************
* Dependencies * Dependencies
***************************************/ ***************************************/

View File

@ -35,6 +35,14 @@ extern "C" {
#endif #endif
/*-*************************************
* Tuning parameters
***************************************/
#ifndef ZSTD_CLEVEL_DEFAULT
# define ZSTD_CLEVEL_DEFAULT 3
#endif
/******************************************************************************************************* /*******************************************************************************************************
Introduction Introduction
@ -949,7 +957,7 @@ typedef enum {
/* compression parameters */ /* compression parameters */
ZSTD_p_compressionLevel=100, /* Update all compression parameters according to pre-defined cLevel table ZSTD_p_compressionLevel=100, /* Update all compression parameters according to pre-defined cLevel table
* Default level is ZSTD_CLEVEL_DEFAULT==3. * Default level is ZSTD_CLEVEL_DEFAULT==3.
* Special: value 0 means "do not change cLevel". * Special: value 0 means default, which is controlled by ZSTD_CLEVEL_DEFAULT.
* Note 1 : it's possible to pass a negative compression level by casting it to unsigned type. * Note 1 : it's possible to pass a negative compression level by casting it to unsigned type.
* Note 2 : setting a level sets all default values of other compression parameters. * Note 2 : setting a level sets all default values of other compression parameters.
* Note 3 : setting compressionLevel automatically updates ZSTD_p_compressLiterals. */ * Note 3 : setting compressionLevel automatically updates ZSTD_p_compressLiterals. */