From 005fd391b1a212b09f45ee9900441014ec19c1a4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ricardo=20Catalinas=20Jim=C3=A9nez?= <jimenezrick@gmail.com>
Date: Fri, 24 Feb 2012 14:47:41 +0100
Subject: Fix supervisor doc: Shutdown, MaxR and MaxT type specs

The next code snippets from supervisor.erl show that Shutdown from a
child specification must be greater than zero and the same applies to
MaxT.

--- supervisor.erl ----------------------------------------------------------
validShutdown(Shutdown, _)
  when is_integer(Shutdown), Shutdown > 0 -> true;
validShutdown(infinity, _)             -> true;
validShutdown(brutal_kill, _)          -> true;
validShutdown(Shutdown, _)             -> throw({invalid_shutdown, Shutdown}).

validIntensity(Max) when is_integer(Max),
                         Max >=  0 -> true;
validIntensity(What)               -> throw({invalid_intensity, What}).

validPeriod(Period) when is_integer(Period),
                         Period > 0 -> true;
validPeriod(What)                   -> throw({invalid_period, What}).
-----------------------------------------------------------------------------
---
 lib/stdlib/doc/src/supervisor.xml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'lib/stdlib/doc')

diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml
index 33a7f5bb6a..ab360fbb6f 100644
--- a/lib/stdlib/doc/src/supervisor.xml
+++ b/lib/stdlib/doc/src/supervisor.xml
@@ -114,7 +114,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>
@@ -517,7 +517,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>
-- 
cgit v1.2.3


From b5b00bef5d654006b15c44abbfe5aae3de9d3572 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ricardo=20Catalinas=20Jim=C3=A9nez?= <jimenezrick@gmail.com>
Date: Fri, 24 Feb 2012 15:03:21 +0100
Subject: Cosmetic: split very long lines from supervisor doc

---
 lib/stdlib/doc/src/supervisor.xml | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

(limited to 'lib/stdlib/doc')

diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml
index ab360fbb6f..ff06b04d07 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.
@@ -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
@@ -434,7 +437,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
@@ -467,7 +471,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
-- 
cgit v1.2.3