]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
minor doc update on --rsyncable 3570/head
authorYann Collet <cyan@fb.com>
Thu, 23 Mar 2023 09:05:13 +0000 (03:05 -0600)
committerYann Collet <cyan@fb.com>
Thu, 23 Mar 2023 21:42:27 +0000 (15:42 -0600)
as requested by @devZer0.
fix #3567

programs/zstd.1.md

index 3b7f24f798053aab2b40c78d0255643e288bf3a1..231341b2a5bac625aaca7b4a13da51207e894937 100644 (file)
@@ -177,9 +177,10 @@ the last one takes effect.
         (i.e. 4096), and by setting a large `--zstd=chainLog=`.
 * `--rsyncable`:
     `zstd` will periodically synchronize the compression state to make the
-    compressed file more rsync-friendly. There is a negligible impact to
-    compression ratio, and the faster compression levels will see a small
-    compression speed hit.
+    compressed file more rsync-friendly.
+    There is a negligible impact to compression ratio,
+    and a potential impact to compression speed, perceptible at higher speeds,
+    for example when combining `--rsyncable` with many parallel worker threads.
     This feature does not work with `--single-thread`. You probably don't want
     to use it with long range mode, since it will decrease the effectiveness of
     the synchronization points, but your mileage may vary.