sharpetronics/zstd
1
0
Fork 0
mirror of https://github.com/facebook/zstd.git synced 2025-12-10 00:06:51 -05:00
Code Issues Projects Releases Wiki Activity

slightly refined README comments on lib-mt

Browse Source
This commit is contained in:
Yann Collet 2017-04-18 23:15:28 -07:00
parent 987cc95ed7
commit e847730452
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/README.md
View File

@ -24,12 +24,12 @@ Some additional API may be useful if you're looking into advanced features :
#### ZSTDMT API #### ZSTDMT API
To enable building the multithreaded compression API, use the `make lib-mt` target. To enable multithreaded compression within the library, invoke `make lib-mt` target.
The header file zstdmt_compress.h (in compress/) provides the prototypes for the API. Prototypes are defined in header file `compress/zstdmt_compress.h`.
If linking a program that uses the ZSTDMT API against libzstd.a on a POSIX system, When linking a program that uses ZSTDMT API against libzstd.a on a POSIX system,
the -pthread flag must be provided to the compiler at link time. `-pthread` flag must be provided to the compiler and linker.
Note that these prototypes may still be used in a version built without multithread support, Note : ZSTDMT prototypes can still be used with a library built without multithread support,
but they will be single threaded (i.e. no benefits will be given over the standard ZSTD API). but in this case, they will be single threaded only.
#### Modular build #### Modular build