diff options
| author | Baptiste Daroussin <bapt@FreeBSD.org> | 2017-05-06 10:17:59 +0000 |
|---|---|---|
| committer | Baptiste Daroussin <bapt@FreeBSD.org> | 2017-05-06 10:17:59 +0000 |
| commit | ffcbc2d7ba03067492045e4cbead519a3b3c27ef (patch) | |
| tree | df436f4253158a7d5a4875e54cd7d273dd5334a6 /lib/README.md | |
| parent | ab984b3e51d32af796fe89e130f57bf58b8a14b2 (diff) | |
Notes
Diffstat (limited to 'lib/README.md')
| -rw-r--r-- | lib/README.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/README.md b/lib/README.md index 3357e3d870967..79b6fd50014d4 100644 --- a/lib/README.md +++ b/lib/README.md @@ -22,6 +22,14 @@ Some additional API may be useful if you're looking into advanced features : They are not "stable", their definition may change in the future. Only static linking is allowed. +#### ZSTDMT API + +To enable multithreaded compression within the library, invoke `make lib-mt` target. +Prototypes are defined in header file `compress/zstdmt_compress.h`. +When linking a program that uses ZSTDMT API against libzstd.a on a POSIX system, +`-pthread` flag must be provided to the compiler and linker. +Note : ZSTDMT prototypes can still be used with a library built without multithread support, +but in this case, they will be single threaded only. #### Modular build |