Merge branch 'rj/fix-supervisor-shutdown-doc' into maint

* rj/fix-supervisor-shutdown-doc:
  Fix small typo in kernel app doc
  Cosmetic: split very long lines from supervisor doc
  Fix supervisor doc: Shutdown, MaxR and MaxT type specs
  Add the type restrictions in the code comments
  Remove trailing spaces

OTP-9987

4 files changed, 26 insertions, 21 deletions

diff --git a/lib/kernel/doc/src/kernel_app.xml b/lib/kernel/doc/src/kernel_app.xml
index 0f71a4f0f2..63fdc223f4 100644
--- a/lib/kernel/doc/src/kernel_app.xml
+++ b/lib/kernel/doc/src/kernel_app.xml
@@ -104,7 +104,7 @@
           that node. <c>Value</c> is one of:</p>
         <taglist>
           <tag><c>never</c></tag>
-          <item>Connections are never automatically connected, they
+          <item>Connections are never automatically established, they
            must be explicitly connected. See <c>net_kernel(3)</c>.</item>
           <tag><c>once</c></tag>
           <item>Connections will be established automatically, but only
diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml
index 35f4f82264..9b41672bf1 100644
--- a/lib/stdlib/doc/src/supervisor.xml
+++ b/lib/stdlib/doc/src/supervisor.xml
@@ -55,7 +55,8 @@
       monitoring its child processes. The basic idea of a supervisor is
       that it should keep its child processes alive by restarting them
       when necessary.</p>
-    <p>The children of a supervisor is defined as a list of <em>child specifications</em>. When the supervisor is started, the child
+    <p>The children of a supervisor is defined as a list of
+      <em>child specifications</em>. When the supervisor is started, the child
       processes are started in order from left to right according to
       this list. When the supervisor terminates, it first terminates
       its child processes in reversed start order, from right to left.</p>
@@ -100,7 +101,8 @@
       </item>
     </list>
     <p>To prevent a supervisor from getting into an infinite loop of
-      child process terminations and restarts, a <em>maximum restart frequency</em> is defined using two integer values <c>MaxR</c>
+      child process terminations and restarts, a <em>maximum restart frequency</em>
+      is defined using two integer values <c>MaxR</c>
       and <c>MaxT</c>. If more than <c>MaxR</c> restarts occur within
       <c>MaxT</c> seconds, the supervisor terminates all child
       processes and then itself.
@@ -114,7 +116,7 @@ child_spec() = {Id,StartFunc,Restart,Shutdown,Type,Modules}
   M = F = atom()
   A = [term()]
  Restart = permanent | transient | temporary
- Shutdown = brutal_kill | int()>=0 | infinity
+ Shutdown = brutal_kill | int()>0 | infinity
  Type = worker | supervisor
  Modules = [Module] | dynamic
   Module = atom()</pre>
@@ -197,7 +199,8 @@ child_spec() = {Id,StartFunc,Restart,Shutdown,Type,Modules}
           the callback module, if the child process is a supervisor,
           gen_server or gen_fsm. If the child process is an event
           manager (gen_event) with a dynamic set of callback modules,
-          <c>Modules</c> should be <c>dynamic</c>. See <em>OTP Design Principles</em> for more information about release handling.</p>
+          <c>Modules</c> should be <c>dynamic</c>. See <em>OTP Design Principles</em>
+          for more information about release handling.</p>
       </item>
       <item>
         <p>Internally, the supervisor also keeps track of the pid
@@ -443,7 +446,8 @@ child_spec() = {Id,StartFunc,Restart,Shutdown,Type,Modules}
     </func>
     <func>
       <name name="which_children" arity="1"/>
-      <fsummary>Return information about all children specifications and child processes belonging to a supervisor.</fsummary>
+      <fsummary>Return information about all children specifications and
+        child processes belonging to a supervisor.</fsummary>
       <desc>
         <p>Returns a newly created list with information about all child
           specifications and child processes belonging to
@@ -477,7 +481,8 @@ child_spec() = {Id,StartFunc,Restart,Shutdown,Type,Modules}
     </func>
     <func>
       <name name="count_children" arity="1"/>
-      <fsummary>Return counts for the number of childspecs, active children, supervisors and workers.</fsummary>
+      <fsummary>Return counts for the number of childspecs, active children,
+        supervisors and workers.</fsummary>
       <desc>
         <p>Returns a property list (see <c>proplists</c>) containing the
           counts for each of the following elements of the supervisor's
@@ -527,7 +532,8 @@ child_spec() = {Id,StartFunc,Restart,Shutdown,Type,Modules}
         <v>Args = term()</v>
         <v>Result = {ok,{{RestartStrategy,MaxR,MaxT},[ChildSpec]}} | ignore</v>
         <v>&nbsp;RestartStrategy = <seealso marker="#type-strategy">strategy()</seealso></v>
-        <v>&nbsp;MaxR = MaxT = integer()>=0</v>
+        <v>&nbsp;MaxR = integer()>=0</v>
+        <v>&nbsp;MaxT = integer()>0</v>
         <v>&nbsp;ChildSpec = <seealso marker="#type-child_spec">child_spec()</seealso></v>
       </type>
       <desc>
diff --git a/lib/stdlib/src/supervisor.erl b/lib/stdlib/src/supervisor.erl
index f315064b03..c10da1989c 100644
--- a/lib/stdlib/src/supervisor.erl
+++ b/lib/stdlib/src/supervisor.erl
@@ -624,13 +624,12 @@ check_flags(What) ->
     {bad_flags, What}.
 
 update_childspec(State, StartSpec) when ?is_simple(State) ->
-    case check_startspec(StartSpec) of                        
-        {ok, [Child]} ->                                      
-            {ok, State#state{children = [Child]}};            
-        Error ->                                              
-            {error, Error}                                    
-    end;                                                      
-
+    case check_startspec(StartSpec) of
+        {ok, [Child]} ->
+            {ok, State#state{children = [Child]}};
+        Error ->
+            {error, Error}
+    end;
 update_childspec(State, StartSpec) ->
     case check_startspec(StartSpec) of
 	{ok, Children} ->
@@ -650,7 +649,7 @@ update_childspec1([Child|OldC], Children, KeepOld) ->
     end;
 update_childspec1([], Children, KeepOld) ->
     %% Return them in (kept) reverse start order.
-    lists:reverse(Children ++ KeepOld).  
+    lists:reverse(Children ++ KeepOld).
 
 update_chsp(OldCh, Children) ->
     case lists:map(fun(Ch) when OldCh#child.name =:= Ch#child.name ->
@@ -1148,9 +1147,9 @@ remove_child(Child, State) ->
 %% Args: SupName = {local, atom()} | {global, atom()} | self
 %%       Type = {Strategy, MaxIntensity, Period}
 %%         Strategy = one_for_one | one_for_all | simple_one_for_one |
-%%                    rest_for_one 
-%%         MaxIntensity = integer()
-%%         Period = integer()
+%%                    rest_for_one
+%%         MaxIntensity = integer() >= 0
+%%         Period = integer() > 0
 %%       Mod :== atom()
 %%       Args :== term()
 %% Purpose: Check that Type is of correct type (!)
@@ -1201,7 +1200,7 @@ supname(N, _)      -> N.
 %%% where Name is an atom
 %%%       Func is {Mod, Fun, Args} == {atom(), atom(), list()}
 %%%       RestartType is permanent | temporary | transient
-%%%       Shutdown = integer() | infinity | brutal_kill
+%%%       Shutdown = integer() > 0 | infinity | brutal_kill
 %%%       ChildType = supervisor | worker
 %%%       Modules = [atom()] | dynamic
 %%% Returns: {ok, [child_rec()]} | Error
diff --git a/system/doc/design_principles/sup_princ.xml b/system/doc/design_principles/sup_princ.xml
index c473e257fa..353430752c 100644
--- a/system/doc/design_principles/sup_princ.xml
+++ b/system/doc/design_principles/sup_princ.xml
@@ -136,7 +136,7 @@ init(...) ->
         M = F = atom()
         A = [term()]
     Restart = permanent | transient | temporary
-    Shutdown = brutal_kill | integer()>=0 | infinity
+    Shutdown = brutal_kill | integer()>0 | infinity
     Type = worker | supervisor
     Modules = [Module] | dynamic
         Module = atom()]]></code>