diff options
| author | Steve Vinoski <[email protected]> | 2014-10-17 15:50:41 -0400 |
|---|---|---|
| committer | Steve Vinoski <[email protected]> | 2014-10-17 16:00:46 -0400 |
| commit | 024ad413bd20219e92c7642e4c29689886bf96ce (patch) | |
| tree | 5bc7981f047ba9c9323499bb5b8a53f4a1ea7915 | |
| parent | 1aa1a4f6173e9ef59ac0b6bb054368c141000062 (diff) | |
| download | otp-024ad413bd20219e92c7642e4c29689886bf96ce.tar.gz otp-024ad413bd20219e92c7642e4c29689886bf96ce.tar.bz2 otp-024ad413bd20219e92c7642e4c29689886bf96ce.zip | |
Clarify docs for driver_async() return value
The documentation for driver_async() still referred to the return value of
the function as a "handle", which is no longer meaningful since
driver_async_cancel() was deprecated and removed. Modify the documentation
to simply indicate that the driver_async() return value will be -1 if it
fails.
| -rw-r--r-- | erts/doc/src/erl_driver.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/erts/doc/src/erl_driver.xml b/erts/doc/src/erl_driver.xml index 4a1aab75c7..77fc906aca 100644 --- a/erts/doc/src/erl_driver.xml +++ b/erts/doc/src/erl_driver.xml @@ -2033,7 +2033,8 @@ ERL_DRV_MAP int sz entry function is called. If <c>ready_async</c> is null in the driver entry, the <c>async_free</c> function is called instead.</p> - <p>The return value is a handle to the asynchronous task.</p> + <p>The return value is -1 if the <c>driver_async</c> call + fails.</p> <note> <p>As of erts version 5.5.4.3 the default stack size for threads in the async-thread pool is 16 kilowords, |