From: W. Felix Handte <w@felixhandte.com>
Date: Fri, 28 Aug 2020 16:31:01 +0000 (-0400)
Subject: Add Warning Comment to ZSTD_createCDict_advanced2() Declaration
X-Git-Tag: v1.4.7~81^2~6
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c09454e28f667d6daba8ea30032a59a21c6243a8;p=thirdparty%2Fzstd.git

Add Warning Comment to ZSTD_createCDict_advanced2() Declaration
---

diff --git a/lib/zstd.h b/lib/zstd.h
index bd4e79f7b..e42a4bd49 100644
--- a/lib/zstd.h
+++ b/lib/zstd.h
@@ -1405,13 +1405,14 @@ ZSTDLIB_API ZSTD_CDict* ZSTD_createCDict_advanced(const void* dict, size_t dictS
                                                   ZSTD_customMem customMem);
 
 /**
- * TODO: document!
+ * This API is temporary and is expected to change or disappear in the future!
  */
-ZSTDLIB_API ZSTD_CDict* ZSTD_createCDict_advanced2(const void* dict, size_t dictSize,
-                                                  ZSTD_dictLoadMethod_e dictLoadMethod,
-                                                  ZSTD_dictContentType_e dictContentType,
-                                                  ZSTD_CCtx_params* cctxParams,
-                                                  ZSTD_customMem customMem);
+ZSTDLIB_API ZSTD_CDict* ZSTD_createCDict_advanced2(
+    const void* dict, size_t dictSize,
+    ZSTD_dictLoadMethod_e dictLoadMethod,
+    ZSTD_dictContentType_e dictContentType,
+    ZSTD_CCtx_params* cctxParams,
+    ZSTD_customMem customMem);
 
 ZSTDLIB_API ZSTD_DDict* ZSTD_createDDict_advanced(const void* dict, size_t dictSize,
                                                   ZSTD_dictLoadMethod_e dictLoadMethod,