]> granicus.if.org Git - apache/commitdiff
core.xml: document Warning directive
authorJan Kaluža <jkaluza@apache.org>
Wed, 16 Apr 2014 11:51:42 +0000 (11:51 +0000)
committerJan Kaluža <jkaluza@apache.org>
Wed, 16 Apr 2014 11:51:42 +0000 (11:51 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1587881 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/mod/core.xml

index 29a37cec3be42435e5649fd0b846d54a09765c7b..0cf24bf3d7d50415d69aaed9f45fa21f5538db14 100644 (file)
@@ -1174,6 +1174,7 @@ version 2.3.9.</compatibility>
     </highlight>
 
 </usage>
+<seealso><directive module="core">Warning</directive></seealso>
 </directivesynopsis>
 
 <directivesynopsis>
@@ -4431,4 +4432,29 @@ hostname or IP address</description>
     different sections are combined when a request is received</seealso>
 </directivesynopsis>
 
+<directivesynopsis>
+<name>Warning</name>
+<description>Show custom warning message</description>
+<syntax>Warning <var>message</var></syntax>
+<contextlist><context>server config</context><context>virtual host</context>
+<context>directory</context><context>.htaccess</context>
+</contextlist>
+<compatibility>2.5.0 and later</compatibility>
+
+<usage>
+    <p>If an warning can be detected within the configuration, this
+    directive can be used to generate a custom warning message.</p>
+
+    <highlight language="config">
+# Example
+# show warning if mod_include is not loaded
+&lt;IfModule !include_module&gt;
+  Warning "mod_include is required by mod_foo. mod_foo will not be loaded"
+&lt;/IfModule&gt;
+    </highlight>
+
+</usage>
+<seealso><directive module="core">Error</directive></seealso>
+</directivesynopsis>
+
 </modulesynopsis>