httpd-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Noirin Plunkett <fireb...@nerdchic.net>
Subject PATCH: Language changes & fixes
Date Mon, 22 Aug 2005 19:31:05 GMT

Hi there,

I've been going through the Apache trunk docs, and have some language changes and fixes to
suggest.

The following is the patch:


Index: manual/stopping.xml
===================================================================
--- manual/stopping.xml	(revision 239220)
+++ manual/stopping.xml	(working copy)
@@ -119,9 +119,10 @@
     been created, then create enough to pick up the slack. Hence the
     code tries to maintain both the number of children appropriate for
     the current load on the server, and respect your wishes with the
-    <directive>StartServers</directive> parameter.</p>
+    <directive module="mpm_common">StartServers</directive> 
+    parameter.</p>
 
-    <p>Users of the <module>mod_status</module>
+    <p>Users of <module>mod_status</module>
     will notice that the server statistics are <strong>not</strong>
     set to zero when a <code>USR1</code> is sent. The code was
     written to both minimize the time in which the server is unable
@@ -188,26 +189,27 @@
 <section id="race"><title>Appendix: signals and race conditions</title>
 
     <p>Prior to Apache 1.2b9 there were several <em>race
-    conditions</em> involving the restart and die signals (a simple
-    description of race condition is: a time-sensitive problem, as
-    in if something happens at just the wrong time it won't behave
-    as expected). For those architectures that have the "right"
+    conditions</em> involving the restart and die signals (a simply put, 
+    a race condition is a time-sensitive problem - if something happens 
+    at just the wrong time or things happen in the wrong order, 
+    undesired behaviour will result. If the same thing happens at the right 
+    time, all will be well). For those architectures that have the "right"
     feature set we have eliminated as many as we can. But it should
-    be noted that there still do exist race conditions on certain
+    be noted that race conditions do still exist on certain
     architectures.</p>
 
-    <p>Architectures that use an on disk <directive
-    module="mpm_common">ScoreBoardFile</directive> have the potential
-    to corrupt their scoreboards. This can result in the "bind:
+    <p>Architectures that use an on-disk <directive
+    module="mpm_common">ScoreBoardFile</directive> can potentially have 
+    their scoreboards corrupted. This can result in the "bind:
     Address already in use" (after <code>HUP</code>) or "long lost
     child came home!" (after <code>USR1</code>). The former is a fatal
     error, while the latter just causes the server to lose a
-    scoreboard slot. So it might be advisable to use graceful
+    scoreboard slot. So it may be advisable to use graceful
     restarts, with an occasional hard restart. These problems are very
     difficult to work around, but fortunately most architectures do
     not require a scoreboard file. See the <directive
-    module="mpm_common">ScoreBoardFile</directive> documentation for a
-    architecture uses it.</p>
+    module="mpm_common">ScoreBoardFile</directive> documentation for
+    architecture which uses it.</p>
 
     <p>All architectures have a small race condition in each child
     involving the second and subsequent requests on a persistent
Index: manual/install.html.en
===================================================================
--- manual/install.html.en	(revision 239220)
+++ manual/install.html.en	(working copy)
@@ -155,14 +155,15 @@
       [OPTIONAL]</dt>
       <dd>For some of the support scripts like <code class="program"><a href="./programs/apxs.html">apxs</a></code>
or <code class="program"><a href="./programs/dbmmanage.html">dbmmanage</a></code>
(which are
       written in Perl) the Perl 5 interpreter is required (versions
-      5.003 or newer are sufficient). If no such interpreter is found by
-      the <code class="program"><a href="./programs/configure.html">configure</a></code>
script there is no harm. Of course, you
-      still can build and install Apache 2.0. Only those support scripts
-      cannot be used. If you have multiple Perl interpreters
-      installed (perhaps a Perl 4 from the vendor and a Perl 5 from
-      your own), then it is recommended to use the <code>--with-perl</code>
-      option (see below) to make sure the correct one is selected
-      by <code class="program"><a href="./programs/configure.html">configure</a></code>.</dd>
+      5.003 or newer are sufficient). If you have multiple Perl 
+      interpreters (for example, a systemwide install of Perl 4, and 
+      your own install of Perl 5), you are advised to use the 
+      <code>--with-perl</code> option (see below) to make sure the 
+      correct one is used by <code class="program"><a href="./programs/configure.html">configure</a></code>.
+      If no Perl 5 interpreter is found by the 
+      <code class="program"><a href="./programs/configure.html">configure</a></code>
script, you will not be able to use 
+      the affected support scripts. Of course, you will still be able to 
+      build and use Apache 2.0.</dd>
     </dl>
 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif"
/></a></div>
 <div class="section">
Index: manual/install.xml
===================================================================
--- manual/install.xml	(revision 239220)
+++ manual/install.xml	(working copy)
@@ -152,14 +152,15 @@
       <dd>For some of the support scripts like <program>
       apxs</program> or <program>dbmmanage</program> (which are
       written in Perl) the Perl 5 interpreter is required (versions
-      5.003 or newer are sufficient). If no such interpreter is found by
-      the <program>configure</program> script there is no harm. Of course, you
-      still can build and install Apache 2.0. Only those support scripts
-      cannot be used. If you have multiple Perl interpreters
-      installed (perhaps a Perl 4 from the vendor and a Perl 5 from
-      your own), then it is recommended to use the <code>--with-perl</code>
-      option (see below) to make sure the correct one is selected
-      by <program>configure</program>.</dd>
+      5.003 or newer are sufficient). If you have multiple Perl 
+      interpreters (for example, a systemwide install of Perl 4, and 
+      your own install of Perl 5), you are advised to use the 
+      <code>--with-perl</code> option (see below) to make sure the 
+      correct one is used by <program>configure</program>.
+      If no Perl 5 interpreter is found by the 
+      <program>configure</program> script, you will not be able to use 
+      the affected support scripts. Of course, you will still be able to 
+      build and use Apache 2.0.</dd>
     </dl>
 </section>
 
Index: manual/stopping.html.en
===================================================================
--- manual/stopping.html.en	(revision 239220)
+++ manual/stopping.html.en	(working copy)
@@ -117,9 +117,10 @@
     been created, then create enough to pick up the slack. Hence the
     code tries to maintain both the number of children appropriate for
     the current load on the server, and respect your wishes with the
-    <code class="directive">StartServers</code> parameter.</p>
+    <code class="directive"><a href="./mod/mpm_common.html#startservers">StartServers</a></code>

+    parameter.</p>
 
-    <p>Users of the <code class="module"><a href="./mod/mod_status.html">mod_status</a></code>
+    <p>Users of <code class="module"><a href="./mod/mod_status.html">mod_status</a></code>
     will notice that the server statistics are <strong>not</strong>
     set to zero when a <code>USR1</code> is sent. The code was
     written to both minimize the time in which the server is unable
@@ -186,24 +187,25 @@
 <h2><a name="race" id="race">Appendix: signals and race conditions</a></h2>
 
     <p>Prior to Apache 1.2b9 there were several <em>race
-    conditions</em> involving the restart and die signals (a simple
-    description of race condition is: a time-sensitive problem, as
-    in if something happens at just the wrong time it won't behave
-    as expected). For those architectures that have the "right"
+    conditions</em> involving the restart and die signals (a simply put, 
+    a race condition is a time-sensitive problem - if something happens 
+    at just the wrong time or things happen in the wrong order, 
+    undesired behaviour will result. If the same thing happens at the right 
+    time, all will be well). For those architectures that have the "right"
     feature set we have eliminated as many as we can. But it should
-    be noted that there still do exist race conditions on certain
+    be noted that race conditions do still exist on certain
     architectures.</p>
 
-    <p>Architectures that use an on disk <code class="directive"><a href="./mod/mpm_common.html#scoreboardfile">ScoreBoardFile</a></code>
have the potential
-    to corrupt their scoreboards. This can result in the "bind:
+    <p>Architectures that use an on-disk <code class="directive"><a href="./mod/mpm_common.html#scoreboardfile">ScoreBoardFile</a></code>
can potentially have 
+    their scoreboards corrupted. This can result in the "bind:
     Address already in use" (after <code>HUP</code>) or "long lost
     child came home!" (after <code>USR1</code>). The former is a fatal
     error, while the latter just causes the server to lose a
-    scoreboard slot. So it might be advisable to use graceful
+    scoreboard slot. So it may be advisable to use graceful
     restarts, with an occasional hard restart. These problems are very
     difficult to work around, but fortunately most architectures do
-    not require a scoreboard file. See the <code class="directive"><a href="./mod/mpm_common.html#scoreboardfile">ScoreBoardFile</a></code>
documentation for a
-    architecture uses it.</p>
+    not require a scoreboard file. See the <code class="directive"><a href="./mod/mpm_common.html#scoreboardfile">ScoreBoardFile</a></code>
documentation for
+    architecture which uses it.</p>
 
     <p>All architectures have a small race condition in each child
     involving the second and subsequent requests on a persistent


Thanks,
Noirin

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org


Mime
View raw message