File 2788-Reword-gen_event-call-exit-description.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2788-Reword-gen_event-call-exit-description.patch of Package erlang (Revision 2b8d27ae7717c343be1a05a52e3dc269)

Currently displaying revision 2b8d27ae7717c343be1a05a52e3dc269 , Show latest

From 9155b5a0239b7c1cb3046099a9bba68e3ef6935f Mon Sep 17 00:00:00 2001
From: Raimo Niskanen <raimo@erlang.org>
Date: Thu, 10 Mar 2022 17:09:01 +0100
Subject: [PATCH 8/8] Reword gen_event:call exit description

---
 lib/stdlib/doc/src/gen_event.xml | 30 +++++++++++++++++++++++++-----
 1 file changed, 25 insertions(+), 5 deletions(-)

diff --git a/lib/stdlib/doc/src/gen_event.xml b/lib/stdlib/doc/src/gen_event.xml
index 636b749ace..bb891fce56 100644
--- a/lib/stdlib/doc/src/gen_event.xml
+++ b/lib/stdlib/doc/src/gen_event.xml
@@ -4,7 +4,7 @@
 <erlref>
 <header>
 <copyright>
- <year>1996</year><year>2021</year>
+ <year>1996</year><year>2022</year>
 <holder>Ericsson AB. All Rights Reserved.</holder>
 </copyright>
 <legalnotice>
@@ -295,6 +295,20 @@ gen_event:stop -----> Module:terminate/2
 unexpected value <c>Term</c>, this function returns
 <c>{error,{'EXIT',Reason}}</c> or <c>{error,Term}</c>,
 respectively.
+ 
+ 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,&nbsp;Location}</c> where
+ <c>Location&nbsp;=&nbsp;{gen_event,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.
+ 
 </desc>
 </func>
 
@@ -640,10 +654,16 @@ gen_event:stop -----> Module:terminate/2
 specifies how many milliseconds to wait for the event manager to
 terminate, or the atom <c>infinity</c> to wait
 indefinitely. Defaults to <c>infinity</c>. If the
- event manager has not terminated within the specified time, a
- <c>timeout</c> exception is raised.
- If the process does not exist, a <c>noproc</c> exception
- is raised.
+ event manager has not terminated within the specified time,
+ the call exits the calling process
+ with reason <c>timeout</c>.
+ 
+ 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.
+ 
 For a description of <c>EventMgrRef</c>, see
 <seemfa marker="#add_handler/3"><c>add_handler/3</c></seemfa>.
 </desc>
-- 
2.34.1

Places

File 2788-Reword-gen_event-call-exit-description.patch of Package erlang (Revision 2b8d27ae7717c343be1a05a52e3dc269)

Places