Differentiate --stream-size from --size-hint

dev
Nick Magerko 2019-08-22 09:37:47 -07:00
parent 2cdda8b3c4
commit fd486a846a
1 changed files with 4 additions and 4 deletions

View File

@ -145,10 +145,10 @@ the last one takes effect.
_note_ : at the time of this writing, `--adapt` can remain stuck at low speed _note_ : at the time of this writing, `--adapt` can remain stuck at low speed
when combined with multiple worker threads (>=2). when combined with multiple worker threads (>=2).
* `--stream-size=#` : * `--stream-size=#` :
When handling input from a stream, `zstd` must guess how large the source size Sets the pledged source size of input coming from a stream. This value must be exact, as it
will be when optimizing compression parameters. This option sets the pledged source will be included in the produced frame header. Incorrect stream sizes will cause an error.
size of a stream to eliminate that guesswork. Note that the pledged size must be exact; This information will be used to better optimize compression parameters, resulting in
incorrect stream sizes will cause an error. better and potentially faster compression, especially for smaller source sizes.
* `--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. There is a negligible impact to