From: Eric Covener <covener@apache.org>
Date: Wed, 6 Jan 2010 01:31:06 +0000 (+0000)
Subject: clarify that FileETag is for static files only, and explicitly mention
X-Git-Tag: 2.3.5~18
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=0b90b0225d7811271101987a1c87646d504e2e9b;p=thirdparty%2Fapache%2Fhttpd.git

clarify that FileETag is for static files only, and explicitly mention
that ETags aren't generated for files parsed by mod_include.



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

diff --git a/docs/manual/mod/core.html.en b/docs/manual/mod/core.html.en
index 0b4b933918c..f5af9658b44 100644
--- a/docs/manual/mod/core.html.en
+++ b/docs/manual/mod/core.html.en
@@ -1137,7 +1137,7 @@ in case of an error</td></tr>
 <div class="directive-section"><h2><a name="FileETag" id="FileETag">FileETag</a> <a name="fileetag" id="fileetag">Directive</a></h2>
 <table class="directive">
 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File attributes used to create the ETag
-HTTP response header</td></tr>
+HTTP response header for static files</td></tr>
 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>FileETag <var>component</var> ...</code></td></tr>
 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>FileETag INode MTime Size</code></td></tr>
 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
@@ -1148,7 +1148,7 @@ HTTP response header</td></tr>
     <p>
     The <code class="directive">FileETag</code> directive configures the file
     attributes that are used to create the <code>ETag</code> (entity
-    tag) response header field when the document is based on a file.
+    tag) response header field when the document is based on a static file.
     (The <code>ETag</code> value is used in cache management to save
     network bandwidth.) In Apache 1.3.22 and earlier, the
     <code>ETag</code> value was <em>always</em> formed
@@ -1192,6 +1192,12 @@ HTTP response header</td></tr>
     These conditional requests will break if the <code>ETag</code> format is
     changed via <code class="directive">FileETag</code>.
     </div>
+    <div class="note"><h3>Server Side Includes</h3>
+    An ETag is not generated for responses parsed by <code class="module"><a href="../mod/mod_include.html">mod_include</a></code>, 
+    since the response entity can change without a change of the INode, MTime, or Size 
+    of the static file with embedded SSI directives.
+    </div>
+
 
 </div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml
index 2178f82b689..17573dee423 100644
--- a/docs/manual/mod/core.xml
+++ b/docs/manual/mod/core.xml
@@ -1095,7 +1095,7 @@ in case of an error</description>
 <directivesynopsis>
 <name>FileETag</name>
 <description>File attributes used to create the ETag
-HTTP response header</description>
+HTTP response header for static files</description>
 <syntax>FileETag <var>component</var> ...</syntax>
 <default>FileETag INode MTime Size</default>
 <contextlist><context>server config</context><context>virtual host</context>
@@ -1107,7 +1107,7 @@ HTTP response header</description>
     <p>
     The <directive>FileETag</directive> directive configures the file
     attributes that are used to create the <code>ETag</code> (entity
-    tag) response header field when the document is based on a file.
+    tag) response header field when the document is based on a static file.
     (The <code>ETag</code> value is used in cache management to save
     network bandwidth.) In Apache 1.3.22 and earlier, the
     <code>ETag</code> value was <em>always</em> formed
@@ -1151,6 +1151,12 @@ HTTP response header</description>
     These conditional requests will break if the <code>ETag</code> format is
     changed via <directive>FileETag</directive>.
     </note>
+    <note><title>Server Side Includes</title>
+    An ETag is not generated for responses parsed by <module>mod_include</module>, 
+    since the response entity can change without a change of the INode, MTime, or Size 
+    of the static file with embedded SSI directives.
+    </note>
+
 </usage>
 </directivesynopsis>