You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ant.apache.org by ad...@apache.org on 2002/03/04 05:24:24 UTC

cvs commit: jakarta-ant/proposal/myrmidon/docs buildfile.html todo.html vfs.html

adammurdoch    02/03/03 20:24:24

  Modified:    proposal/myrmidon/src/xdocs buildfile.xml todo.xml vfs.xml
               proposal/myrmidon/docs buildfile.html todo.html vfs.html
  Log:
  Doc updates.
  
  Revision  Changes    Path
  1.3       +64 -43    jakarta-ant/proposal/myrmidon/src/xdocs/buildfile.xml
  
  Index: buildfile.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/xdocs/buildfile.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- buildfile.xml	3 Mar 2002 08:32:28 -0000	1.2
  +++ buildfile.xml	4 Mar 2002 04:24:24 -0000	1.3
  @@ -205,75 +205,96 @@
   
   <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>
  
  
  
  1.6       +4 -5      jakarta-ant/proposal/myrmidon/src/xdocs/todo.xml
  
  Index: todo.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/xdocs/todo.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- todo.xml	3 Mar 2002 08:32:28 -0000	1.5
  +++ todo.xml	4 Mar 2002 04:24:24 -0000	1.6
  @@ -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
  
  
  
  1.5       +5 -0      jakarta-ant/proposal/myrmidon/src/xdocs/vfs.xml
  
  Index: vfs.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/src/xdocs/vfs.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- vfs.xml	3 Mar 2002 08:32:28 -0000	1.4
  +++ vfs.xml	4 Mar 2002 04:24:24 -0000	1.5
  @@ -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>
   
  
  
  
  1.3       +27 -7     jakarta-ant/proposal/myrmidon/docs/buildfile.html
  
  Index: buildfile.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/docs/buildfile.html,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- buildfile.html	3 Mar 2002 08:32:28 -0000	1.2
  +++ buildfile.html	4 Mar 2002 04:24:24 -0000	1.3
  @@ -613,12 +613,12 @@
       <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 @@
                                   <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 @@
                           <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,11 +661,31 @@
                                   <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>
  
  
  
  1.6       +4 -5      jakarta-ant/proposal/myrmidon/docs/todo.html
  
  Index: todo.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/docs/todo.html,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- todo.html	3 Mar 2002 08:32:28 -0000	1.5
  +++ todo.html	4 Mar 2002 04:24:24 -0000	1.6
  @@ -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
  
  
  
  1.4       +4 -0      jakarta-ant/proposal/myrmidon/docs/vfs.html
  
  Index: vfs.html
  ===================================================================
  RCS file: /home/cvs/jakarta-ant/proposal/myrmidon/docs/vfs.html,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- vfs.html	3 Mar 2002 08:32:28 -0000	1.3
  +++ vfs.html	4 Mar 2002 04:24:24 -0000	1.4
  @@ -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>
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>