From: Nick Magerko <nmagerko@fb.com>
Date: Tue, 20 Aug 2019 21:08:26 +0000 (-0700)
Subject: Document --size-hint
X-Git-Tag: v1.4.4~1^2~72^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=05d7479a505584563c521822ae353d3f256c3bb8;p=thirdparty%2Fzstd.git

Document --size-hint
---

diff --git a/programs/zstd.1.md b/programs/zstd.1.md
index 3ab2667a0..f8349fa80 100644
--- a/programs/zstd.1.md
+++ b/programs/zstd.1.md
@@ -144,6 +144,13 @@ the last one takes effect.
     Due to the chaotic nature of dynamic adaptation, compressed result is not reproducible.
     _note_ : at the time of this writing, `--adapt` can remain stuck at low speed
     when combined with multiple worker threads (>=2).
+* `--size-hint=#`:
+    When handling input from a stream, `zstd` must guess how large the source size
+    will be when optimizing compression parameters. If the stream size is relatively
+    small, this guess may be a poor one, resulting in a higher compression ratio than
+    expected. This feature allows for controlling the guess when needed.
+    Exact guesses result in better compression ratios. Overestimates result in slightly
+    degraded compression ratios, while underestimates may result in significant degradation.
 * `--rsyncable` :
     `zstd` will periodically synchronize the compression state to make the
     compressed file more rsync-friendly. There is a negligible impact to