From cad63fce0b5d0a4a695b75d90acc767026c6e2cf Mon Sep 17 00:00:00 2001 From: adammurdoch Date: Mon, 4 Mar 2002 04:24:24 +0000 Subject: [PATCH] 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 | 34 +++++-- proposal/myrmidon/docs/todo.html | 9 +- proposal/myrmidon/docs/vfs.html | 4 + proposal/myrmidon/src/xdocs/buildfile.xml | 107 +++++++++++++--------- proposal/myrmidon/src/xdocs/todo.xml | 9 +- proposal/myrmidon/src/xdocs/vfs.xml | 5 + 6 files changed, 108 insertions(+), 60 deletions(-) diff --git a/proposal/myrmidon/docs/buildfile.html b/proposal/myrmidon/docs/buildfile.html index 924f8697e..7cb213ed6 100644 --- a/proposal/myrmidon/docs/buildfile.html +++ b/proposal/myrmidon/docs/buildfile.html @@ -613,12 +613,12 @@ attributes:

-Listed below are some of the current set of tasks. You can find example -usages of these tasks in the sample project file src/make/sample.ant. -

+ Listed below are some of the current set of tasks. You can find example + usages of these tasks in the sample project file src/make/sample.ant. +

<condition>

Sets a property if a particular condition is true. See -Conditions for a list of available conditions.

+ Conditions for a list of available conditions.

<fail>

Causes the build to fail.

<if>

@@ -633,7 +633,7 @@ usages of these tasks in the sample project file src/make/sample.antRuns a set of tasks, with a provided error and clean-up handler.

<converter-def>

Register a type converter. These are used when configuring a task -or data-type from attributes.

+ or data-type from attributes.

<type-def>

Register a task or data-type.

<import>

@@ -652,7 +652,7 @@ or data-type from attributes.

The following conditions are available

<and>

Evaluates a set of nested conditions, and AND them together. Evaluation is -lazy. An empty <and> condition evaluates to true.

+ lazy. An empty <and> condition evaluates to true.

<available>

Tests if a particular class or resource is available.

<file-test>

@@ -661,13 +661,33 @@ lazy. An empty <and> condition evaluates to true.

Tests whether a proeprty is set, and not set to 'false'.

<or>

Evaluates a set of nested conditions, and OR them together. Evaluation is -lazy. An empty <or> evaluates to true.

+ lazy. An empty <or> evaluates to true.

<os>

Tests which operating system the build is running on.

<not>

Negates a nested condition.

+ + + +
+ + File Name Mappers + +
+
+

The following file name mappers are available:

+

<chain>

+

Applies a set of nested file name mappers to file names.

+

<flatten>

+

Maps all file names to a single directory.

+

<prefix>

+

Adds a prefix to the front of each file name.

+

<map-extension>

+

Changes the extension of file names.

+
+
diff --git a/proposal/myrmidon/docs/todo.html b/proposal/myrmidon/docs/todo.html index 6e3fc0974..f5c3c33d6 100644 --- a/proposal/myrmidon/docs/todo.html +++ b/proposal/myrmidon/docs/todo.html @@ -170,18 +170,16 @@
  • File Name Mappers:
  • File Sets:
  • Paths: @@ -199,6 +197,7 @@
  • Implement 'preservelastmodified', 'overwrite', and 'includeemptydirs'.
  • Support a file name mapper.
  • Support file filters.
    • +
  • Detect and handle destination file name collisions.
  • Implement the <move>, <delete>, <touch> and <mkdir> tasks on top diff --git a/proposal/myrmidon/docs/vfs.html b/proposal/myrmidon/docs/vfs.html index 340488105..53cd876db 100644 --- a/proposal/myrmidon/docs/vfs.html +++ b/proposal/myrmidon/docs/vfs.html @@ -333,6 +333,10 @@ +

    <mapped-fileset>

    +

    A fileset that applies a file name mapper + to a nested fileset. +

    diff --git a/proposal/myrmidon/src/xdocs/buildfile.xml b/proposal/myrmidon/src/xdocs/buildfile.xml index 96d1c223d..ba5aa2523 100644 --- a/proposal/myrmidon/src/xdocs/buildfile.xml +++ b/proposal/myrmidon/src/xdocs/buildfile.xml @@ -205,75 +205,96 @@ attributes:

    -

    -Listed below are some of the current set of tasks. You can find example -usages of these tasks in the sample project file src/make/sample.ant. -

    +

    + Listed below are some of the current set of tasks. You can find example + usages of these tasks in the sample project file src/make/sample.ant. +

    -

    <condition>

    +

    <condition>

    -

    Sets a property if a particular condition is true. See -Conditions for a list of available conditions.

    +

    Sets a property if a particular condition is true. See + Conditions for a list of available conditions.

    -

    <fail>

    -

    Causes the build to fail.

    +

    <fail>

    +

    Causes the build to fail.

    -

    <if>

    -

    Conditionally executes a set of tasks.

    +

    <if>

    +

    Conditionally executes a set of tasks.

    -

    <load-properties>

    -

    Loads a set of properties from a file.

    +

    <load-properties>

    +

    Loads a set of properties from a file.

    -

    <log>

    -

    Writes a log message.

    +

    <log>

    +

    Writes a log message.

    -

    <property>

    -

    Sets a property.

    +

    <property>

    +

    Sets a property.

    -

    <try-catch>

    -

    Runs a set of tasks, with a provided error and clean-up handler.

    +

    <try-catch>

    +

    Runs a set of tasks, with a provided error and clean-up handler.

    -

    <converter-def>

    -

    Register a type converter. These are used when configuring a task -or data-type from attributes.

    +

    <converter-def>

    +

    Register a type converter. These are used when configuring a task + or data-type from attributes.

    -

    <type-def>

    -

    Register a task or data-type.

    +

    <type-def>

    +

    Register a task or data-type.

    -

    <import>

    -

    Register the contents of an antlib.

    +

    <import>

    +

    Register the contents of an antlib.

    -

    The following conditions are available

    +

    The following conditions are available

    -

    <and>

    -

    Evaluates a set of nested conditions, and AND them together. Evaluation is -lazy. An empty <and> condition evaluates to true.

    +

    <and>

    +

    Evaluates a set of nested conditions, and AND them together. Evaluation is + lazy. An empty <and> condition evaluates to true.

    -

    <available>

    -

    Tests if a particular class or resource is available.

    +

    <available>

    +

    Tests if a particular class or resource is available.

    -

    <file-test>

    -

    Tests a file against a set of file selectors.

    +

    <file-test>

    +

    Tests a file against a set of file selectors.

    -

    <is-set>

    -

    Tests whether a proeprty is set, and not set to 'false'.

    +

    <is-set>

    +

    Tests whether a proeprty is set, and not set to 'false'.

    -

    <or>

    -

    Evaluates a set of nested conditions, and OR them together. Evaluation is -lazy. An empty <or> evaluates to true.

    +

    <or>

    +

    Evaluates a set of nested conditions, and OR them together. Evaluation is + lazy. An empty <or> evaluates to true.

    -

    <os>

    -

    Tests which operating system the build is running on.

    +

    <os>

    +

    Tests which operating system the build is running on.

    -

    <not>

    -

    Negates a nested condition.

    +

    <not>

    +

    Negates a nested condition.

    +
    + +

    The following file name mappers are available:

    + +

    <chain>

    + +

    Applies a set of nested file name mappers to file names.

    + +

    <flatten>

    + +

    Maps all file names to a single directory.

    + +

    <prefix>

    + +

    Adds a prefix to the front of each file name.

    + +

    <map-extension>

    + +

    Changes the extension of file names.

    + +
    diff --git a/proposal/myrmidon/src/xdocs/todo.xml b/proposal/myrmidon/src/xdocs/todo.xml index 9e909ac99..cdb2890ce 100644 --- a/proposal/myrmidon/src/xdocs/todo.xml +++ b/proposal/myrmidon/src/xdocs/todo.xml @@ -85,18 +85,16 @@
  • File Name Mappers:
  • File Sets:
  • Paths: @@ -114,6 +112,7 @@
  • Implement 'preservelastmodified', 'overwrite', and 'includeemptydirs'.
  • Support a file name mapper.
  • Support file filters.
    • +
  • Detect and handle destination file name collisions.
  • Implement the <move>, <delete>, <touch> and <mkdir> tasks on top diff --git a/proposal/myrmidon/src/xdocs/vfs.xml b/proposal/myrmidon/src/xdocs/vfs.xml index 9ed6e07b0..ab2ea2776 100644 --- a/proposal/myrmidon/src/xdocs/vfs.xml +++ b/proposal/myrmidon/src/xdocs/vfs.xml @@ -132,6 +132,11 @@ ]]> +

    <mapped-fileset>

    + +

    A fileset that applies a file name mapper + to a nested fileset. +