File 0183-Documentation-of-exit-signals-emitted-by-g... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0183-Documentation-of-exit-signals-emitted-by-gen_statem.patch of Package erlang

From 84bfcd2424df29116e827a12d159203579aae0a9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Viktor=20S=C3=B6derqvist?= <viktor.soderqvist@est.tech>
Date: Thu, 22 Oct 2020 15:53:25 +0200
Subject: [PATCH] Documentation of exit signals emitted by gen_statem

Exit signals are described in various sections of the gen_statem
manual where stopping is documented:

* In the Description section, including a link to Receiving Exit
  Signals in the Reference Manual
* Under Types: state_callback_result (stop, stop_and_reply)
* Under start_link/3,4
* Under stop/1,3
* Under Module:terminate/3
---
 lib/stdlib/doc/src/gen_statem.xml | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/lib/stdlib/doc/src/gen_statem.xml b/lib/stdlib/doc/src/gen_statem.xml
index fa3f20535d..512142f0a4 100644
--- a/lib/stdlib/doc/src/gen_statem.xml
+++ b/lib/stdlib/doc/src/gen_statem.xml
@@ -373,6 +373,14 @@ erlang:'!' -----> Module:StateName/3
 <seemfa marker="#enter_loop/4"><c>enter_loop/4,5,6</c></seemfa>,
 that may be used to automatically hibernate the server.
 
+ 
+ If the <c>gen_statem</c> process terminates, e.g. as a result of a
+ function in the callback module returning <c>{stop,Reason}</c>, an exit
+ signal with this <c>Reason</c> is sent to linked processes and ports. See
+ <seeguide marker="system/reference_manual:processes#errors">
+ Processes</seeguide> in the Reference Manual for details regarding error
+ handling using exit signals.
+ 
 </description>
 
 <section>
@@ -1575,6 +1583,9 @@ handle_event(_, _, State, Data) ->
 	 <seemfa marker="#Module:terminate/3"><c>Module:terminate/3</c></seemfa>
 	 with <c>Reason</c> and
 	 <c><anno>NewData</anno></c>, if specified.
+ An exit signal with this reason is sent to linked processes and
+ ports.
+ The default <c>Reason</c> is <c>normal</c>.
 	 
 	 </item>
 	 <tag><c>stop_and_reply</c></tag>
@@ -1585,6 +1596,8 @@ handle_event(_, _, State, Data) ->
 	 <seemfa marker="#Module:terminate/3"><c>Module:terminate/3</c></seemfa>
 	 with <c>Reason</c> and
 	 <c><anno>NewData</anno></c>, if specified.
+ An exit signal with this reason is sent to linked processes and
+ ports.
 	 
 	 </item>
 	</taglist>
@@ -2044,6 +2057,9 @@ handle_event(_, _, State, Data) ->
 	 or
 	 <seetype marker="#start_ret"><c>ignore</c></seetype>,
 	 respectively.
+ An exit signal with the same <c>Reason</c> (or <c>normal</c> if
+ <c>Module:init/1</c> returns <c>ignore</c>) is set to linked processes
+ and ports, including the process calling <c>start_link/3,4</c>.
 	
 </desc>
 </func>
@@ -2107,6 +2123,8 @@ handle_event(_, _, State, Data) ->
 	 <c>shutdown</c>, or <c>{shutdown,Term}</c> causes an
 	 error report to be issued through
 	 <seeerl marker="kernel:logger"><c>logger(3)</c></seeerl>.
+ An exit signal with the same reason is sent to linked processes
+ and ports.
 	 The default <c><anno>Reason</anno></c> is <c>normal</c>.
 	
 	
@@ -2701,6 +2719,10 @@ init(Args) -> erlang:error(not_implemented, [Args]).</pre>
 	 and an error report is issued using
 <seeerl marker="kernel:logger"><c>logger(3)</c></seeerl>.
 	
+ 
+ When the <c>gen_statem</c> process exits, an exit signal with the
+ same reason is sent to linked processes and ports.
+ 
 </desc>
 </func>
 </funcs>
-- 
2.26.2

Places

File 0183-Documentation-of-exit-signals-emitted-by-gen_statem.patch of Package erlang

Places