Browse Source
Doc updates.
git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@271717 13f79535-47bb-0310-9956-ffa450edef68master
adammurdoch
23 years ago
6 changed files with 108 additions and 60 deletions
Unified View
Diff Options
-
+27 -7proposal/myrmidon/docs/buildfile.html
-
+4 -5proposal/myrmidon/docs/todo.html
-
+4 -0proposal/myrmidon/docs/vfs.html
-
+64 -43proposal/myrmidon/src/xdocs/buildfile.xml
-
+4 -5proposal/myrmidon/src/xdocs/todo.xml
-
+5 -0proposal/myrmidon/src/xdocs/vfs.xml
+ 27
- 7
proposal/myrmidon/docs/buildfile.html
View File
| @@ -613,12 +613,12 @@ attributes:</p> | |||||
| <tr><td> | <tr><td> | ||||
| <blockquote> | <blockquote> | ||||
| <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> | |||||
| 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><condition></code></h3> | <h3><code><condition></code></h3> | ||||
| <p>Sets a property if a particular condition is true. See | <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><fail></code></h3> | <h3><code><fail></code></h3> | ||||
| <p>Causes the build to fail.</p> | <p>Causes the build to fail.</p> | ||||
| <h3><code><if></code></h3> | <h3><code><if></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> | <p>Runs a set of tasks, with a provided error and clean-up handler.</p> | ||||
| <h3><code><converter-def></code></h3> | <h3><code><converter-def></code></h3> | ||||
| <p>Register a type converter. These are used when configuring a task | <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><type-def></code></h3> | <h3><code><type-def></code></h3> | ||||
| <p>Register a task or data-type.</p> | <p>Register a task or data-type.</p> | ||||
| <h3><code><import></code></h3> | <h3><code><import></code></h3> | ||||
| @@ -652,7 +652,7 @@ or data-type from attributes.</p> | |||||
| <p>The following conditions are available </p> | <p>The following conditions are available </p> | ||||
| <h3><code><and></code></h3> | <h3><code><and></code></h3> | ||||
| <p>Evaluates a set of nested conditions, and AND them together. Evaluation is | <p>Evaluates a set of nested conditions, and AND them together. Evaluation is | ||||
| lazy. An empty <code><and></code> condition evaluates to true.</p> | |||||
| lazy. An empty <code><and></code> condition evaluates to true.</p> | |||||
| <h3><code><available></code></h3> | <h3><code><available></code></h3> | ||||
| <p>Tests if a particular class or resource is available.</p> | <p>Tests if a particular class or resource is available.</p> | ||||
| <h3><code><file-test></code></h3> | <h3><code><file-test></code></h3> | ||||
| @@ -661,13 +661,33 @@ lazy. An empty <code><and></code> condition evaluates to true.</p> | |||||
| <p>Tests whether a proeprty is set, and not set to 'false'.</p> | <p>Tests whether a proeprty is set, and not set to 'false'.</p> | ||||
| <h3><code><or></code></h3> | <h3><code><or></code></h3> | ||||
| <p>Evaluates a set of nested conditions, and OR them together. Evaluation is | <p>Evaluates a set of nested conditions, and OR them together. Evaluation is | ||||
| lazy. An empty <code><or></code> evaluates to true.</p> | |||||
| lazy. An empty <code><or></code> evaluates to true.</p> | |||||
| <h3><code><os></code></h3> | <h3><code><os></code></h3> | ||||
| <p>Tests which operating system the build is running on.</p> | <p>Tests which operating system the build is running on.</p> | ||||
| <h3><code><not></code></h3> | <h3><code><not></code></h3> | ||||
| <p>Negates a nested condition.</p> | <p>Negates a nested condition.</p> | ||||
| </blockquote> | </blockquote> | ||||
| </td></tr> | </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><chain></code></h3> | |||||
| <p>Applies a set of nested file name mappers to file names.</p> | |||||
| <h3><code><flatten></code></h3> | |||||
| <p>Maps all file names to a single directory.</p> | |||||
| <h3><code><prefix></code></h3> | |||||
| <p>Adds a prefix to the front of each file name.</p> | |||||
| <h3><code><map-extension></code></h3> | |||||
| <p>Changes the extension of file names.</p> | |||||
| </blockquote> | |||||
| </td></tr> | |||||
| </table> | </table> | ||||
| </td> | </td> | ||||
| </tr> | </tr> | ||||
+ 4
- 5
proposal/myrmidon/docs/todo.html
View File
| @@ -170,18 +170,16 @@ | |||||
| </ul></li> | </ul></li> | ||||
| <li>File Name Mappers: | <li>File Name Mappers: | ||||
| <ul> | <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> | </ul></li> | ||||
| <li>File Sets: | <li>File Sets: | ||||
| <ul> | <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 | <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 | nested file sets (that is, a file set that merges several file sets | ||||
| together).</li> | together).</li> | ||||
| <li>Add a file set implementation that filters files that are up-to-date | <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> | file selector.</li> | ||||
| </ul></li> | </ul></li> | ||||
| <li>Paths: | <li>Paths: | ||||
| @@ -199,6 +197,7 @@ | |||||
| <li>Implement 'preservelastmodified', 'overwrite', and 'includeemptydirs'.</li> | <li>Implement 'preservelastmodified', 'overwrite', and 'includeemptydirs'.</li> | ||||
| <li>Support a file name mapper.</li> | <li>Support a file name mapper.</li> | ||||
| <li>Support file filters.</li> | <li>Support file filters.</li> | ||||
| <li>Detect and handle destination file name collisions.</li> | |||||
| </ul></li> | </ul></li> | ||||
| <li>Implement the <code><move></code>, <code><delete></code>, | <li>Implement the <code><move></code>, <code><delete></code>, | ||||
| <code><touch></code> and <code><mkdir></code> tasks on top | <code><touch></code> and <code><mkdir></code> tasks on top | ||||
+ 4
- 0
proposal/myrmidon/docs/vfs.html
View File
| @@ -333,6 +333,10 @@ | |||||
| </tr> | </tr> | ||||
| </table> | </table> | ||||
| </div> | </div> | ||||
| <h3><code><mapped-fileset></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> | </blockquote> | ||||
| </td></tr> | </td></tr> | ||||
| </table> | </table> | ||||
+ 64
- 43
proposal/myrmidon/src/xdocs/buildfile.xml
View File
| @@ -205,75 +205,96 @@ attributes:</p> | |||||
| <section name="Tasks"> | <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><condition></code></h3> | |||||
| <h3><code><condition></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><fail></code></h3> | |||||
| <p>Causes the build to fail.</p> | |||||
| <h3><code><fail></code></h3> | |||||
| <p>Causes the build to fail.</p> | |||||
| <h3><code><if></code></h3> | |||||
| <p>Conditionally executes a set of tasks.</p> | |||||
| <h3><code><if></code></h3> | |||||
| <p>Conditionally executes a set of tasks.</p> | |||||
| <h3><code><load-properties></code></h3> | |||||
| <p>Loads a set of properties from a file.</p> | |||||
| <h3><code><load-properties></code></h3> | |||||
| <p>Loads a set of properties from a file.</p> | |||||
| <h3><code><log></code></h3> | |||||
| <p>Writes a log message.</p> | |||||
| <h3><code><log></code></h3> | |||||
| <p>Writes a log message.</p> | |||||
| <h3><code><property></code></h3> | |||||
| <p>Sets a property.</p> | |||||
| <h3><code><property></code></h3> | |||||
| <p>Sets a property.</p> | |||||
| <h3><code><try-catch></code></h3> | |||||
| <p>Runs a set of tasks, with a provided error and clean-up handler.</p> | |||||
| <h3><code><try-catch></code></h3> | |||||
| <p>Runs a set of tasks, with a provided error and clean-up handler.</p> | |||||
| <h3><code><converter-def></code></h3> | |||||
| <p>Register a type converter. These are used when configuring a task | |||||
| or data-type from attributes.</p> | |||||
| <h3><code><converter-def></code></h3> | |||||
| <p>Register a type converter. These are used when configuring a task | |||||
| or data-type from attributes.</p> | |||||
| <h3><code><type-def></code></h3> | |||||
| <p>Register a task or data-type.</p> | |||||
| <h3><code><type-def></code></h3> | |||||
| <p>Register a task or data-type.</p> | |||||
| <h3><code><import></code></h3> | |||||
| <p>Register the contents of an antlib.</p> | |||||
| <h3><code><import></code></h3> | |||||
| <p>Register the contents of an antlib.</p> | |||||
| </section> | </section> | ||||
| <section name="Conditions"> | <section name="Conditions"> | ||||
| <p>The following conditions are available </p> | |||||
| <p>The following conditions are available </p> | |||||
| <h3><code><and></code></h3> | |||||
| <p>Evaluates a set of nested conditions, and AND them together. Evaluation is | |||||
| lazy. An empty <code><and></code> condition evaluates to true.</p> | |||||
| <h3><code><and></code></h3> | |||||
| <p>Evaluates a set of nested conditions, and AND them together. Evaluation is | |||||
| lazy. An empty <code><and></code> condition evaluates to true.</p> | |||||
| <h3><code><available></code></h3> | |||||
| <p>Tests if a particular class or resource is available.</p> | |||||
| <h3><code><available></code></h3> | |||||
| <p>Tests if a particular class or resource is available.</p> | |||||
| <h3><code><file-test></code></h3> | |||||
| <p>Tests a file against a set of <a href="vfs.html#File Selectors">file selectors</a>.</p> | |||||
| <h3><code><file-test></code></h3> | |||||
| <p>Tests a file against a set of <a href="vfs.html#File Selectors">file selectors</a>.</p> | |||||
| <h3><code><is-set></code></h3> | |||||
| <p>Tests whether a proeprty is set, and not set to 'false'.</p> | |||||
| <h3><code><is-set></code></h3> | |||||
| <p>Tests whether a proeprty is set, and not set to 'false'.</p> | |||||
| <h3><code><or></code></h3> | |||||
| <p>Evaluates a set of nested conditions, and OR them together. Evaluation is | |||||
| lazy. An empty <code><or></code> evaluates to true.</p> | |||||
| <h3><code><or></code></h3> | |||||
| <p>Evaluates a set of nested conditions, and OR them together. Evaluation is | |||||
| lazy. An empty <code><or></code> evaluates to true.</p> | |||||
| <h3><code><os></code></h3> | |||||
| <p>Tests which operating system the build is running on.</p> | |||||
| <h3><code><os></code></h3> | |||||
| <p>Tests which operating system the build is running on.</p> | |||||
| <h3><code><not></code></h3> | |||||
| <p>Negates a nested condition.</p> | |||||
| <h3><code><not></code></h3> | |||||
| <p>Negates a nested condition.</p> | |||||
| </section> | </section> | ||||
| <section name="File Name Mappers"> | |||||
| <p>The following file name mappers are available:</p> | |||||
| <h3><code><chain></code></h3> | |||||
| <p>Applies a set of nested file name mappers to file names.</p> | |||||
| <h3><code><flatten></code></h3> | |||||
| <p>Maps all file names to a single directory.</p> | |||||
| <h3><code><prefix></code></h3> | |||||
| <p>Adds a prefix to the front of each file name.</p> | |||||
| <h3><code><map-extension></code></h3> | |||||
| <p>Changes the extension of file names.</p> | |||||
| </section> | |||||
| </body> | </body> | ||||
| </document> | </document> | ||||
+ 4
- 5
proposal/myrmidon/src/xdocs/todo.xml
View File
| @@ -85,18 +85,16 @@ | |||||
| </ul></li> | </ul></li> | ||||
| <li>File Name Mappers: | <li>File Name Mappers: | ||||
| <ul> | <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> | </ul></li> | ||||
| <li>File Sets: | <li>File Sets: | ||||
| <ul> | <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 | <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 | nested file sets (that is, a file set that merges several file sets | ||||
| together).</li> | together).</li> | ||||
| <li>Add a file set implementation that filters files that are up-to-date | <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> | file selector.</li> | ||||
| </ul></li> | </ul></li> | ||||
| <li>Paths: | <li>Paths: | ||||
| @@ -114,6 +112,7 @@ | |||||
| <li>Implement 'preservelastmodified', 'overwrite', and 'includeemptydirs'.</li> | <li>Implement 'preservelastmodified', 'overwrite', and 'includeemptydirs'.</li> | ||||
| <li>Support a file name mapper.</li> | <li>Support a file name mapper.</li> | ||||
| <li>Support file filters.</li> | <li>Support file filters.</li> | ||||
| <li>Detect and handle destination file name collisions.</li> | |||||
| </ul></li> | </ul></li> | ||||
| <li>Implement the <code><move></code>, <code><delete></code>, | <li>Implement the <code><move></code>, <code><delete></code>, | ||||
| <code><touch></code> and <code><mkdir></code> tasks on top | <code><touch></code> and <code><mkdir></code> tasks on top | ||||
+ 5
- 0
proposal/myrmidon/src/xdocs/vfs.xml
View File
| @@ -132,6 +132,11 @@ | |||||
| </flat-fileset> | </flat-fileset> | ||||
| </v-copy> | </v-copy> | ||||
| ]]></source> | ]]></source> | ||||
| <h3><code><mapped-fileset></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> | </subsection> | ||||