From: Nick Magerko <nmagerko@fb.com>
Date: Mon, 19 Aug 2019 20:08:41 +0000 (-0700)
Subject: Add mention of regression with poor size hints
X-Git-Tag: v1.4.4~1^2~72^2~10
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=09894dc2ebd9c33ac87bf20f658fb82da09a2479;p=thirdparty%2Fzstd.git

Add mention of regression with poor size hints
---

diff --git a/lib/zstd.h b/lib/zstd.h
index ee7871f12..0fbe71ab8 100644
--- a/lib/zstd.h
+++ b/lib/zstd.h
@@ -1447,7 +1447,8 @@ ZSTDLIB_API size_t ZSTD_CCtx_refPrefix_advanced(ZSTD_CCtx* cctx, const void* pre
 
 /* User's best guess of source size.
  * Hint is not valid when srcSizeHint == 0.
- * There is no guarantee that hint is close to actual source size */
+ * There is no guarantee that hint is close to actual source size,
+ * but compression ratio may regress significantly if guess considerably underestimates */
 #define ZSTD_c_srcSizeHint ZSTD_c_experimentalParam7
 
 /*! ZSTD_CCtx_getParameter() :