File 1058-Fix-type-and-template-errors-from-bugs.erl... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 1058-Fix-type-and-template-errors-from-bugs.erlang.org-ER.patch of Package erlang (Revision 909c7ccc6a11f87db3ed0c2a0454d876)

Currently displaying revision 909c7ccc6a11f87db3ed0c2a0454d876 , Show latest

From edd9607b3bea79be718b774b8c58e623b918eee2 Mon Sep 17 00:00:00 2001
From: Raimo Niskanen <raimo@erlang.org>
Date: Fri, 15 Jul 2016 16:18:06 +0200
Subject: [PATCH] Fix type and template errors from bugs.erlang.org: ERL-172
 and ERL-187

---
 lib/stdlib/doc/src/gen_statem.xml | 18 +++++++++++++-----
 lib/stdlib/src/gen_statem.erl     | 13 +++++++------
 lib/tools/emacs/erlang-skels.el   | 12 +++++++-----
 3 files changed, 27 insertions(+), 16 deletions(-)

diff --git a/lib/stdlib/doc/src/gen_statem.xml b/lib/stdlib/doc/src/gen_statem.xml
index c57a31f..ed44eef 100644
--- a/lib/stdlib/doc/src/gen_statem.xml
+++ b/lib/stdlib/doc/src/gen_statem.xml
@@ -1262,9 +1262,9 @@ handle_event(_, _, State, Data) ->
 <v>&nbsp;&nbsp;Vsn = term()</v>
 <v>OldState = NewState = term()</v>
 <v>Extra = term()</v>
-	<v>Result = {NewCallbackMode,NewState,NewData} | Reason</v>
+	<v>Result = {CallbackMode,NewState,NewData} | Reason</v>
 	<v>
-	 NewCallbackMode =
+	 CallbackMode =
 	 <seealso marker="#type-callback_mode">callback_mode()</seealso>
 	</v>
 	<v>
@@ -1321,11 +1321,19 @@ handle_event(_, _, State, Data) ->
 	
 	 If successful, the function must return the updated
 	 internal state in an
-	 <c>{NewCallbackMode,NewState,NewData}</c> tuple.
+	 <c>{CallbackMode,NewState,NewData}</c> tuple.
 	
 	
-	 If the function returns <c>Reason</c>, the ongoing
-	 upgrade fails and rolls back to the old release.
+	 If the function returns a failure <c>Reason</c>, the ongoing
+	 upgrade fails and rolls back to the old release.
+	 Note that <c>Reason</c> can not be a 3-tuple since that
+	 will be regarded as a
+	 <c>{CallbackMode,NewState,NewData}</c> tuple,
+	 and that a tuple matching <c>{ok,_}</c>
+	 is an invalid failure <c>Reason</c>.
+	 It is recommended to use an atom as <c>Reason</c> since
+	 it will be wrapped in an <c>{error,Reason}</c> tuple.
+	
 	
 	 This function can use
 	 <seealso marker="erts:erlang#throw/1"><c>erlang:throw/1</c></seealso>
diff --git a/lib/stdlib/src/gen_statem.erl b/lib/stdlib/src/gen_statem.erl
index 23bddaf..c02e6a1 100644
--- a/lib/stdlib/src/gen_statem.erl
+++ b/lib/stdlib/src/gen_statem.erl
@@ -219,9 +219,10 @@
 	 OldState :: state(),
 	 OldData :: data(),
 	 Extra :: term()) ->
- {NewCallbackMode :: callback_mode(),
+ {CallbackMode :: callback_mode(),
 NewState :: state(),
- NewData :: data()}.
+ NewData :: data()} |
+ (Reason :: term()).
 
 %% Format the callback module state in some sensible that is
 %% often condensed way. For StatusOption =:= 'normal' the perferred
@@ -630,11 +631,11 @@ system_code_change(
 	 Result -> Result
 	end
 of
-	{NewCallbackMode,NewState,NewData} ->
-	 callback_mode(NewCallbackMode) orelse
-		error({callback_mode,NewCallbackMode}),
+	{CallbackMode,NewState,NewData} ->
+	 callback_mode(CallbackMode) orelse
+		error({callback_mode,CallbackMode}),
 	 {ok,
-	 S#{callback_mode := NewCallbackMode,
+	 S#{callback_mode := CallbackMode,
 		state := NewState,
 		data := NewData}};
 	{ok,_} = Error ->
diff --git a/lib/tools/emacs/erlang-skels.el b/lib/tools/emacs/erlang-skels.el
index ce26c83..c1152f3 100644
--- a/lib/tools/emacs/erlang-skels.el
+++ b/lib/tools/emacs/erlang-skels.el
@@ -903,7 +903,7 @@ Please see the function `tempo-define-template'.")
 "%% gen_statem:start_link/[3,4], this function is called by the new" n
 "%% process to initialize." n
 (erlang-skel-separator-end 2)
- "-spec init(Args :: term()) -> " n>
+ "-spec init(Args :: term()) ->" n>
 "{gen_statem:callback_mode()," n>
 "State :: term(), Data :: term()} |" n>
 "{gen_statem:callback_mode()," n>
@@ -927,7 +927,7 @@ Please see the function `tempo-define-template'.")
 "-spec state_name(" n>
 "gen_statem:event_type(), Msg :: term()," n>
 "Data :: term()) ->" n>
- "gen_statem:state_function_result(). " n
+ "gen_statem:state_function_result()." n
 "state_name({call,Caller}, _Msg, Data) ->" n>
 "{next_state, state_name, Data, [{reply,Caller,ok}]}." n
 n
@@ -940,7 +940,7 @@ Please see the function `tempo-define-template'.")
 "-spec handle_event(" n>
 "gen_statem:event_type(), Msg :: term()," n>
 "State :: term(), Data :: term()) ->" n>
- "gen_statem:handle_event_result(). " n
+ "gen_statem:handle_event_result()." n
 "handle_event({call,From}, _Msg, State, Data) ->" n>
 "{next_state, State, Data, [{reply,From,ok}]}." n
 n
@@ -965,9 +965,11 @@ Please see the function `tempo-define-template'.")
 "-spec code_change(" n>
 "OldVsn :: term() | {down,term()}," n>
 "State :: term(), Data :: term(), Extra :: term()) ->" n>
- "{ok, NewState :: term(), NewData :: term()}." n
+ "{gen_statem:callback_mode()," n>
+ "NewState :: term(), NewData :: term()} |" n>
+ "(Reason :: term())." n
 "code_change(_OldVsn, State, Data, _Extra) ->" n>
- "{ok, State, Data}." n
+ "{state_functions, State, Data}." n
 n
 (erlang-skel-double-separator-start 3)
 "%%% Internal functions" n
-- 
2.1.4

Places

File 1058-Fix-type-and-template-errors-from-bugs.erlang.org-ER.patch of Package erlang (Revision 909c7ccc6a11f87db3ed0c2a0454d876)

Places