svn commit: r894306 - in /httpd/httpd/trunk/docs/manual/mod: mod_autoindex.html.en mod_autoindex.xml

[rb...@apache.org]

Author: rbowen
Date: Tue Dec 29 03:41:58 2009
New Revision: 894306

URL: http://svn.apache.org/viewvc?rev=894306&view=rev
Log:
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.

Modified:
    httpd/httpd/trunk/docs/manual/mod/mod_autoindex.html.en
    httpd/httpd/trunk/docs/manual/mod/mod_autoindex.xml

Modified: httpd/httpd/trunk/docs/manual/mod/mod_autoindex.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_autoindex.html.en?rev=894306&r1=894305&r2=894306&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_autoindex.html.en (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_autoindex.html.en Tue Dec 29 03:41:58 2009
@@ -303,6 +303,15 @@
     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>
 

Modified: httpd/httpd/trunk/docs/manual/mod/mod_autoindex.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_autoindex.xml?rev=894306&r1=894305&r2=894306&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_autoindex.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_autoindex.xml Tue Dec 29 03:41:58 2009
@@ -293,6 +293,15 @@
     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