Merge branch 'ks/erlang-spawn_opt-process_level/OTP-11008' into maint

* ks/erlang-spawn_opt-process_level/OTP-11008: Fixed documentation for priority_level to spawn_opt Consistent definition of priority levels
erlang · Apr 4, 2013 · d6a367d · d6a367d
2 parents b8e7276 + ed0b56d
commit d6a367d
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 15 deletions.
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
@@ -4477,6 +4477,7 @@ true</pre>
     </func>
     <func>
       <name name="spawn_opt" arity="2"/>
+      <type name="priority_level" />
       <fsummary>Create a new process with a fun as entry point</fsummary>
       <desc>
         <p>Returns the pid of a new process started by the application
@@ -4490,6 +4491,7 @@ true</pre>
     </func>
     <func>
       <name name="spawn_opt" arity="3"/>
+      <type name="priority_level" />
       <fsummary>Create a new process with a fun as entry point on a given node</fsummary>
       <desc>
         <p>Returns the pid of a new process started by the application
@@ -4501,6 +4503,7 @@ true</pre>
     </func>
     <func>
       <name name="spawn_opt" arity="4"/>
+      <type name="priority_level" />
       <fsummary>Create a new process with a function as entry point</fsummary>
       <desc>
         <p>Works exactly like
@@ -4602,6 +4605,7 @@ true</pre>
     </func>
     <func>
       <name name="spawn_opt" arity="5"/>
+      <type name="priority_level" />
       <fsummary>Create a new process with a function as entry point on a given node</fsummary>
       <desc>
         <p>Returns the pid of a new process started by the application

diff --git a/erts/preloaded/src/erlang.erl b/erts/preloaded/src/erlang.erl
@@ -1905,11 +1905,11 @@ setelement(_Index, _Tuple1, _Value) ->
       Function :: atom(),
       Args :: [term()],
       Options :: [Option],
-      Option :: link | monitor | {priority, Level}
+      Option :: link | monitor
+              | {priority, Level :: priority_level()}
               | {fullsweep_after, Number :: non_neg_integer()}
               | {min_heap_size, Size :: non_neg_integer()}
-              | {min_bin_vheap_size, VSize :: non_neg_integer()},
+              | {min_bin_vheap_size, VSize :: non_neg_integer()}.
-      Level :: low | normal | high.
 spawn_opt(_Tuple) ->
    erlang:nif_error(undefined).
 
@@ -2244,11 +2244,11 @@ spawn_monitor(M, F, A) ->
 -spec spawn_opt(Fun, Options) -> pid() | {pid(), reference()} when
       Fun :: function(),
       Options :: [Option],
-      Option :: link | monitor | {priority, Level}
+      Option :: link | monitor
+              | {priority, Level :: priority_level()}
               | {fullsweep_after, Number :: non_neg_integer()}
               | {min_heap_size, Size :: non_neg_integer()}
-              | {min_bin_vheap_size, VSize :: non_neg_integer()},
+              | {min_bin_vheap_size, VSize :: non_neg_integer()}.
-      Level :: low | normal | high.
 spawn_opt(F, O) when erlang:is_function(F) ->
     spawn_opt(erlang, apply, [F, []], O);
 spawn_opt({M,F}=MF, O) when erlang:is_atom(M), erlang:is_atom(F) ->
@@ -2262,11 +2262,11 @@ spawn_opt(F, O) ->
       Node :: node(),
       Fun :: function(),
       Options :: [Option],
-      Option :: link | monitor | {priority, Level}
+      Option :: link | monitor
+              | {priority, Level :: priority_level()}
               | {fullsweep_after, Number :: non_neg_integer()}
               | {min_heap_size, Size :: non_neg_integer()}
-              | {min_bin_vheap_size, VSize :: non_neg_integer()},
+              | {min_bin_vheap_size, VSize :: non_neg_integer()}.
-      Level :: low | normal | high.
 spawn_opt(N, F, O) when N =:= erlang:node() ->
     spawn_opt(F, O);
 spawn_opt(N, F, O) when erlang:is_function(F) ->
@@ -2354,11 +2354,11 @@ spawn_link(N,M,F,A) ->
       Function :: atom(),
       Args :: [term()],
       Options :: [Option],
-      Option :: link | monitor | {priority, Level}
+      Option :: link | monitor
+              | {priority, Level :: priority_level()}
               | {fullsweep_after, Number :: non_neg_integer()}
               | {min_heap_size, Size :: non_neg_integer()}
-              | {min_bin_vheap_size, VSize :: non_neg_integer()},
+              | {min_bin_vheap_size, VSize :: non_neg_integer()}.
-      Level :: low | normal | high.
 spawn_opt(M, F, A, Opts) ->
     case catch erlang:spawn_opt({M,F,A,Opts}) of
 	{'EXIT',{Reason,_}} ->
@@ -2374,11 +2374,11 @@ spawn_opt(M, F, A, Opts) ->
       Function :: atom(),
       Args :: [term()],
       Options :: [Option],
-      Option :: link | monitor | {priority, Level}
+      Option :: link | monitor
+              | {priority, Level :: priority_level()}
               | {fullsweep_after, Number :: non_neg_integer()}
               | {min_heap_size, Size :: non_neg_integer()}
-              | {min_bin_vheap_size, VSize :: non_neg_integer()},
+              | {min_bin_vheap_size, VSize :: non_neg_integer()}.
-      Level :: low | normal | high.
 spawn_opt(N, M, F, A, O) when N =:= erlang:node(),
 			      erlang:is_atom(M), erlang:is_atom(F),
                               erlang:is_list(A), erlang:is_list(O) ->