From 427e62a48d025e895dcc19c758d81cdf2baa4598 Mon Sep 17 00:00:00 2001 From: Matthew Jason Benson Date: Tue, 25 Jan 2005 22:13:47 +0000 Subject: [PATCH] Make dest optional; some reformatting. git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@277465 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/CoreTasks/apply.html | 121 +++++++++++++++---------------- 1 file changed, 60 insertions(+), 61 deletions(-) diff --git a/docs/manual/CoreTasks/apply.html b/docs/manual/CoreTasks/apply.html index 5d9e88426..e39fbf49d 100644 --- a/docs/manual/CoreTasks/apply.html +++ b/docs/manual/CoreTasks/apply.html @@ -15,18 +15,19 @@ compatibility.

Executes a system command. When the os attribute is specified, then the command is only executed when Ant is run on one of the specified operating systems.

-

The files and/or directories of a number of FileSets, DirSets (since Ant 1.6) -or FileLists (since Ant -1.6) are passed as arguments to the system command.

-

If you specify a nested mapper and the dest attribute, +

The files and/or directories of a number of + FileSets, + DirSets + (since Ant 1.6) or + FileLists + (since Ant 1.6) + are passed as arguments to the system command.

+

If you specify a nested mapper, the timestamp of each source file is compared to the timestamp of a target file which is defined by the nested mapper element and searched -for in the given dest.

-

At least one fileset or filelist is required, and you must not specify more than -one mapper.

+for in the given dest, if specified.

+

At least one fileset or filelist is required, +and you must not specify more than one mapper.

Note that you cannot interact with the forked program, the only way to send input to it is via the input and inputstring attributes.

@@ -46,20 +47,20 @@ to send input to it is via the input and inputstring attributes.

dest - the directory where the <apply> expects the target files will be placed by the - command, when it is executed. - - Yes, if you specify a nested mapper + the directory where the command is expected to place + target files when it is executed. This attribute is valid only when used + in conjunction with a nested mapper; if omitted, the target filenames + returned by the mapper will be interpreted as absolute paths. + No spawn - whether or not you want the commands to be spawned
- Default is false.
- If you spawn a command, its output will not be logged by ant.
- The input, output, error, and result property settings are not active when spawning a process.
- since Ant 1.6 + whether or not you want the commands to be spawned.
+ If you spawn a command, its output will not be logged by ant.
+ The input, output, error, and result property settings are not active when spawning a process.
+ since Ant 1.6 - No + No, default is false @@ -70,9 +71,9 @@ to send input to it is via the input and inputstring attributes.

relative whether the filenames should be passed on the - command line as absolute or relative pathnames (relative to the - base directory of the corresponding fileset/list for source files or - the dest attribute for target files). + command line as relative pathnames (relative to the base directory + of the corresponding fileset/list for source files or the + dest attribute for target files). No, default is false @@ -99,7 +100,7 @@ to send input to it is via the input and inputstring attributes.

error The file to which the standard error of the - command should be redirected. since Ant 1.6 + command should be redirected. since Ant 1.6 No @@ -109,15 +110,15 @@ to send input to it is via the input and inputstring attributes.

file/property. The error output will not be included in the output file/property. If you redirect error with the "error" or "errorProperty" attributes, this will have no effect. - since Ant 1.6 + since Ant 1.6 No append whether output should be appended to or overwrite - an existing file. Defaults to false. If you set parallel to - false, you will probably want to set this one to true. - No + an existing file. If you set parallel to false, you will probably + want to set this one to true. + No, default is false outputproperty @@ -130,21 +131,21 @@ to send input to it is via the input and inputstring attributes.

errorproperty The name of a property in which the standard error of the - command should be stored. since Ant 1.6 + command should be stored. since Ant 1.6 No input A file from which the executed command's standard input is taken. This attribute is mutually exclusive with the - inputstring attribute. since Ant 1.6 + inputstring attribute. since Ant 1.6 No inputstring A string which serves as the input stream for the executed command. This attribute is mutually exclusive with the - input attribute. since Ant 1.6 + input attribute. since Ant 1.6 No @@ -184,16 +185,15 @@ to send input to it is via the input and inputstring attributes.

parallel Run the command only once, appending all files as - arguments. If false, command will be executed once for every file. - Defaults to false. - No + arguments. If false, command will be executed once for every file. + No, default is false type One of file, dir or both. If set to file, only the names of plain files will be sent to the command. If set to dir, only - the names of directories are considered.
+ the names of directories are considered.
Note: The type attribute does not apply to nested dirsets - dirsets always implicitly assume type to be dir. @@ -225,40 +225,39 @@ to send input to it is via the input and inputstring attributes.

executable if resolved firstly against the project basedir and if that does not exist, against the execution directory if specified. On Unix systems, if you only want to allow execution of - commands in the user's path, set this to false. since Ant - 1.6 + commands in the user's path, set this to false. + since Ant 1.6 No, default is false maxparallel Limit the amount of parallelism by passing at most this many sourcefiles at once. Set it to <= 0 for - unlimited. Defaults to unlimited. Since Ant 1.6. - No + unlimited. Since Ant 1.6. + No, unlimited by default addsourcefile Whether source file names should be added to the - command automatically. Defaults to true. - Since Ant 1.6. - No + command automatically. Since Ant 1.6. + No, default is true verbose Whether to print a summary after execution or not. - Defaults to false. Since Ant 1.6. - No + Since Ant 1.6. + No, default false ignoremissing Whether to ignore nonexistent files specified - via filelists. Since Ant 1.6.2. + via filelists. Since Ant 1.6.2. No, default is true force Whether to bypass timestamp comparisons - for target files. Since Ant 1.7. + for target files. Since Ant 1.6.3. No, default is false @@ -268,20 +267,21 @@ to send input to it is via the input and inputstring attributes.

elements to define the files for this task and refer to <fileset>s defined elsewhere.

filelist

-

Since Ant 1.6

+

Since Ant 1.6

You can use any number of nested <filelist> elements to define the files for this task and refer to <filelist>s defined elsewhere.

dirset

-

Since Ant 1.6

+

Since Ant 1.6

You can use any number of nested <dirset> elements to define the directories for this task and refer to <dirset>s defined elsewhere.

mapper

-

A single <mapper> specifies the target files -relative to the dest attribute for dependency checking. -At least one <fileset> or -<filelist> is required.

+

A single <mapper> specifies the target files relative +to the dest attribute for dependency checking. If the +dest attribute is specified it will be used as a base directory +for resolving relative pathnames returned by the mapper. At least one +<fileset> or <filelist> is required.

arg

Command line arguments should be specified as nested <arg> elements. See <srcfile> element between your <srcfile> 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. This element can only be -specified, if you also define a nested mapper and the dest -attribute.

+specified if you also define a nested mapper.

env

It is possible to specify environment variables to pass to the system command via nested <env> elements. See the description in the section about exec

redirector

-Since Ant 1.6.2 +Since Ant 1.6.2

A nested I/O Redirector can be specified. <apply>'s behavior is like that of exec with regard to @@ -371,16 +370,16 @@ the .o and SOURCEFILE with the absolute name of the </apply> Applies the fictitious "processfile" executable to all -files matching *.file in the src directory. -The out <mapper> has been set up to map -*.file to *.out, then this <mapper> -is used to specify targetfiles for this <apply> -task. A reference to out is then used as an +files matching *.file in the src directory. +The out <mapper> has been set up to map +*.file to *.out, then this <mapper> +is used to specify targetfiles for this <apply> +task. A reference to out is then used as an <outputmapper> nested in a <redirector>, which in turn is nested beneath this <apply> instance. This allows us to perform dependency checking against output files--the target files in this case. -

Copyright © 2000-2004 The Apache Software Foundation. All rights +

Copyright © 2000-2005 The Apache Software Foundation. All rights Reserved.