From: Yann Collet Date: Wed, 19 Apr 2017 06:15:28 +0000 (-0700) Subject: slightly refined README comments on lib-mt X-Git-Tag: v1.2.0^2~37 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e847730452ba155888c193acf63f1038af0bfa81;p=thirdparty%2Fzstd.git slightly refined README comments on lib-mt --- diff --git a/lib/README.md b/lib/README.md index 8fa60a20f..79b6fd500 100644 --- a/lib/README.md +++ b/lib/README.md @@ -24,12 +24,12 @@ Some additional API may be useful if you're looking into advanced features : #### ZSTDMT API -To enable building the multithreaded compression API, use the `make lib-mt` target. -The header file zstdmt_compress.h (in compress/) provides the prototypes for the API. -If linking a program that uses the ZSTDMT API against libzstd.a on a POSIX system, -the -pthread flag must be provided to the compiler at link time. -Note that these prototypes may still be used in a version built without multithread support, -but they will be single threaded (i.e. no benefits will be given over the standard ZSTD 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