Commit 16492e68 authored by Justin Erenkrantz's avatar Justin Erenkrantz
Browse files

Update doc for the SIGUSR1 change - we no longer use SIGWINCH except on 

Linux 2.0/glibc 2.0 which doesn't allow SIGUSR1 to be used by programs.

Feel free to change the wording.  I don't care.


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

docs/man/apachectl.8

+4 −1
Original line number Diff line number Diff line
@@ -109,7 +109,7 @@ Displays a brief status report. Similar to the fullstatus option, 
except that the list of requests currently being served is omitted.

.TP

.BI graceful

Gracefully restarts the Apache daemon by sending it a SIGWINCH.  If

Gracefully restarts the Apache daemon by sending it a SIGUSR1.  If

the daemon is not running, it is started.  This differs from a

normal restart in that currently open connections are not aborted.

A side effect is that old log files will not be closed immediately.
@@ -118,6 +118,9 @@ necessary to ensure that the old log files are closed before processing them. 
This command automatically checks the configuration files via 

.BI configtest

before initiating the restart to make sure Apache doesn't die.

On certain platforms that do not allow SIGUSR1 to be used for a graceful

restart, an alternative signal may be used (such as SIGWINCH).  graceful 

will send the right signal for your platform.

.TP

.BI configtest

Run a configuration file syntax test. It parses the configuration

docs/manual/programs/apachectl.html

+7 −2
Original line number Diff line number Diff line
@@ -57,7 +57,7 @@ vlink="#000080" alink="#ff0000"> 
                 requests currently being served is omitted.



     <strong>graceful    </strong>Gracefully restarts the Apache daemon by sending

                 it a SIGWINCH.  If the daemon is not running, it

                 it a SIGUSR1.  If the daemon is not running,  it

                 is started.  This differs from a normal  restart

                 in  that  currently  open  connections  are  not

                 aborted.  A side effect is that  old  log  files
@@ -67,7 +67,12 @@ vlink="#000080" alink="#ff0000"> 
                 log files are  closed  before  processing  them.

                 This command automatically checks the configura-

                 tion files via <strong>configtest </strong>before initiating  the

                 restart to make sure Apache doesn't die.

                 restart to make sure  Apache  doesn't  die.   <i>On 

                 certain  platforms that  do not allow USR1 to be 

                 used  for  a  graceful  restart,  an alternative 

                 signal may be used  (such as WINCH).   apachectl 

                 graceful will send  the right  signal  for  your 

                 platform.</i>



     <strong>configtest  </strong>Run a configuration file syntax test. It  parses

                 the  configuration files and either reports <strong>Syn-</strong>

docs/manual/stopping.html

+8 −4
Original line number Diff line number Diff line
@@ -62,16 +62,20 @@ further requests are served. 


<H3>Graceful Restart</H3>



<p><strong>Signal:</strong> WINCH<br>

<p><strong>Signal:</strong> USR1<br>

<code>apachectl graceful</code></p>



<P>The <CODE>WINCH</CODE> signal causes the parent process to <EM>advise</EM>

<P>The <CODE>USR1</CODE> signal causes the parent process to <EM>advise</EM>

the children to exit after their current request (or to exit immediately

if they're not serving anything).  The parent re-reads its configuration

files and re-opens its log files.  As each child dies off the parent

replaces it with a child from the new <EM>generation</EM> of the

configuration, which begins serving new requests immediately.</p>



<I>On certain platforms that do not allow USR1 to be used for a graceful

restart, an alternative signal may be used (such as WINCH).  apachectl

graceful will send the right signal for your platform.</I>



<P>This code is designed to always respect the <A

HREF="mod/mpm_common.html#maxclients">MaxClients</A>, <A

HREF="mod/prefork.html#minspareservers">MinSpareServers</A>, and <A
@@ -100,9 +104,9 @@ children which are still serving requests started before the graceful 
restart was given.



<P>At present there is no way for a log rotation script using

<CODE>WINCH</CODE> to know for certain that all children writing the

<CODE>USR1</CODE> to know for certain that all children writing the

pre-restart log have finished.  We suggest that you use a suitable delay

after sending the <CODE>WINCH</CODE> signal before you do anything with the

after sending the <CODE>USR1</CODE> signal before you do anything with the

old log.  For example if most of your hits take less than 10 minutes to

complete for users on low bandwidth links then you could wait 15 minutes

before doing anything with the old log.

docs/manual/stopping.html.en

+8 −4
Original line number Diff line number Diff line
@@ -62,16 +62,20 @@ further requests are served. 


<H3>Graceful Restart</H3>



<p><strong>Signal:</strong> WINCH<br>

<p><strong>Signal:</strong> USR1<br>

<code>apachectl graceful</code></p>



<P>The <CODE>WINCH</CODE> signal causes the parent process to <EM>advise</EM>

<P>The <CODE>USR1</CODE> signal causes the parent process to <EM>advise</EM>

the children to exit after their current request (or to exit immediately

if they're not serving anything).  The parent re-reads its configuration

files and re-opens its log files.  As each child dies off the parent

replaces it with a child from the new <EM>generation</EM> of the

configuration, which begins serving new requests immediately.</p>



<I>On certain platforms that do not allow USR1 to be used for a graceful

restart, an alternative signal may be used (such as WINCH).  apachectl

graceful will send the right signal for your platform.</I>



<P>This code is designed to always respect the <A

HREF="mod/mpm_common.html#maxclients">MaxClients</A>, <A

HREF="mod/prefork.html#minspareservers">MinSpareServers</A>, and <A
@@ -100,9 +104,9 @@ children which are still serving requests started before the graceful 
restart was given.



<P>At present there is no way for a log rotation script using

<CODE>WINCH</CODE> to know for certain that all children writing the

<CODE>USR1</CODE> to know for certain that all children writing the

pre-restart log have finished.  We suggest that you use a suitable delay

after sending the <CODE>WINCH</CODE> signal before you do anything with the

after sending the <CODE>USR1</CODE> signal before you do anything with the

old log.  For example if most of your hits take less than 10 minutes to

complete for users on low bandwidth links then you could wait 15 minutes

before doing anything with the old log.

docs/manual/upgrading.html.en

+0 −4
Original line number Diff line number Diff line
@@ -100,10 +100,6 @@ eliminating the need for these directives.</li> 


<UL>



<li>Graceful restarts of the server are now executed by signaling the

parent process with <code>WINCH</code> rather than

<code>USR1</code>.</li>



<li>The <code>httpd</code> command line option <code>-S</code>

which was used for printing the virtual host configuration has

been replaced by <code>-t -D DUMP_VHOSTS</code>.</li>