1
0
mirror of https://github.com/facebook/zstd.git synced 2025-07-29 11:21:22 +03:00

minor doc update on --rsyncable

as requested by @devZer0.
fix #3567
This commit is contained in:
Yann Collet
2023-03-23 03:05:13 -06:00
parent 3e0550ee52
commit 35c0c2075e

View File

@ -177,9 +177,10 @@ the last one takes effect.
(i.e. 4096), and by setting a large `--zstd=chainLog=`. (i.e. 4096), and by setting a large `--zstd=chainLog=`.
* `--rsyncable`: * `--rsyncable`:
`zstd` will periodically synchronize the compression state to make the `zstd` will periodically synchronize the compression state to make the
compressed file more rsync-friendly. There is a negligible impact to compressed file more rsync-friendly.
compression ratio, and the faster compression levels will see a small There is a negligible impact to compression ratio,
compression speed hit. 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 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 to use it with long range mode, since it will decrease the effectiveness of
the synchronization points, but your mileage may vary. the synchronization points, but your mileage may vary.