commit | ba196e5127aedef7c54d7f763d9c67a32bfa34b2 | [log] [tgz] |
---|---|---|
author | Hunter Morris <hunter.morris@smarkets.com> | Mon Aug 08 18:02:23 2011 +0100 |
committer | Hunter Morris <hunter.morris@smarkets.com> | Mon Aug 08 18:02:23 2011 +0100 |
tree | 26c5e17144bb927ede5568aad7f590d4b36724b8 | |
parent | eab4f490ce1cc29f7f239feeaa19e13ac69decde [diff] |
Add NIF warning
diff --git a/README.rst b/README.rst index 747fba3..2c8693d 100644 --- a/README.rst +++ b/README.rst
@@ -50,6 +50,9 @@ Specifies whether to use the NIF implementation (``'nif'``) or a pool of port programs (``'port'``). Defaults to ``'port'``. + `WARNING: the NIF implementation will block Erlang VM scheduler + threads and is not suitable for many applications.` + ``pool_size`` Specifies the size of the port program pool. Defaults to ``4``.