From: Yann Collet <cyan@fb.com>
Date: Thu, 15 Nov 2018 18:52:24 +0000 (-0800)
Subject: updated manual
X-Git-Tag: v1.3.8~33^2~30
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4542b9f1cfd8e4490b34392666a62ed2d1d882b1;p=thirdparty%2Fzstd.git

updated manual
---

diff --git a/doc/zstd_manual.html b/doc/zstd_manual.html
index 83f4c4556..be9385fa8 100644
--- a/doc/zstd_manual.html
+++ b/doc/zstd_manual.html
@@ -510,6 +510,28 @@ size_t ZSTD_sizeof_DDict(const ZSTD_DDict* ddict);
                               * enum. See the comments on that enum for an
                               * explanation of the feature.
                               */
+    </b>/* Question : should rsyncable be categorized as experimental, or be candidate for stable ? */<b>
+    ZSTD_p_rsyncable,        </b>/* Enables rsyncable mode, which makes compressed<b>
+                              * files more rsync friendly by adding periodic
+                              * synchronization points to the compressed data.
+                              * The target average block size is
+                              * ZSTD_p_jobSize / 2. You can modify the job size
+                              * to increase or decrease the granularity of the
+                              * synchronization point. Once the jobSize is
+                              * smaller than the window size, you will start to
+                              * see degraded compression ratio.
+                              * NOTE: This only works when multithreading is
+                              * enabled.
+                              * NOTE: You probably don't want to use this with
+                              * long range mode, since that will decrease the
+                              * effectiveness of the synchronization points,
+                              * but your milage may vary.
+                              * NOTE: Rsyncable mode will limit the maximum
+                              * compression speed to approximately 400 MB/s.
+                              * If your compression level is already running
+                              * significantly slower than that (< 200 MB/s),
+                              * the speed won't be significantly impacted.
+                              */
 } ZSTD_cParameter;
 </b></pre><BR>
 <pre><b>size_t ZSTD_CCtx_setParameter(ZSTD_CCtx* cctx, ZSTD_cParameter param, unsigned value);