Rename MaxClients to MaxRequestWorkers which describes more accurately what

it does.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1137744 13f79535-47bb-0310-9956-ffa450edef68

8 files changed, 51 insertions, 39 deletions

diff --git a/docs/conf/extra/httpd-mpm.conf.in b/docs/conf/extra/httpd-mpm.conf.in
index d4679592bd..3bd919a275 100644
--- a/docs/conf/extra/httpd-mpm.conf.in
+++ b/docs/conf/extra/httpd-mpm.conf.in
@@ -30,48 +30,48 @@
 # StartServers: number of server processes to start
 # MinSpareServers: minimum number of server processes which are kept spare
 # MaxSpareServers: maximum number of server processes which are kept spare
-# MaxClients: maximum number of server processes allowed to start
+# MaxRequestWorkers: maximum number of server processes allowed to start
 # MaxConnectionsPerChild: maximum number of connections a server process serves
 #                         before terminating
 <IfModule mpm_prefork_module>
     StartServers             5
     MinSpareServers          5
     MaxSpareServers         10
-    MaxClients             150
+    MaxRequestWorkers      150
     MaxConnectionsPerChild   0
 </IfModule>
 
 # worker MPM
 # StartServers: initial number of server processes to start
-# MaxClients: maximum number of simultaneous client connections
 # MinSpareThreads: minimum number of worker threads which are kept spare
 # MaxSpareThreads: maximum number of worker threads which are kept spare
 # ThreadsPerChild: constant number of worker threads in each server process
+# MaxRequestWorkers: maximum number of worker threads
 # MaxConnectionsPerChild: maximum number of connections a server process serves
 #                         before terminating
 <IfModule mpm_worker_module>
     StartServers             2
-    MaxClients             150
     MinSpareThreads         25
     MaxSpareThreads         75 
     ThreadsPerChild         25
+    MaxRequestWorkers      150
     MaxConnectionsPerChild   0
 </IfModule>
 
 # event MPM
 # StartServers: initial number of server processes to start
-# MaxClients: maximum number of simultaneous client connections
 # MinSpareThreads: minimum number of worker threads which are kept spare
 # MaxSpareThreads: maximum number of worker threads which are kept spare
 # ThreadsPerChild: constant number of worker threads in each server process
+# MaxRequestWorkers: maximum number of worker threads
 # MaxConnectionsPerChild: maximum number of connections a server process serves
 #                         before terminating
 <IfModule mpm_event_module>
     StartServers             2
-    MaxClients             150
     MinSpareThreads         25
     MaxSpareThreads         75
     ThreadsPerChild         25
+    MaxRequestWorkers      150
     MaxConnectionsPerChild   0
 </IfModule>
 
diff --git a/docs/manual/misc/perf-tuning.xml b/docs/manual/misc/perf-tuning.xml
index 64f9582f4c..32aebeeec8 100644
--- a/docs/manual/misc/perf-tuning.xml
+++ b/docs/manual/misc/perf-tuning.xml
@@ -56,7 +56,7 @@
     that users consider "fast enough". This causes users to hit
     stop and reload, further increasing the load. You can, and
     should, control the <directive module="mpm_common"
-    >MaxClients</directive> setting so that your server
+    >MaxRequestWorkers</directive> setting so that your server
     does not spawn so many children it starts swapping. This procedure
     for doing this is simple: determine the size of your average Apache
     process, by looking at your process list via a tool such as
diff --git a/docs/manual/misc/security_tips.xml b/docs/manual/misc/security_tips.xml
index d98882ff95..9424e57b19 100644
--- a/docs/manual/misc/security_tips.xml
+++ b/docs/manual/misc/security_tips.xml
@@ -105,7 +105,7 @@
       require reconfiguration of your kernel.</li>
 
       <li>Tune the <directive
-      module="mpm_common">MaxClients</directive> directive to allow
+      module="mpm_common">MaxRequestWorkers</directive> directive to allow
       the server to handle the maximum number of simultaneous
       connections without running out of resources.  See also the <a
       href="perf-tuning.html">performance tuning
diff --git a/docs/manual/mod/event.xml b/docs/manual/mod/event.xml
index cab1adf516..9d1a844e64 100644
--- a/docs/manual/mod/event.xml
+++ b/docs/manual/mod/event.xml
@@ -106,7 +106,7 @@ of consuming threads only for connections with active processing</description>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>SendBufferSize</name>
 </directivesynopsis>
-<directivesynopsis location="mpm_common"><name>MaxClients</name>
+<directivesynopsis location="mpm_common"><name>MaxRequestWorkers</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>MaxMemFree</name>
 </directivesynopsis>
diff --git a/docs/manual/mod/mpm_common.xml b/docs/manual/mod/mpm_common.xml
index 9e8b5229bc..2d94317482 100644
--- a/docs/manual/mod/mpm_common.xml
+++ b/docs/manual/mod/mpm_common.xml
@@ -280,10 +280,10 @@ including other causes.</a></seealso>
 </directivesynopsis>
 
 <directivesynopsis>
-<name>MaxClients</name>
+<name>MaxRequestWorkers</name>
 <description>Maximum number of connections that will be processed
 simultaneously</description>
-<syntax>MaxClients <var>number</var></syntax>
+<syntax>MaxRequestWorkers <var>number</var></syntax>
 <default>See usage for details</default>
 <contextlist><context>server config</context></contextlist>
 <modulelist><module>event</module><module>prefork</module>
@@ -291,30 +291,34 @@ simultaneously</description>
 </modulelist>
 
 <usage>
-    <p>The <directive>MaxClients</directive> directive sets the limit
+    <p>The <directive>MaxRequestWorkers</directive> directive sets the limit
     on the number of simultaneous requests that will be served.  Any
-    connection attempts over the <directive>MaxClients</directive>
+    connection attempts over the <directive>MaxRequestWorkers</directive>
     limit will normally be queued, up to a number based on the
     <directive module="mpm_common">ListenBacklog</directive>
     directive. Once a child process is freed at the end of a different
     request, the connection will then be serviced.</p>
 
     <p>For non-threaded servers (<em>i.e.</em>, <module>prefork</module>),
-    <directive>MaxClients</directive> translates into the maximum
+    <directive>MaxRequestWorkers</directive> translates into the maximum
     number of child processes that will be launched to serve requests.
     The default value is <code>256</code>; to increase it, you must also raise
     <directive module="mpm_common">ServerLimit</directive>.</p>
 
     <p>For threaded and hybrid servers (<em>e.g.</em> <module>event</module>
-    or <module>worker</module>) <directive>MaxClients</directive> restricts
+    or <module>worker</module>) <directive>MaxRequestWorkers</directive> restricts
     the total number of threads that will be available to serve clients.
     For hybrid MPMs the default value is <code>16</code> (<directive
     module="mpm_common">ServerLimit</directive>) multiplied by the value of
     <code>25</code> (<directive module="mpm_common"
     >ThreadsPerChild</directive>). Therefore, to increase <directive
-    >MaxClients</directive> to a value that requires more than 16 processes,
+    >MaxRequestWorkers</directive> to a value that requires more than 16 processes,
     you must also raise <directive module="mpm_common"
     >ServerLimit</directive>.</p>
+
+    <p><directive>MaxRequestWorkers</directive> was called
+    <directive>MaxClients</directive> before version 2.3.13. The old name ist still
+    supported.</p>
 </usage>
 </directivesynopsis>
 
@@ -540,39 +544,39 @@ Apache HTTP Server</a></seealso>
 <usage>
     <p>For the <module>prefork</module> MPM, this directive sets the
     maximum configured value for <directive
-    module="mpm_common">MaxClients</directive> for the lifetime of the
+    module="mpm_common">MaxRequestWorkers</directive> for the lifetime of the
     Apache httpd process.  For the <module>worker</module> MPM, this directive
     in combination with <directive
     module="mpm_common">ThreadLimit</directive> sets
     the maximum configured value for <directive
-    module="mpm_common">MaxClients</directive> for the lifetime of the
+    module="mpm_common">MaxRequestWorkers</directive> for the lifetime of the
     Apache httpd process.  Any attempts to change this directive during a
     restart will be ignored, but <directive
-    module="mpm_common">MaxClients</directive> can be modified during
+    module="mpm_common">MaxRequestWorkers</directive> can be modified during
     a restart.</p>
 
     <p>Special care must be taken when using this directive.  If
     <directive>ServerLimit</directive> is set to a value much higher
     than necessary, extra, unused shared memory will be allocated.  If
     both <directive>ServerLimit</directive> and <directive
-    module="mpm_common">MaxClients</directive> are set to values
+    module="mpm_common">MaxRequestWorkers</directive> are set to values
     higher than the system can handle, Apache httpd may not start or the
     system may become unstable.</p>
 
     <p>With the <module>prefork</module> MPM, use this directive only
     if you need to set <directive
-    module="mpm_common">MaxClients</directive> higher than 256 (default).
+    module="mpm_common">MaxRequestWorkers</directive> higher than 256 (default).
     Do not set the value of this directive any higher than what you
     might want to set <directive
-    module="mpm_common">MaxClients</directive> to.</p>
+    module="mpm_common">MaxRequestWorkers</directive> to.</p>
 
     <p>With <module>worker</module>, use this directive only
-    if your <directive module="mpm_common">MaxClients</directive> and
+    if your <directive module="mpm_common">MaxRequestWorkers</directive> and
     <directive module="mpm_common">ThreadsPerChild</directive>
     settings require more than 16 server processes (default). Do not set
     the value of this directive any higher than the number of server
     processes required by what you may want for <directive
-    module="mpm_common">MaxClients </directive> and <directive
+    module="mpm_common">MaxRequestWorkers </directive> and <directive
     module="mpm_common">ThreadsPerChild</directive>.</p>
 
     <note><title>Note</title>
diff --git a/docs/manual/mod/prefork.xml b/docs/manual/mod/prefork.xml
index 2d7068a19f..715b581a2c 100644
--- a/docs/manual/mod/prefork.xml
+++ b/docs/manual/mod/prefork.xml
@@ -39,8 +39,8 @@
 
     <p>This MPM is very self-regulating, so it is rarely necessary to
     adjust its configuration directives.  Most important is that
-    <directive module="mpm_common">MaxClients</directive> be big enough to 
-    handle as many simultaneous requests as you expect to receive, but
+    <directive module="mpm_common">MaxRequestWorkers</directive> be big enough
+    to handle as many simultaneous requests as you expect to receive, but
     small enough to assure that there is enough physical RAM for all
     processes.</p>
 </summary>
@@ -59,14 +59,14 @@ uses</a></seealso>
     <p>The <directive module="mpm_common">StartServers</directive>,
     <directive module="prefork">MinSpareServers</directive>,
     <directive module="prefork">MaxSpareServers</directive>, and
-    <directive module="mpm_common">MaxClients</directive> regulate how
+    <directive module="mpm_common">MaxRequestWorkers</directive> regulate how
     the parent process creates children to serve requests. In general,
     Apache httpd is very self-regulating, so most sites do not need to
     adjust these directives from their default values. Sites which
     need to serve more than 256 simultaneous requests may need to
-    increase <directive module="mpm_common">MaxClients</directive>,
+    increase <directive module="mpm_common">MaxRequestWorkers</directive>,
     while sites with limited memory may need to decrease <directive
-    module="mpm_common">MaxClients</directive> to keep the server from
+    module="mpm_common">MaxRequestWorkers</directive> to keep the server from
     thrashing (swapping memory to disk and back). More information
     about tuning process creation is provided in the <a
     href="../misc/perf-tuning.html">performance hints</a>
@@ -104,7 +104,7 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ListenBacklog</name>
 </directivesynopsis>
-<directivesynopsis location="mpm_common"><name>MaxClients</name>
+<directivesynopsis location="mpm_common"><name>MaxRequestWorkers</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>MaxMemFree</name>
 </directivesynopsis>
diff --git a/docs/manual/mod/worker.xml b/docs/manual/mod/worker.xml
index 0e8ae16506..bd0baf1a69 100644
--- a/docs/manual/mod/worker.xml
+++ b/docs/manual/mod/worker.xml
@@ -39,7 +39,7 @@
     <p>The most important directives used to control this MPM are
     <directive module="mpm_common">ThreadsPerChild</directive>, which
     controls the number of threads deployed by each child process and
-    <directive module="mpm_common">MaxClients</directive>, which
+    <directive module="mpm_common">MaxRequestWorkers</directive>, which
     controls the maximum total number of threads that may be
     launched.</p>
 </summary>
@@ -68,9 +68,9 @@
     these directives from their default values. The maximum number of
     clients that may be served simultaneously (i.e., the maximum total
     number of threads in all processes) is determined by the
-    <directive module="mpm_common">MaxClients</directive> directive.
+    <directive module="mpm_common">MaxRequestWorkers</directive> directive.
     The maximum number of active child processes is determined by
-    the <directive module="mpm_common">MaxClients</directive>
+    the <directive module="mpm_common">MaxRequestWorkers</directive>
     directive divided by the <directive module="mpm_common">
     ThreadsPerChild</directive> directive.</p>
 
@@ -80,7 +80,7 @@
     starting it again.  <directive module="mpm_common">ServerLimit
     </directive> is a hard limit on the number of active child 
     processes, and must be greater than or equal to the 
-    <directive module="mpm_common">MaxClients</directive>
+    <directive module="mpm_common">MaxRequestWorkers</directive>
     directive divided by the <directive module="mpm_common">
     ThreadsPerChild</directive> directive.  
     <directive module="mpm_common">ThreadLimit</directive> is a hard
@@ -92,7 +92,7 @@
     be additional child processes which are terminating, but where at
     least one server thread is still handling an existing client
     connection.  Up to <directive 
-    module="mpm_common">MaxClients</directive> terminating processes 
+    module="mpm_common">MaxRequestWorkers</directive> terminating processes 
     may be present, though the actual number can be expected to be 
     much smaller.  This behavior can be avoided by disabling the 
     termination of individual child processes, which is achieved using
@@ -104,7 +104,7 @@
 
       <li>set the value of <directive module="mpm_common">
       MaxSpareThreads</directive> to the same value as
-      <directive module="mpm_common">MaxClients</directive></li>
+      <directive module="mpm_common">MaxRequestWorkers</directive></li>
     </ul>
 
     <p>A typical configuration of the process-thread controls in
@@ -113,7 +113,7 @@
     <example>
       ServerLimit         16<br />
       StartServers         2<br />
-      MaxClients         150<br />
+      MaxRequestWorkers         150<br />
       MinSpareThreads     25<br />
       MaxSpareThreads     75<br />
       ThreadsPerChild     25
@@ -156,7 +156,7 @@
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>ListenBacklog</name>
 </directivesynopsis>
-<directivesynopsis location="mpm_common"><name>MaxClients</name>
+<directivesynopsis location="mpm_common"><name>MaxRequestWorkers</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>MaxMemFree</name>
 </directivesynopsis>
diff --git a/docs/manual/upgrading.xml b/docs/manual/upgrading.xml
index 77accafbac..56ab731a00 100644
--- a/docs/manual/upgrading.xml
+++ b/docs/manual/upgrading.xml
@@ -168,7 +168,15 @@
       <ul>
         <li><directive>MaxRequestsPerChild</directive> has been renamed to
         <directive module="mpm_common">MaxConnectionsPerChild</directive>,
-        which describes more accurately what it does.</li>
+        describes more accurately what it does. The old name is still
+        supported.</li>
+
+        <li><directive>MaxClients</directive> has been renamed to
+        <directive module="mpm_common">MaxRequestWorkers</directive>,
+        which describes more accurately what it does. For async MPMs, like
+        <module>event</module>, the maximum number of clients is not
+        equivalent than the number of worker threads. The old name is still
+        supported.</li>
 
         <li>The <directive module="core">DefaultType</directive>
         directive no longer has any effect, other than to emit a