aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBruce Yinhe <bruce@erlang.org>2014-10-22 16:31:05 +0200
committerBruce Yinhe <bruce@erlang.org>2014-10-22 16:31:05 +0200
commita18c56992e48de5f0f0cf65662749239fb2d9cf6 (patch)
tree8d1fd94fd96f3bede7ec723452c2e309b51ca23b
parent44a61648682d08e47536cc87d3d8c023919a91f5 (diff)
parent024ad413bd20219e92c7642e4c29689886bf96ce (diff)
downloadotp-a18c56992e48de5f0f0cf65662749239fb2d9cf6.tar.gz
otp-a18c56992e48de5f0f0cf65662749239fb2d9cf6.tar.bz2
otp-a18c56992e48de5f0f0cf65662749239fb2d9cf6.zip
Merge branch 'vinoski/clarify-drv-async-return' into maint
* vinoski/clarify-drv-async-return: Clarify docs for driver_async() return value
-rw-r--r--erts/doc/src/erl_driver.xml3
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,