From: Rich Bowen <rbowen@apache.org>
Date: Tue, 29 Dec 2009 03:41:58 +0000 (+0000)
Subject: Adds a clarification to the AddDescription docs, to address the
X-Git-Tag: 2.3.5~54
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=dd2d2be31cc0c1c4b43408e86f83f1e65c0a685a;p=apache

Adds a clarification to the AddDescription docs, to address the
confusion indicated in https://issues.apache.org/bugzilla/show_bug.cgi?id=17210
The problem described there is fixed by a reordering of the
AddDescription directives.


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

diff --git a/docs/manual/mod/mod_autoindex.html.en b/docs/manual/mod/mod_autoindex.html.en
index 17f12bd8ea..eb1468c256 100644
--- a/docs/manual/mod/mod_autoindex.html.en
+++ b/docs/manual/mod/mod_autoindex.html.en
@@ -303,6 +303,15 @@ icon selected by MIME content-type</td></tr>
     Therefore, the widest default the description column is ever
     assigned is 55 bytes.</p>
 
+    <p>Since the <var>File</var> argument may be a partial file name,
+    please remember that a too-short partial filename may match
+    unintended files. For example, <code>le.html</code> will match the
+    file <code>le.html</code> but will also match the file
+    <code>example.html</code>. In the event that there may be ambiguity,
+    use as complete a filename as you can, but keep in mind that the
+    first match encountered will be used, and order your list of
+    <code>AddDescription</code> directives accordingly.</p>
+
     <p>See the <a href="#indexoptions.descriptionwidth">DescriptionWidth</a> <code class="directive"><a href="#indexoptions">IndexOptions</a></code> keyword for details on overriding the size
     of this column, or allowing descriptions of unlimited length.</p>
 
diff --git a/docs/manual/mod/mod_autoindex.xml b/docs/manual/mod/mod_autoindex.xml
index 483eb695b7..7564184e6e 100644
--- a/docs/manual/mod/mod_autoindex.xml
+++ b/docs/manual/mod/mod_autoindex.xml
@@ -293,6 +293,15 @@ icon selected by MIME content-type</description>
     Therefore, the widest default the description column is ever
     assigned is 55 bytes.</p>
 
+    <p>Since the <var>File</var> argument may be a partial file name,
+    please remember that a too-short partial filename may match
+    unintended files. For example, <code>le.html</code> will match the
+    file <code>le.html</code> but will also match the file
+    <code>example.html</code>. In the event that there may be ambiguity,
+    use as complete a filename as you can, but keep in mind that the
+    first match encountered will be used, and order your list of
+    <code>AddDescription</code> directives accordingly.</p>
+
     <p>See the <a href="#indexoptions.descriptionwidth"
     >DescriptionWidth</a> <directive module="mod_autoindex"
     >IndexOptions</directive> keyword for details on overriding the size