]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
clarified status of zstdmt_compress.h API
authorYann Collet <cyan@fb.com>
Thu, 6 Jul 2017 00:20:52 +0000 (17:20 -0700)
committerYann Collet <cyan@fb.com>
Thu, 6 Jul 2017 00:21:13 +0000 (17:21 -0700)
lib/compress/zstdmt_compress.h

index fad63b6d8610b6c5485562818628f9102826c0b3..a6e1759b92aa2cc6259e8d8fece80999b8826c69 100644 (file)
  #endif
 
 
-/* Note : All prototypes defined in this file are labelled experimental.
- *        No guarantee of API continuity is provided on any of them.
- *        In fact, the expectation is that these prototypes will be replaced
- *        by ZSTD_compress_generic() API in the near future */
+/* Note : This is an internal API.
+ *        Some methods are still exposed (ZSTDLIB_API), because for some time,
+ *        it used to be the only way to invoke MT compression.
+ *        Now, it's recommended to use ZSTD_compress_generic() instead.
+ *        These methods will stop being exposed in a future version */
 
 /* ===   Dependencies   === */
 #include <stddef.h>                /* size_t */