From: Rich Bowen <rbowen@apache.org>
Date: Thu, 24 Jan 2013 01:15:28 +0000 (+0000)
Subject: Adds examples for fsize and clarifies the difference between file and virtual
X-Git-Tag: 2.5.0-alpha~5824
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ba5439180d9854b2248b3027a88cf0d04202babc;p=apache

Adds examples for fsize and clarifies the difference between file and virtual

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

diff --git a/docs/manual/mod/mod_include.xml b/docs/manual/mod/mod_include.xml
index 4dcce2653c..55700e42e7 100644
--- a/docs/manual/mod/mod_include.xml
+++ b/docs/manual/mod/mod_include.xml
@@ -332,7 +332,17 @@ AddOutputFilter INCLUDES .shtml
       <dl>
       <dt><code>file</code></dt>
       <dd>The value is a path relative to the directory
-      containing the current document being parsed.</dd>
+      containing the current document being parsed.
+
+    <example>
+        This file is &lt;!--#fsize file="mod_include.html" --&gt; bytes.
+    </example>
+
+    The value of <code>file</code> cannot start with a slash, nor can it
+    refer to a file above the current directory. Attempting to so will
+    result in the error message: <code>The given path was above the root
+    path</code>.
+      </dd>
 
       <dt><code>virtual</code></dt>
       <dd>The value is a (%-encoded) URL-path. If it does not begin with
@@ -340,6 +350,14 @@ AddOutputFilter INCLUDES .shtml
       Note, that this does <em>not</em> print the size of any CGI output,
       but the size of the CGI script itself.</dd>
       </dl>
+
+    <example>
+        This file is &lt;!--#fsize virtual="/docs/mod/mod_include.html" --&gt; bytes.
+    </example>
+
+      <p>Note that in many cases these two are exactly the same thing.
+      However, the <code>file</code> attribute doesn't respect URL-space
+      aliases.</p>
     </section> <!-- /fsize -->
 
     <section id="element.flastmod"><title>The flastmod Element</title>