From 34aa401afd93d9aa4e161320300c43f214905b81 Mon Sep 17 00:00:00 2001 From: Yann Collet Date: Thu, 6 Dec 2018 17:22:19 -0800 Subject: [PATCH] updated documentation introducing ZSTD_btultra2 --- lib/zstd.h | 2 +- programs/zstd.1 | 6 +++--- programs/zstd.1.md | 11 ++++++----- programs/zstdgrep.1 | 2 +- programs/zstdless.1 | 2 +- 5 files changed, 12 insertions(+), 11 deletions(-) diff --git a/lib/zstd.h b/lib/zstd.h index 0fec6cb19..17e109b79 100644 --- a/lib/zstd.h +++ b/lib/zstd.h @@ -541,7 +541,7 @@ typedef enum { * , for all strategies > fast, effective maximum is 6. * Special: value 0 means "use default minMatchLength". */ ZSTD_c_targetLength=106, /* Impact of this field depends on strategy. - * For strategies btopt & btultra: + * For strategies btopt, btultra & btultra2: * Length of Match considered "good enough" to stop search. * Larger values make compression stronger, and slower. * For strategy fast: diff --git a/programs/zstd.1 b/programs/zstd.1 index c6ae2c380..230bba51b 100644 --- a/programs/zstd.1 +++ b/programs/zstd.1 @@ -1,5 +1,5 @@ . -.TH "ZSTD" "1" "November 2018" "zstd 1.3.8" "User Commands" +.TH "ZSTD" "1" "December 2018" "zstd 1.3.8" "User Commands" . .SH "NAME" \fBzstd\fR \- zstd, zstdmt, unzstd, zstdcat \- Compress or decompress \.zst files @@ -316,7 +316,7 @@ set process priority to real\-time Specify a strategy used by a match finder\. . .IP -There are 8 strategies numbered from 1 to 8, from faster to stronger: 1=ZSTD_fast, 2=ZSTD_dfast, 3=ZSTD_greedy, 4=ZSTD_lazy, 5=ZSTD_lazy2, 6=ZSTD_btlazy2, 7=ZSTD_btopt, 8=ZSTD_btultra\. +There are 9 strategies numbered from 1 to 9, from faster to stronger: 1=ZSTD_fast, 2=ZSTD_dfast, 3=ZSTD_greedy, 4=ZSTD_lazy, 5=ZSTD_lazy2, 6=ZSTD_btlazy2, 7=ZSTD_btopt, 8=ZSTD_btultra, 9=ZSTD_btultra2\. . .TP \fBwindowLog\fR=\fIwlog\fR, \fBwlog\fR=\fIwlog\fR @@ -373,7 +373,7 @@ The minimum \fImml\fR is 3 and the maximum is 7\. The impact of this field vary depending on selected strategy\. . .IP -For ZSTD_btopt and ZSTD_btultra, it specifies the minimum match length that causes match finder to stop searching for better matches\. A larger \fBtargetLen\fR usually improves compression ratio but decreases compression speed\. +For ZSTD_btopt, ZSTD_btultra and ZSTD_btultra2, it specifies the minimum match length that causes match finder to stop searching\. A larger \fBtargetLen\fR usually improves compression ratio but decreases compression speed\. . .IP For ZSTD_fast, it triggers ultra\-fast mode when > 0\. The value represents the amount of data skipped between match sampling\. Impact is reversed : a larger \fBtargetLen\fR increases compression speed but decreases compression ratio\. diff --git a/programs/zstd.1.md b/programs/zstd.1.md index f6a6e2bd1..348105417 100644 --- a/programs/zstd.1.md +++ b/programs/zstd.1.md @@ -339,9 +339,10 @@ The list of available _options_: - `strategy`=_strat_, `strat`=_strat_: Specify a strategy used by a match finder. - There are 8 strategies numbered from 1 to 8, from faster to stronger: - 1=ZSTD\_fast, 2=ZSTD\_dfast, 3=ZSTD\_greedy, 4=ZSTD\_lazy, - 5=ZSTD\_lazy2, 6=ZSTD\_btlazy2, 7=ZSTD\_btopt, 8=ZSTD\_btultra. + There are 9 strategies numbered from 1 to 9, from faster to stronger: + 1=ZSTD\_fast, 2=ZSTD\_dfast, 3=ZSTD\_greedy, + 4=ZSTD\_lazy, 5=ZSTD\_lazy2, 6=ZSTD\_btlazy2, + 7=ZSTD\_btopt, 8=ZSTD\_btultra, 9=ZSTD\_btultra2. - `windowLog`=_wlog_, `wlog`=_wlog_: Specify the maximum number of bits for a match distance. @@ -394,8 +395,8 @@ The list of available _options_: - `targetLen`=_tlen_, `tlen`=_tlen_: The impact of this field vary depending on selected strategy. - For ZSTD\_btopt and ZSTD\_btultra, it specifies the minimum match length - that causes match finder to stop searching for better matches. + For ZSTD\_btopt, ZSTD\_btultra and ZSTD\_btultra2, it specifies + the minimum match length that causes match finder to stop searching. A larger `targetLen` usually improves compression ratio but decreases compression speed. diff --git a/programs/zstdgrep.1 b/programs/zstdgrep.1 index aad1f4f9c..57bc14de3 100644 --- a/programs/zstdgrep.1 +++ b/programs/zstdgrep.1 @@ -1,5 +1,5 @@ . -.TH "ZSTDGREP" "1" "November 2018" "zstd 1.3.8" "User Commands" +.TH "ZSTDGREP" "1" "December 2018" "zstd 1.3.8" "User Commands" . .SH "NAME" \fBzstdgrep\fR \- print lines matching a pattern in zstandard\-compressed files diff --git a/programs/zstdless.1 b/programs/zstdless.1 index 6fb8ef80f..ff39742bf 100644 --- a/programs/zstdless.1 +++ b/programs/zstdless.1 @@ -1,5 +1,5 @@ . -.TH "ZSTDLESS" "1" "November 2018" "zstd 1.3.8" "User Commands" +.TH "ZSTDLESS" "1" "December 2018" "zstd 1.3.8" "User Commands" . .SH "NAME" \fBzstdless\fR \- view zstandard\-compressed files