Rename <transform> to <apply>

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@268553 13f79535-47bb-0310-9956-ffa450edef68
24 years ago · a9223a72db
--- a/+ 2
+++ b/+ 2
@@ -19,7 +19,7 @@ Other changes:
 * A GUI Frontend: Antidote. This is currently in development.

 * New tasks: stylebook, propertyfile, depend, antlr, telnet, csc,
  ilasm, transform, javah, several clearcase tasks
  ilasm, apply, javah, several clearcase tasks

 * Added output attribute to <java>.

@@ -39,7 +39,7 @@ Other changes:

 * New <mapper> data type that can be used to get influence on the
  target files for some tasks like <copy> or enable new types of tasks
  like <transform>.
  like <apply>.

 * <execon> provides more control over the command line now, the names
  of the source files are no longer required to be at the end of the
--- a/docs/index.html
+++ b/docs/index.html
@@ -1382,6 +1382,7 @@ cannot be found, try jakarta-regexp.</li>
  <li><a href="#ant">Ant</a></li>
  <li><a href="#antcall">AntCall</a></li>
  <li><a href="#antstructure">AntStructure</a></li>
  <li><a href="#apply">Apply</a></li>
  <li><a href="#available">Available</a></li>
  <li><a href="#chmod">Chmod</a></li>
  <li><a href="#copy">Copy</a></li>
@@ -1418,7 +1419,6 @@ cannot be found, try jakarta-regexp.</li>
  <li><a href="#tar">Tar</a></li>
  <li><a href="#taskdef">Taskdef</a></li>
  <li><a href="#touch">Touch</a></li>
  <li><a href="#transform">Transform</a></li>
  <li><a href="#tstamp">Tstamp</a></li>
  <li><a href="#unzip">Unjar</a></li>
  <li><a href="#untar">Untar</a></li>
@@ -1547,6 +1547,123 @@ listed as <code>#IMPLIED</code>.</p>
 &lt;antstructure output=&quot;project.dtd&quot;/&gt;
 </pre></blockquote>
 <hr>
 <h2><a name="apply">Apply</a></h2>
 <h3>Description</h3>
 <p>Executes a system command. When the <i>os</i> attribute is specified, then
 the command is only executed when Ant is run on one of the specified operating
 systems.</p>
 <p>The files and/or directories of a number of <a
 href="#fileset">FileSet</a>s are passed as arguments to the system
 command. The timestamp of each source file is compared to the
 timestamp of a target file which is defined by a nested <a
 href="#mapper">mapper</a> element. At least one fileset and exactly
 one mapper element are required.</p>
 <h3>Parameters</h3>
 <table border="1" cellpadding="2" cellspacing="0">
  <tr>
    <td valign="top"><b>Attribute</b></td>
    <td valign="top"><b>Description</b></td>
    <td align="center" valign="top"><b>Required</b></td>
  </tr>
  <tr>
    <td valign="top">executable</td>
    <td valign="top">the command to execute without any command line
      arguments.</td>
    <td align="center" valign="top">Yes</td>
  </tr>
  <tr>
    <td valign="top">dest</td>
    <td valign="top">the directory where the target files will be placed.</td>
    <td align="center" valign="top">Yes</td>
  </tr>
  <tr>
    <td valign="top">dir</td>
    <td valign="top">the directory in which the command should be executed.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">os</td>
    <td valign="top">list of Operating Systems on which the command may be
      executed.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">output</td>
    <td valign="top">the file to which the output of the command should be
      redirected.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">timeout</td>
    <td valign="top">Stop the command if it doesn't finish within the
      specified time (given in milliseconds).</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">failonerror</td>
    <td valign="top">Stop the buildprocess if the command exits with a
      returncode other than 0.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">parallel</td>
    <td valign="top">Run the command only once, appending all files as
      arguments. Defaults to true. If false, command will be executed
      once for every file.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">type</td>
    <td valign="top">One of <i>file</i>, <i>dir</i> or
      <i>both</i>. If set to <i>file</i>, only the names of plain
      files will be sent to the command. If set to <i>dir</i>, only
      the names of directories are considered.</td>
    <td align="center" valign="top">No, default is <i>file</i></td>
  </tr>
 </table>
 <h3>Parameters specified as nested elements</h3>
 <h4>fileset</h4>
 <p>You can use any number of nested <code>&lt;fileset&gt;</code>
 elements to define the files for this task and refer to
 <code>&lt;fileset&gt;</code>s defined elsewhere.</p>
 <h4>arg</h4>
 <p>Command line arguments should be specified as nested
 <code>&lt;arg&gt;</code> elements. See <a
 href="index.html#arg">Command line arguments</a>.</p>
 <h4>srcfile</h4>
 <p>By default the file names of the source files will be added to the
 end of the command line. If you need to place it somewhere different,
 use a nested <code>&lt;srcfile&gt;</code> element between your
 <code>&lt;arg&gt;</code> elements to mark the insertion point.</code>
 <h4>targetfile</h4>
 <p><code>&lt;targetfile&gt;</code> is similar to
 <code>&lt;srcfile&gt;</code> and marks the position of the target
 filename on the command line. If omitted, the target filenames will
 not be added to the command line at all.</p>
 <h4>env</h4>
 <p>It is possible to specify environment variables to pass to the
 system command via nested <code>&lt;env&gt;</code> elements. See the
 description in the section about <a href="#env">exec</a></p>
 <p>Please note that the environment of the current Ant process is
 <b>not</b> passed to the system command if you specify variables using
 <code>&lt;env&gt;</code>.</p>
 <h3>Examples</h3>
 <blockquote><pre>
 &lt;apply executable=&quot;cc&quot; dest=&quot;src/C&quot; parallel=&quot;false&quot;&gt;
  &lt;arg value=&quot;-c&quot;/&gt;
  &lt;arg value=&quot;-o&quot;/&gt;
  &lt;targetfile/&gt;
  &lt;srcfile/&gt;
  &lt;fileset dir=&quot;src/C&quot; includes=&quot;*.c&quot;/&gt;
  &lt;mapper type=&quot;glob&quot; from=&quot;*.c&quot; to=&quot;*.o&quot;/&gt;
 &lt;/apply&gt;
 </pre></blockquote>
 <p>invokes <code>cc -c -o TARGETFILE SOURCEFILE</code> for each
 <code>.c</code> file that is newer than the corresponding
 <code>.o</code>, replacing TARGETFILE with the absolute filename of
 the <code>.o</code> and SOURCEFILE with the absolute name of the
 <code>.c</code> file.</p>
 <hr>
 <h2><a name="available">Available</a></h2>
 <h3>Description</h3>
 <p>Sets a property if a resource is available at runtime. This resource can be a
@@ -4917,123 +5034,6 @@ modification time to the current time.</p>
 modification time to Jun, 28 2000 2:02 pm (14:02 for those used to 24
 hour times).</p>
 <hr>
 <h2><a name="transform">Transform</a></h2>
 <h3>Description</h3>
 <p>Executes a system command. When the <i>os</i> attribute is specified, then
 the command is only executed when Ant is run on one of the specified operating
 systems.</p>
 <p>The files and/or directories of a number of <a
 href="#fileset">FileSet</a>s are passed as arguments to the system
 command. The timestamp of each source file is compared to the
 timestamp of a target file which is defined by a nested <a
 href="#mapper">mapper</a> element. At least one fileset and exactly
 one mapper element are required.</p>
 <h3>Parameters</h3>
 <table border="1" cellpadding="2" cellspacing="0">
  <tr>
    <td valign="top"><b>Attribute</b></td>
    <td valign="top"><b>Description</b></td>
    <td align="center" valign="top"><b>Required</b></td>
  </tr>
  <tr>
    <td valign="top">executable</td>
    <td valign="top">the command to execute without any command line
      arguments.</td>
    <td align="center" valign="top">Yes</td>
  </tr>
  <tr>
    <td valign="top">dest</td>
    <td valign="top">the directory where the target files will be placed.</td>
    <td align="center" valign="top">Yes</td>
  </tr>
  <tr>
    <td valign="top">dir</td>
    <td valign="top">the directory in which the command should be executed.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">os</td>
    <td valign="top">list of Operating Systems on which the command may be
      executed.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">output</td>
    <td valign="top">the file to which the output of the command should be
      redirected.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">timeout</td>
    <td valign="top">Stop the command if it doesn't finish within the
      specified time (given in milliseconds).</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">failonerror</td>
    <td valign="top">Stop the buildprocess if the command exits with a
      returncode other than 0.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">parallel</td>
    <td valign="top">Run the command only once, appending all files as
      arguments. Defaults to true. If false, command will be executed
      once for every file.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">type</td>
    <td valign="top">One of <i>file</i>, <i>dir</i> or
      <i>both</i>. If set to <i>file</i>, only the names of plain
      files will be sent to the command. If set to <i>dir</i>, only
      the names of directories are considered.</td>
    <td align="center" valign="top">No, default is <i>file</i></td>
  </tr>
 </table>
 <h3>Parameters specified as nested elements</h3>
 <h4>fileset</h4>
 <p>You can use any number of nested <code>&lt;fileset&gt;</code>
 elements to define the files for this task and refer to
 <code>&lt;fileset&gt;</code>s defined elsewhere.</p>
 <h4>arg</h4>
 <p>Command line arguments should be specified as nested
 <code>&lt;arg&gt;</code> elements. See <a
 href="index.html#arg">Command line arguments</a>.</p>
 <h4>srcfile</h4>
 <p>By default the file names of the source files will be added to the
 end of the command line. If you need to place it somewhere different,
 use a nested <code>&lt;srcfile&gt;</code> element between your
 <code>&lt;arg&gt;</code> elements to mark the insertion point.</code>
 <h4>targetfile</h4>
 <p><code>&lt;targetfile&gt;</code> is similar to
 <code>&lt;srcfile&gt;</code> and marks the position of the target
 filename on the command line. If omitted, the target filenames will
 not be added to the command line at all.</p>
 <h4>env</h4>
 <p>It is possible to specify environment variables to pass to the
 system command via nested <code>&lt;env&gt;</code> elements. See the
 description in the section about <a href="#env">exec</a></p>
 <p>Please note that the environment of the current Ant process is
 <b>not</b> passed to the system command if you specify variables using
 <code>&lt;env&gt;</code>.</p>
 <h3>Examples</h3>
 <blockquote><pre>
 &lt;transform executable=&quot;cc&quot; dest=&quot;src/C&quot; parallel=&quot;false&quot;&gt;
  &lt;arg value=&quot;-c&quot;/&gt;
  &lt;arg value=&quot;-o&quot;/&gt;
  &lt;targetfile/&gt;
  &lt;srcfile/&gt;
  &lt;fileset dir=&quot;src/C&quot; includes=&quot;*.c&quot;/&gt;
  &lt;mapper type=&quot;glob&quot; from=&quot;*.c&quot; to=&quot;*.o&quot;/&gt;
 &lt;/transform&gt;
 </pre></blockquote>
 <p>invokes <code>cc -c -o TARGETFILE SOURCEFILE</code> for each
 <code>.c</code> file that is newer than the corresponding
 <code>.o</code>, replacing TARGETFILE with the absolute filename of
 the <code>.o</code> and SOURCEFILE with the absolute name of the
 <code>.c</code> file.</p>
 <hr>
 <h2><a name="tstamp">Tstamp</a></h2>
 <h3>Description</h3>
 <p>Sets the DSTAMP, TSTAMP and TODAY properties in the current project. The
--- a/src/main/org/apache/tools/ant/taskdefs/defaults.properties
+++ b/src/main/org/apache/tools/ant/taskdefs/defaults.properties
@@ -42,7 +42,7 @@ mail=org.apache.tools.ant.taskdefs.SendEmail
 fail=org.apache.tools.ant.taskdefs.Exit
 war=org.apache.tools.ant.taskdefs.War
 uptodate=org.apache.tools.ant.taskdefs.UpToDate
 transform=org.apache.tools.ant.taskdefs.Transform
 apply=org.apache.tools.ant.taskdefs.Transform

 # optional tasks
 script=org.apache.tools.ant.taskdefs.optional.Script