]> git.ipfire.org Git - thirdparty/zstd.git/commit
Fix ZSTD_estimate* and ZSTD_initCStream() docs 3448/head
authorElliot Gorokhovsky <embg@fb.com>
Mon, 23 Jan 2023 18:28:36 +0000 (13:28 -0500)
committerGitHub <noreply@github.com>
Mon, 23 Jan 2023 18:28:36 +0000 (13:28 -0500)
commit3bfd3be5fb0d11813a57c10bf947224b998e696c
tree91009d6db28e0e019f6f5453f165b43612e7fec5
parent6aee603d0e3ad178d8fe6be1f6107f5ca3c8df39
Fix ZSTD_estimate* and ZSTD_initCStream() docs

Fix the following documentation bugs:
* Note that `ZSTD_estimate*` functions are not compatible with the external matchfinder API
* Note that `ZSTD_estimateCStreamSize_usingCCtxParams()` is not compatible with `nbWorkers >= 1`
* Remove incorrect warning that the legacy streaming API is incompatible with advanced parameters and/or dictionary compression
* Note that `ZSTD_initCStream()` is incompatible with dictionary compression
* Warn that
lib/zstd.h