From: Yann Collet <cyan@fb.com>
Date: Wed, 28 Dec 2022 23:08:18 +0000 (-0800)
Subject: update ZSTD_CCts_setCParams() inline documentation
X-Git-Tag: v1.5.4^2~70
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=00c85b28e724dca2ceeac8ac8ef319c282ad3f5c;p=thirdparty%2Fzstd.git

update ZSTD_CCts_setCParams() inline documentation

specify behavior when changing compression parameters during MT compression,
reported by @embg
---

diff --git a/lib/zstd.h b/lib/zstd.h
index b4035686f..3279ee1a7 100644
--- a/lib/zstd.h
+++ b/lib/zstd.h
@@ -1743,7 +1743,9 @@ ZSTDLIB_STATIC_API size_t ZSTD_checkCParams(ZSTD_compressionParameters params);
 ZSTDLIB_STATIC_API ZSTD_compressionParameters ZSTD_adjustCParams(ZSTD_compressionParameters cPar, unsigned long long srcSize, size_t dictSize);
 
 /*! ZSTD_CCtx_setCParams() :
- *  Set all parameters provided within @cparams into the working @cctx
+ *  Set all parameters provided within @cparams into the working @cctx.
+ *  Note : if modifying parameters during compression (MT mode only),
+ *         note that changes to the .windowLog parameter will be ignored.
  * @return 0 on success, or an error code (can be checked with ZSTD_isError()) */
 ZSTDLIB_STATIC_API size_t ZSTD_CCtx_setCParams(ZSTD_CCtx* cctx, ZSTD_compressionParameters cparams);