From: Przemyslaw Skibinski Date: Thu, 20 Oct 2016 09:01:52 +0000 (+0200) Subject: Merge remote-tracking branch 'refs/remotes/facebook/dev' into dev11 X-Git-Tag: v1.1.1~23^2~5 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=575ab00db7f7afbc42de974cb1754c2c05bff2c0;p=thirdparty%2Fzstd.git Merge remote-tracking branch 'refs/remotes/facebook/dev' into dev11 --- 575ab00db7f7afbc42de974cb1754c2c05bff2c0 diff --cc lib/zstd.h index 2c1407306,c2f5f5d4c..8039cc7db --- a/lib/zstd.h +++ b/lib/zstd.h @@@ -30,32 -30,10 +30,32 @@@ extern "C" #endif -/*======= Version =======*/ +/******************************************************************************************************* + Introduction + + Zstd, short for Zstandard, is a fast lossless compression algorithm, targeting real-time compression scenarios + at zlib-level and better compression ratios. The zstd compression library provides in-memory compression and + decompression functions. The library supports compression levels from 1 up to ZSTD_maxCLevel() which is 22. + Levels from 20 to 22 should be used with caution as they require about 300-1300 MB for compression. + Compression can be done in: + - a single step (described as Simple API) + - a single step, reusing a context (described as Explicit memory management) + - repeated calls of the compression function (described as Streaming compression) + The compression ratio achievable on small data can be highly improved using compression with a dictionary in: + - a single step (described as Simple dictionary API) + - a single step, reusing a dictionary (described as Fast Dictionary API) + + Advanced and experimantal functions can be accessed using #define ZSTD_STATIC_LINKING_ONLY before including zstd.h. + These APIs shall never be used with a dynamic library. + They are not "stable", their definition may change in the future. Only static linking is allowed. +*********************************************************************************************************/ + +/*------ Version ------*/ +ZSTDLIB_API unsigned ZSTD_versionNumber (void); /**< returns version number of ZSTD */ + #define ZSTD_VERSION_MAJOR 1 #define ZSTD_VERSION_MINOR 1 - #define ZSTD_VERSION_RELEASE 0 + #define ZSTD_VERSION_RELEASE 1 #define ZSTD_LIB_VERSION ZSTD_VERSION_MAJOR.ZSTD_VERSION_MINOR.ZSTD_VERSION_RELEASE #define ZSTD_QUOTE(str) #str