updated version number (to v1.4.1)
also : added doc on context re-use, as suggested by @scherepanov at #1676dev
parent
096714d1b8
commit
b8ec4b0fd6
|
@ -1,10 +1,10 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
||||||
<title>zstd 1.4.0 Manual</title>
|
<title>zstd 1.4.1 Manual</title>
|
||||||
</head>
|
</head>
|
||||||
<body>
|
<body>
|
||||||
<h1>zstd 1.4.0 Manual</h1>
|
<h1>zstd 1.4.1 Manual</h1>
|
||||||
<hr>
|
<hr>
|
||||||
<a name="Contents"></a><h2>Contents</h2>
|
<a name="Contents"></a><h2>Contents</h2>
|
||||||
<ol>
|
<ol>
|
||||||
|
@ -141,9 +141,14 @@ int ZSTD_maxCLevel(void); </b>/*!< maximum compression lev
|
||||||
<a name="Chapter4"></a><h2>Explicit context</h2><pre></pre>
|
<a name="Chapter4"></a><h2>Explicit context</h2><pre></pre>
|
||||||
|
|
||||||
<h3>Compression context</h3><pre> When compressing many times,
|
<h3>Compression context</h3><pre> When compressing many times,
|
||||||
it is recommended to allocate a context just once, and re-use it for each successive compression operation.
|
it is recommended to allocate a context just once,
|
||||||
|
and re-use it for each successive compression operation.
|
||||||
This will make workload friendlier for system's memory.
|
This will make workload friendlier for system's memory.
|
||||||
Use one context per thread for parallel execution in multi-threaded environments.
|
Note : re-using context is just a speed / resource optimization.
|
||||||
|
It doesn't change the compression ratio, which remains identical.
|
||||||
|
Note 2 : In multi-threaded environments,
|
||||||
|
use one different context per thread for parallel execution.
|
||||||
|
|
||||||
</pre><b><pre>typedef struct ZSTD_CCtx_s ZSTD_CCtx;
|
</pre><b><pre>typedef struct ZSTD_CCtx_s ZSTD_CCtx;
|
||||||
ZSTD_CCtx* ZSTD_createCCtx(void);
|
ZSTD_CCtx* ZSTD_createCCtx(void);
|
||||||
size_t ZSTD_freeCCtx(ZSTD_CCtx* cctx);
|
size_t ZSTD_freeCCtx(ZSTD_CCtx* cctx);
|
||||||
|
|
11
lib/zstd.h
11
lib/zstd.h
|
@ -71,7 +71,7 @@ extern "C" {
|
||||||
/*------ Version ------*/
|
/*------ Version ------*/
|
||||||
#define ZSTD_VERSION_MAJOR 1
|
#define ZSTD_VERSION_MAJOR 1
|
||||||
#define ZSTD_VERSION_MINOR 4
|
#define ZSTD_VERSION_MINOR 4
|
||||||
#define ZSTD_VERSION_RELEASE 0
|
#define ZSTD_VERSION_RELEASE 1
|
||||||
|
|
||||||
#define ZSTD_VERSION_NUMBER (ZSTD_VERSION_MAJOR *100*100 + ZSTD_VERSION_MINOR *100 + ZSTD_VERSION_RELEASE)
|
#define ZSTD_VERSION_NUMBER (ZSTD_VERSION_MAJOR *100*100 + ZSTD_VERSION_MINOR *100 + ZSTD_VERSION_RELEASE)
|
||||||
ZSTDLIB_API unsigned ZSTD_versionNumber(void); /**< to check runtime library version */
|
ZSTDLIB_API unsigned ZSTD_versionNumber(void); /**< to check runtime library version */
|
||||||
|
@ -183,9 +183,14 @@ ZSTDLIB_API int ZSTD_maxCLevel(void); /*!< maximum compres
|
||||||
***************************************/
|
***************************************/
|
||||||
/*= Compression context
|
/*= Compression context
|
||||||
* When compressing many times,
|
* When compressing many times,
|
||||||
* it is recommended to allocate a context just once, and re-use it for each successive compression operation.
|
* it is recommended to allocate a context just once,
|
||||||
|
* and re-use it for each successive compression operation.
|
||||||
* This will make workload friendlier for system's memory.
|
* This will make workload friendlier for system's memory.
|
||||||
* Use one context per thread for parallel execution in multi-threaded environments. */
|
* Note : re-using context is just a speed / resource optimization.
|
||||||
|
* It doesn't change the compression ratio, which remains identical.
|
||||||
|
* Note 2 : In multi-threaded environments,
|
||||||
|
* use one different context per thread for parallel execution.
|
||||||
|
*/
|
||||||
typedef struct ZSTD_CCtx_s ZSTD_CCtx;
|
typedef struct ZSTD_CCtx_s ZSTD_CCtx;
|
||||||
ZSTDLIB_API ZSTD_CCtx* ZSTD_createCCtx(void);
|
ZSTDLIB_API ZSTD_CCtx* ZSTD_createCCtx(void);
|
||||||
ZSTDLIB_API size_t ZSTD_freeCCtx(ZSTD_CCtx* cctx);
|
ZSTDLIB_API size_t ZSTD_freeCCtx(ZSTD_CCtx* cctx);
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
.
|
.
|
||||||
.TH "ZSTD" "1" "December 2018" "zstd 1.3.8" "User Commands"
|
.TH "ZSTD" "1" "July 2019" "zstd 1.4.1" "User Commands"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fBzstd\fR \- zstd, zstdmt, unzstd, zstdcat \- Compress or decompress \.zst files
|
\fBzstd\fR \- zstd, zstdmt, unzstd, zstdcat \- Compress or decompress \.zst files
|
||||||
|
@ -187,6 +187,10 @@ verbose mode
|
||||||
suppress warnings, interactivity, and notifications\. specify twice to suppress errors too\.
|
suppress warnings, interactivity, and notifications\. specify twice to suppress errors too\.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
|
\fB\-\-no\-progress\fR
|
||||||
|
do not display the progress bar, but keep all other messages\.
|
||||||
|
.
|
||||||
|
.TP
|
||||||
\fB\-C\fR, \fB\-\-[no\-]check\fR
|
\fB\-C\fR, \fB\-\-[no\-]check\fR
|
||||||
add integrity check computed from uncompressed data (default: enabled)
|
add integrity check computed from uncompressed data (default: enabled)
|
||||||
.
|
.
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
.
|
.
|
||||||
.TH "ZSTDGREP" "1" "December 2018" "zstd 1.3.8" "User Commands"
|
.TH "ZSTDGREP" "1" "July 2019" "zstd 1.4.1" "User Commands"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fBzstdgrep\fR \- print lines matching a pattern in zstandard\-compressed files
|
\fBzstdgrep\fR \- print lines matching a pattern in zstandard\-compressed files
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
.
|
.
|
||||||
.TH "ZSTDLESS" "1" "December 2018" "zstd 1.3.8" "User Commands"
|
.TH "ZSTDLESS" "1" "July 2019" "zstd 1.4.1" "User Commands"
|
||||||
.
|
.
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fBzstdless\fR \- view zstandard\-compressed files
|
\fBzstdless\fR \- view zstandard\-compressed files
|
||||||
|
|
Loading…
Reference in New Issue