add initial documentation for EnableExceptionHook. Please review.

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

diff --git a/docs/manual/mod/leader.xml b/docs/manual/mod/leader.xml
index baa01958392a453e53c0ca3d597fbc5dff8c4a8f..ac7ed17557820a73a956bbe3541030c6028345f5 100644 (file)
--- a/docs/manual/mod/leader.xml
+++ b/docs/manual/mod/leader.xml
@@ -55,6 +55,8 @@ MPM</description>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>CoreDumpDirectory</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>EnableExceptionHook</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Group</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Listen</name>

diff --git a/docs/manual/mod/mpm_common.xml b/docs/manual/mod/mpm_common.xml
index 634c415acc7120931568e5faff29ce324c2a6701..b8091ee3a63a3234034a98330b0bf2e1b3eb9606 100644 (file)
--- a/docs/manual/mod/mpm_common.xml
+++ b/docs/manual/mod/mpm_common.xml
@@ -128,6 +128,31 @@ switch before dumping core</description>
 </usage>
 </directivesynopsis>
 
+<directivesynopsis>
+<name>EnableExceptionHook</name>
+<description>Enable the fatal exception handler after a crash</description>
+<syntax>EnableExceptionHook On|Off</syntax>
+<default>EnableExceptionHook Off</default>
+<contextlist><context>server config</context></contextlist>
+<modulelist><module>leader</module><module>perchild</module>
+<module>prefork</module><module>threadpool</module>
+<module>worker</module></modulelist>
+<compatibility>Available in version 2.0.49 an later</compatibility>
+
+<usage>
+    <p>For safety reasons this directive is only available if the server was
+    configured with the <code>--enable-exception-hook</code> option. It
+    enables a hook that allows external modules to plug in and do something
+    after a child crashed.</p>
+    
+    <p>There are already two modules, <code>mod_whatkilledus</code> and
+    <code>mod_backtrace</code> that make use of this hook. Please have a
+    look at Jeff Trawick's <a
+    href="http://www.apache.org/~trawick/exception_hook.html"
+    >EnableExceptionHook site</a> for more information about these.</p>
+</usage>
+</directivesynopsis>
+
 <directivesynopsis>
 <name>Group</name>
 <description>Group under which the server will answer

diff --git a/docs/manual/mod/perchild.xml b/docs/manual/mod/perchild.xml
index 7efbf614b227efdee783b6557c807e536ac3baf8..aa30c2b77c75f468efba1e49b887cba38b764968 100644 (file)
--- a/docs/manual/mod/perchild.xml
+++ b/docs/manual/mod/perchild.xml
@@ -144,6 +144,8 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>CoreDumpDirectory</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>EnableExceptionHook</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Group</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>PidFile</name>

diff --git a/docs/manual/mod/prefork.xml b/docs/manual/mod/prefork.xml
index f65b3ce8ac9ac9019e2ec96104df89498ad57d1d..744b758f10cddc6d85fe3c9c5ab0b0ee348a1d4b 100644 (file)
--- a/docs/manual/mod/prefork.xml
+++ b/docs/manual/mod/prefork.xml
@@ -85,6 +85,8 @@ uses</a></seealso>
 
 <directivesynopsis location="mpm_common"><name>CoreDumpDirectory</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>EnableExceptionHook</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>PidFile</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Listen</name>

diff --git a/docs/manual/mod/threadpool.xml b/docs/manual/mod/threadpool.xml
index 7fcf070bfad9cec24d46f30345fb698ca9c21f0e..6c22abcc0e9a572f76c313e653ba9cff6d08e97e 100644 (file)
--- a/docs/manual/mod/threadpool.xml
+++ b/docs/manual/mod/threadpool.xml
@@ -50,6 +50,8 @@
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>CoreDumpDirectory</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>EnableExceptionHook</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Group</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Listen</name>

diff --git a/docs/manual/mod/worker.xml b/docs/manual/mod/worker.xml
index 58360f2a7c2f86a0d0781dd7cdf50bceefc48a91..28deb4a35356b12237cba29e4517a46c0c023ff8 100644 (file)
--- a/docs/manual/mod/worker.xml
+++ b/docs/manual/mod/worker.xml
@@ -141,6 +141,8 @@ uses</a></seealso>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>CoreDumpDirectory</name>
 </directivesynopsis>
+<directivesynopsis location="mpm_common"><name>EnableExceptionHook</name>
+</directivesynopsis>
 <directivesynopsis location="mpm_common"><name>Group</name>
 </directivesynopsis>
 <directivesynopsis location="mpm_common"><name>PidFile</name>