File 2787-Reword-gen_statem-call-exit-description.patch of Package erlang
From 95f0ec3aeb120b8825d9ac3658756549c9c63156 Mon Sep 17 00:00:00 2001
From: Raimo Niskanen <raimo@erlang.org>
Date: Tue, 8 Mar 2022 17:57:59 +0100
Subject: [PATCH 7/8] Reword gen_statem:call exit description
---
lib/stdlib/doc/src/gen_statem.xml | 28 +++++++++++++++++++++++-----
1 file changed, 23 insertions(+), 5 deletions(-)
diff --git a/lib/stdlib/doc/src/gen_statem.xml b/lib/stdlib/doc/src/gen_statem.xml
index 966844d28d..c1a2b1e529 100644
--- a/lib/stdlib/doc/src/gen_statem.xml
+++ b/lib/stdlib/doc/src/gen_statem.xml
@@ -1706,6 +1706,20 @@ handle_event(_, _, State, Data) ->
The call can also fail, for example, if the <c>gen_statem</c>
dies before or during this function call.
</p>
+ <p>
+ When this call fails it
+ <seemfa marker="erts:erlang#exit/1">exits</seemfa>
+ the calling process.
+ The exit term is on the form
+ <c>{Reason, Location}</c> where
+ <c>Location = {gen_statem,call,ArgList}</c>.
+ See
+ <seemfa marker="gen_server#call/3">
+ <c>gen_server:call/3</c>
+ </seemfa>
+ that has a description of relevant
+ values for the <c>Reason</c> in the exit term.
+ </p>
</desc>
</func>
@@ -2194,12 +2208,16 @@ handle_event(_, _, State, Data) ->
terminate, or the atom <c>infinity</c> to wait indefinitely.
Defaults to <c>infinity</c>.
If the server does not terminate within the specified time,
- a <c>timeout</c> exception is raised.
- </p>
- <p>
- If the process does not exist, a <c>noproc</c> exception
- is raised.
+ the call exits the calling process
+ with reason <c>timeout</c>.
</p>
+ <p>
+ If the process does not exist, the call exits
+ the calling process with reason <c>noproc</c>,
+ and with reason <c>{nodedown,Node}</c>
+ if the connection fails to the remote <c>Node</c>
+ where the server runs.
+ </p>
</desc>
</func>
--
2.34.1
