doc: Add notes on reentrancy and threading

Fixes #249

Change-Id: Id56464436aeeb2c16bab2cbc0efeb4fded80dc4f
Signed-off-by: Greg Tucker <greg.b.tucker@intel.com>
This commit is contained in:
Greg Tucker 2023-07-19 13:09:27 -07:00
parent e1e0df6c7e
commit e53db85631

View File

@ -183,6 +183,13 @@ platform features. All functions also have base functions, written in portable
C, which the multibinary function will call if none of the required instruction
sets are enabled.
### Threading
All ISA-L library functions are single threaded but reentrant and thread-safe
making it easy for users to incorporate with any threading library. The igzip
command line utility has threaded compression but not built by default. To add
to an automake build do `$ make D="-DHAVE_THREADS"`.
### Included Tests and Utilities
ISA-L source [repo] includes unit tests, performance tests and other utilities.