Doc updates.

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

proposal/myrmidon/docs/buildfile.html

@@ -613,12 +613,12 @@ attributes:</p>
     <tr><td>
       <blockquote>
                         <p>
-Listed below are some of the current set of tasks.  You can find example
-usages of these tasks in the sample project file <code>src/make/sample.ant</code>.
-</p>
+    Listed below are some of the current set of tasks.  You can find example
+    usages of these tasks in the sample project file <code>src/make/sample.ant</code>.
+    </p>
                                 <h3><code>&lt;condition&gt;</code></h3>
                                 <p>Sets a property if a particular condition is true.  See
-<a href="#Conditions">Conditions</a> for a list of available conditions.</p>
+    <a href="#Conditions">Conditions</a> for a list of available conditions.</p>
                                 <h3><code>&lt;fail&gt;</code></h3>
                                 <p>Causes the build to fail.</p>
                                 <h3><code>&lt;if&gt;</code></h3>
@@ -633,7 +633,7 @@ usages of these tasks in the sample project file <code>src/make/sample.ant</code
                                 <p>Runs a set of tasks, with a provided error and clean-up handler.</p>
                                 <h3><code>&lt;converter-def&gt;</code></h3>
                                 <p>Register a type converter.  These are used when configuring a task
-or data-type from attributes.</p>
+    or data-type from attributes.</p>
                                 <h3><code>&lt;type-def&gt;</code></h3>
                                 <p>Register a task or data-type.</p>
                                 <h3><code>&lt;import&gt;</code></h3>
@@ -652,7 +652,7 @@ or data-type from attributes.</p>
                         <p>The following conditions are available </p>
                                 <h3><code>&lt;and&gt;</code></h3>
                                 <p>Evaluates a set of nested conditions, and AND them together.  Evaluation is
-lazy.  An empty <code>&lt;and&gt;</code> condition evaluates to true.</p>
+    lazy.  An empty <code>&lt;and&gt;</code> condition evaluates to true.</p>
                                 <h3><code>&lt;available&gt;</code></h3>
                                 <p>Tests if a particular class or resource is available.</p>
                                 <h3><code>&lt;file-test&gt;</code></h3>
@@ -661,13 +661,33 @@ lazy.  An empty <code>&lt;and&gt;</code> condition evaluates to true.</p>
                                 <p>Tests whether a proeprty is set, and not set to 'false'.</p>
                                 <h3><code>&lt;or&gt;</code></h3>
                                 <p>Evaluates a set of nested conditions, and OR them together.  Evaluation is
-lazy.  An empty <code>&lt;or&gt;</code> evaluates to true.</p>
+    lazy.  An empty <code>&lt;or&gt;</code> evaluates to true.</p>
                                 <h3><code>&lt;os&gt;</code></h3>
                                 <p>Tests which operating system the build is running on.</p>
                                 <h3><code>&lt;not&gt;</code></h3>
                                 <p>Negates a nested condition.</p>
                     </blockquote>
     </td></tr>
+  </table>
+        <table border="0" cellspacing="0" cellpadding="2" width="100%">
+    <tr><td bgcolor="#525D76">
+      <font color="#ffffff" face="arial,helvetica,sanserif">
+        <a name="File Name Mappers"><strong>File Name Mappers</strong></a>
+      </font>
+    </td></tr>
+    <tr><td>
+      <blockquote>
+                        <p>The following file name mappers are available:</p>
+                                <h3><code>&lt;chain&gt;</code></h3>
+                                <p>Applies a set of nested file name mappers to file names.</p>
+                                <h3><code>&lt;flatten&gt;</code></h3>
+                                <p>Maps all file names to a single directory.</p>
+                                <h3><code>&lt;prefix&gt;</code></h3>
+                                <p>Adds a prefix to the front of each file name.</p>
+                                <h3><code>&lt;map-extension&gt;</code></h3>
+                                <p>Changes the extension of file names.</p>
+                    </blockquote>
+    </td></tr>
   </table>
               </td>
         </tr>

proposal/myrmidon/docs/todo.html

@@ -170,18 +170,16 @@
                     </ul></li>
                     <li>File Name Mappers:
                     <ul>
-                        <li>Add a file name mapper interface, and port the current Mapper
-                        implementations to it.</li>
+                        <li>Change FileNameMapper.mapFileName() to take vfs.FileName objects.</li>
+                        <li>Move the current mapper implementations across to antlib.</li>
                     </ul></li>
                     <li>File Sets:
                     <ul>
-                        <li>Add a file set implementation that uses a mapper to transform a nested
-                        file set.</li>
                         <li>Add a file set implementation that provides the union of several
                         nested file sets (that is, a file set that merges several file sets
                         together).</li>
                         <li>Add a file set implementation that filters files that are up-to-date
-                        WRT some other file.  Alternatively, this might be better done using a
+                        WRT some other file.  Alternatively, this might be better done as a
                         file selector.</li>
                     </ul></li>
                     <li>Paths:
@@ -199,6 +197,7 @@
                         <li>Implement 'preservelastmodified', 'overwrite', and 'includeemptydirs'.</li>
                         <li>Support a file name mapper.</li>
                         <li>Support file filters.</li>
+                        <li>Detect and handle destination file name collisions.</li>
                     </ul></li>
                     <li>Implement the <code>&lt;move&gt;</code>, <code>&lt;delete&gt;</code>,
                     <code>&lt;touch&gt;</code> and <code>&lt;mkdir&gt;</code> tasks on top

proposal/myrmidon/docs/vfs.html

@@ -333,6 +333,10 @@
       </tr>
     </table>
   </div>
+                                <h3><code>&lt;mapped-fileset&gt;</code></h3>
+                                <p>A fileset that applies a <a href="buildfile.html#File Name Mappers">file name mapper</a>
+                    to a nested fileset.
+                </p>
                     </blockquote>
     </td></tr>
   </table>

proposal/myrmidon/src/xdocs/buildfile.xml

@@ -205,75 +205,96 @@ attributes:</p>
 
 <section name="Tasks">
 
-<p>
-Listed below are some of the current set of tasks.  You can find example
-usages of these tasks in the sample project file <code>src/make/sample.ant</code>.
-</p>
+    <p>
+    Listed below are some of the current set of tasks.  You can find example
+    usages of these tasks in the sample project file <code>src/make/sample.ant</code>.
+    </p>
 
-<h3><code>&lt;condition&gt;</code></h3>
+    <h3><code>&lt;condition&gt;</code></h3>
 
-<p>Sets a property if a particular condition is true.  See
-<a href="#Conditions">Conditions</a> for a list of available conditions.</p>
+    <p>Sets a property if a particular condition is true.  See
+    <a href="#Conditions">Conditions</a> for a list of available conditions.</p>
 
-<h3><code>&lt;fail&gt;</code></h3>
-<p>Causes the build to fail.</p>
+    <h3><code>&lt;fail&gt;</code></h3>
+    <p>Causes the build to fail.</p>
 
-<h3><code>&lt;if&gt;</code></h3>
-<p>Conditionally executes a set of tasks.</p>
+    <h3><code>&lt;if&gt;</code></h3>
+    <p>Conditionally executes a set of tasks.</p>
 
-<h3><code>&lt;load-properties&gt;</code></h3>
-<p>Loads a set of properties from a file.</p>
+    <h3><code>&lt;load-properties&gt;</code></h3>
+    <p>Loads a set of properties from a file.</p>
 
-<h3><code>&lt;log&gt;</code></h3>
-<p>Writes a log message.</p>
+    <h3><code>&lt;log&gt;</code></h3>
+    <p>Writes a log message.</p>
 
-<h3><code>&lt;property&gt;</code></h3>
-<p>Sets a property.</p>
+    <h3><code>&lt;property&gt;</code></h3>
+    <p>Sets a property.</p>
 
-<h3><code>&lt;try-catch&gt;</code></h3>
-<p>Runs a set of tasks, with a provided error and clean-up handler.</p>
+    <h3><code>&lt;try-catch&gt;</code></h3>
+    <p>Runs a set of tasks, with a provided error and clean-up handler.</p>
 
-<h3><code>&lt;converter-def&gt;</code></h3>
-<p>Register a type converter.  These are used when configuring a task
-or data-type from attributes.</p>
+    <h3><code>&lt;converter-def&gt;</code></h3>
+    <p>Register a type converter.  These are used when configuring a task
+    or data-type from attributes.</p>
 
-<h3><code>&lt;type-def&gt;</code></h3>
-<p>Register a task or data-type.</p>
+    <h3><code>&lt;type-def&gt;</code></h3>
+    <p>Register a task or data-type.</p>
 
-<h3><code>&lt;import&gt;</code></h3>
-<p>Register the contents of an antlib.</p>
+    <h3><code>&lt;import&gt;</code></h3>
+    <p>Register the contents of an antlib.</p>
 
 </section>
 
 <section name="Conditions">
 
-<p>The following conditions are available </p>
+    <p>The following conditions are available </p>
 
-<h3><code>&lt;and&gt;</code></h3>
-<p>Evaluates a set of nested conditions, and AND them together.  Evaluation is
-lazy.  An empty <code>&lt;and&gt;</code> condition evaluates to true.</p>
+    <h3><code>&lt;and&gt;</code></h3>
+    <p>Evaluates a set of nested conditions, and AND them together.  Evaluation is
+    lazy.  An empty <code>&lt;and&gt;</code> condition evaluates to true.</p>
 
-<h3><code>&lt;available&gt;</code></h3>
-<p>Tests if a particular class or resource is available.</p>
+    <h3><code>&lt;available&gt;</code></h3>
+    <p>Tests if a particular class or resource is available.</p>
 
-<h3><code>&lt;file-test&gt;</code></h3>
-<p>Tests a file against a set of <a href="vfs.html#File Selectors">file selectors</a>.</p>
+    <h3><code>&lt;file-test&gt;</code></h3>
+    <p>Tests a file against a set of <a href="vfs.html#File Selectors">file selectors</a>.</p>
 
-<h3><code>&lt;is-set&gt;</code></h3>
-<p>Tests whether a proeprty is set, and not set to 'false'.</p>
+    <h3><code>&lt;is-set&gt;</code></h3>
+    <p>Tests whether a proeprty is set, and not set to 'false'.</p>
 
-<h3><code>&lt;or&gt;</code></h3>
-<p>Evaluates a set of nested conditions, and OR them together.  Evaluation is
-lazy.  An empty <code>&lt;or&gt;</code> evaluates to true.</p>
+    <h3><code>&lt;or&gt;</code></h3>
+    <p>Evaluates a set of nested conditions, and OR them together.  Evaluation is
+    lazy.  An empty <code>&lt;or&gt;</code> evaluates to true.</p>
 
-<h3><code>&lt;os&gt;</code></h3>
-<p>Tests which operating system the build is running on.</p>
+    <h3><code>&lt;os&gt;</code></h3>
+    <p>Tests which operating system the build is running on.</p>
 
-<h3><code>&lt;not&gt;</code></h3>
-<p>Negates a nested condition.</p>
+    <h3><code>&lt;not&gt;</code></h3>
+    <p>Negates a nested condition.</p>
 
 </section>
 
+<section name="File Name Mappers">
+
+    <p>The following file name mappers are available:</p>
+
+    <h3><code>&lt;chain&gt;</code></h3>
+
+    <p>Applies a set of nested file name mappers to file names.</p>
+
+    <h3><code>&lt;flatten&gt;</code></h3>
+
+    <p>Maps all file names to a single directory.</p>
+
+    <h3><code>&lt;prefix&gt;</code></h3>
+
+    <p>Adds a prefix to the front of each file name.</p>
+
+    <h3><code>&lt;map-extension&gt;</code></h3>
+
+    <p>Changes the extension of file names.</p>
+
+</section>
 </body>
 
 </document>

proposal/myrmidon/src/xdocs/todo.xml

@@ -85,18 +85,16 @@
                     </ul></li>
                     <li>File Name Mappers:
                     <ul>
-                        <li>Add a file name mapper interface, and port the current Mapper
-                        implementations to it.</li>
+                        <li>Change FileNameMapper.mapFileName() to take vfs.FileName objects.</li>
+                        <li>Move the current mapper implementations across to antlib.</li>
                     </ul></li>
                     <li>File Sets:
                     <ul>
-                        <li>Add a file set implementation that uses a mapper to transform a nested
-                        file set.</li>
                         <li>Add a file set implementation that provides the union of several
                         nested file sets (that is, a file set that merges several file sets
                         together).</li>
                         <li>Add a file set implementation that filters files that are up-to-date
-                        WRT some other file.  Alternatively, this might be better done using a
+                        WRT some other file.  Alternatively, this might be better done as a
                         file selector.</li>
                     </ul></li>
                     <li>Paths:
@@ -114,6 +112,7 @@
                         <li>Implement 'preservelastmodified', 'overwrite', and 'includeemptydirs'.</li>
                         <li>Support a file name mapper.</li>
                         <li>Support file filters.</li>
+                        <li>Detect and handle destination file name collisions.</li>
                     </ul></li>
                     <li>Implement the <code>&lt;move&gt;</code>, <code>&lt;delete&gt;</code>,
                     <code>&lt;touch&gt;</code> and <code>&lt;mkdir&gt;</code> tasks on top

proposal/myrmidon/src/xdocs/vfs.xml

@@ -132,6 +132,11 @@
   </flat-fileset>
 </v-copy>
 ]]></source>
+                <h3><code>&lt;mapped-fileset&gt;</code></h3>
+
+                <p>A fileset that applies a <a href="buildfile.html#File Name Mappers">file name mapper</a>
+                    to a nested fileset.
+                </p>
 
             </subsection>