aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc
diff options
context:
space:
mode:
authorBjörn Gustavsson <[email protected]>2016-11-23 11:47:29 +0100
committerBjörn Gustavsson <[email protected]>2016-11-23 11:47:29 +0100
commitd5f65731895c2ae00cc33343509290cbd81a1f64 (patch)
tree39563edf339237c14202db68774cbe108b96afe6 /lib/kernel/doc
parentce5bbeaf294491ba74c8cf793a22cc6d00d368b7 (diff)
parent0d8670a9359d6a895b003ad1cfd7a523983ba775 (diff)
downloadotp-d5f65731895c2ae00cc33343509290cbd81a1f64.tar.gz
otp-d5f65731895c2ae00cc33343509290cbd81a1f64.tar.bz2
otp-d5f65731895c2ae00cc33343509290cbd81a1f64.zip
Merge branch 'jimdigriz/kernel/rpc-doc/ERL-302/PR-1252' into maint
* jimdigriz/kernel/rpc-doc/ERL-302/PR-1252: document {yield/nb_yield}() limitation
Diffstat (limited to 'lib/kernel/doc')
-rw-r--r--lib/kernel/doc/src/rpc.xml16
1 files changed, 16 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/rpc.xml b/lib/kernel/doc/src/rpc.xml
index 5944e9321a..adec2d9520 100644
--- a/lib/kernel/doc/src/rpc.xml
+++ b/lib/kernel/doc/src/rpc.xml
@@ -88,6 +88,12 @@
to retrieve the value of evaluating <c>apply(<anno>Module</anno>,
<anno>Function</anno>, <anno>Args</anno>)</c> on node
<c><anno>Node</anno></c>.</p>
+ <note>
+ <p><seealso marker="#yield/1"><c>yield/1</c></seealso> and
+ <seealso marker="#nb_yield/1"><c>nb_yield/1,2</c></seealso>
+ must be called by the same process from which this function
+ was made otherwise they will never yield correctly.</p>
+ </note>
</desc>
</func>
@@ -299,6 +305,11 @@
the tuple <c>{value, <anno>Val</anno>}</c> when the computation is
finished, or <c>timeout</c> when <c><anno>Timeout</anno></c>
milliseconds has elapsed.</p>
+ <note>
+ <p>This function must be called by the same process from which
+ <seealso marker="#async_call/4"><c>async_call/4</c></seealso>
+ was made otherwise it will only return <c>timeout</c>.</p>
+ </note>
</desc>
</func>
@@ -407,6 +418,11 @@
If the answer is available, it is
returned immediately. Otherwise, the calling process is
suspended until the answer arrives from <c>Node</c>.</p>
+ <note>
+ <p>This function must be called by the same process from which
+ <seealso marker="#async_call/4"><c>async_call/4</c></seealso>
+ was made otherwise it will never return.</p>
+ </note>
</desc>
</func>
</funcs>