sharpetronics/zstd
1
0
Fork 0
mirror of https://github.com/facebook/zstd.git synced 2025-10-09 00:05:28 -04:00
Code Issues Projects Releases Wiki Activity

Improve Documentation Slightly

Browse Source
This commit is contained in:
W. Felix Handte 2020-09-10 16:36:28 -04:00
parent 0faefbf1b3
commit 032010fcc1
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
lib/zstd.h
View File

@ -1548,15 +1548,16 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
#define ZSTD_c_srcSizeHint ZSTD_c_experimentalParam7 #define ZSTD_c_srcSizeHint ZSTD_c_experimentalParam7
/* Controls whether the new and experimental "dedicated dictionary search /* Controls whether the new and experimental "dedicated dictionary search
* structure" can be used. * structure" can be used. This feature is still rough around the edges, be
* prepared for surprising behavior!
* *
* How to use it: * How to use it:
* *
* When using a CDict, whether to use this feature or not is controlled at * When using a CDict, whether to use this feature or not is controlled at
* CDict creation, and it must be set in a CCtxParams set passed into that * CDict creation, and it must be set in a CCtxParams set passed into that
* construction. A compression will then use the feature or not based on how * construction (via ZSTD_createCDict_advanced2()). A compression will then
* the CDict was constructed; the value of this param, set in the CCtx, will * use the feature or not based on how the CDict was constructed; the value of
* have no effect. * this param, set in the CCtx, will have no effect.
* *
* However, when a dictionary buffer is passed into a CCtx, such as via * However, when a dictionary buffer is passed into a CCtx, such as via
* ZSTD_CCtx_loadDictionary(), this param can be set on the CCtx to control * ZSTD_CCtx_loadDictionary(), this param can be set on the CCtx to control
@ -1578,10 +1579,13 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
* written as the compression goes along. This means we can choose a search * written as the compression goes along. This means we can choose a search
* structure for the dictionary that is read-optimized. * structure for the dictionary that is read-optimized.
* *
* This feature enables the use of that different structure. Note that this * This feature enables the use of that different structure.
* means that the CDict tables can no longer be copied into the CCtx, so *
* the dict attachment mode ZSTD_dictForceCopy will no longer be useable. The * Note that some of the members of the ZSTD_compressionParameters struct have
* dictionary can only be attached or reloaded. * different semantics and constraints in the dedicated search structure. It is
* highly recommended that you simply set a compression level in the CCtxParams
* you pass into the CDict creation call, and avoid messing with the cParams
* directly.
* *
* Effects: * Effects:
* *
@ -1589,9 +1593,13 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
* implementation supports this feature. Currently, that's limited to * implementation supports this feature. Currently, that's limited to
* ZSTD_greedy, ZSTD_lazy, and ZSTD_lazy2. * ZSTD_greedy, ZSTD_lazy, and ZSTD_lazy2.
* *
* In general, you should expect compression to be faster, and CDict creation * Note that this means that the CDict tables can no longer be copied into the
* to be slightly slower. Eventually, we will probably make this mode the * CCtx, so the dict attachment mode ZSTD_dictForceCopy will no longer be
* default. * useable. The dictionary can only be attached or reloaded.
*
* In general, you should expect compression to be faster--sometimes very much
* so--and CDict creation to be slightly slower. Eventually, we will probably
* make this mode the default.
*/ */
#define ZSTD_c_enableDedicatedDictSearch ZSTD_c_experimentalParam8 #define ZSTD_c_enableDedicatedDictSearch ZSTD_c_experimentalParam8