]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
Fix documentation 1107/head
authorNick Terrell <terrelln@fb.com>
Fri, 13 Apr 2018 19:43:38 +0000 (12:43 -0700)
committerNick Terrell <terrelln@fb.com>
Fri, 13 Apr 2018 19:43:38 +0000 (12:43 -0700)
lib/zstd.h

index aaec49fe7fd03c8b03fab14532b2915e3b392ab4..387586c1e6f675c86342f29afd1ae8d612896a4d 100644 (file)
@@ -1141,13 +1141,15 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
  *  Return a CCtx to clean state.
  *  Useful after an error, or to interrupt an ongoing compression job and start a new one.
  *  Any internal data not yet flushed is cancelled.
- *  Dictionary (if any) is dropped.
+ *  The parameters and dictionary are kept unchanged, to reset them use ZSTD_CCtx_resetParameters().
  */
 ZSTDLIB_API void ZSTD_CCtx_reset(ZSTD_CCtx* cctx);
 
 /*! ZSTD_CCtx_resetParameters() :
  *  All parameters are back to default values (compression level is ZSTD_CLEVEL_DEFAULT).
+ *  Dictionary (if any) is dropped.
  *  Resetting parameters is only possible during frame initialization (before starting compression).
+ *  To reset the context use ZSTD_CCtx_reset().
  *  @return 0 or an error code (which can be checked with ZSTD_isError()).
  */
 ZSTDLIB_API size_t ZSTD_CCtx_resetParameters(ZSTD_CCtx* cctx);