holtdl 02/02/05 12:21:59
Modified: docs/manual/CoreTasks delete.html
Log:
Fix the 'dir' attribute description, and usual general clean-up.
Also removed the block of deprecated attrs, since they were old
enough to qualify for social security :)
PR: 5777
Revision Changes Path
1.9 +27 -52 jakarta-ant/docs/manual/CoreTasks/delete.html
Index: delete.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/delete.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- delete.html 3 Feb 2002 22:00:42 -0000 1.8
+++ delete.html 5 Feb 2002 20:21:59 -0000 1.9
@@ -9,10 +9,13 @@
<h2><a name="delete">Delete</a></h2>
<h3>Description</h3>
-<p>Deletes either a single file, all files in a specified directory and its
-sub-directories, or a set of files specified by one or more <a
href="../CoreTypes/fileset.html">FileSet</a>s.
-When specifying a set of files, empty directories are <i>not</i> removed by
default.
-To remove empty directories, use the <em>includeEmptyDirs</em> atribute.</p>
+<p>Deletes a single file, a specified directory and all its files and
+subdirectories, or a set of files specified by one or more
+<a href="../CoreTypes/fileset.html">FileSet</a>s.
+When specifying a set of files, empty directories are <i>not</i> removed by
+default.
+To remove empty directories, use the <code>includeEmptyDirs</code> attribute.
+</p>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
@@ -23,38 +26,41 @@
<tr>
<td valign="top">file</td>
<td valign="top">The file to delete.</td>
- <td align="center" valign="middle" rowspan="2">at least one of the
two</td>
+ <td align="center" valign="middle" rowspan="2">At least one of the two,
unless a <code><fileset></code> is specified.</td>
</tr>
<tr>
<td valign="top">dir</td>
- <td valign="top">The directory to delete files from.</td>
+ <td valign="top">The directory to delete, including all its files and
subdirectories.</td>
</tr>
<tr>
<td valign="top">verbose</td>
- <td valign="top">Show name of each deleted file
("true"/"false").
+ <td valign="top">Show the name of each deleted file
("true"/"false").
Default is "false" when omitted.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">quiet</td>
<td valign="top">If the file does not exist, do not display a diagnostic
- message or modify the exit status to reflect an error (unless Ant
- has been invoked with the -verbose or -debug switches).
- This means that if a file or directory cannot be deleted,
- then no error is reported. This setting emulates the
- -f option to the Unix "rm" command.
- ("true"/"false").
- Default is "false" meaning things are "noisy".</td>
- Setting this to true, implies setting failonerror to false.
+ message (unless Ant
+ has been invoked with the <code>‑verbose</code> or
+ <code>‑debug</code> switches) or modify the exit status to
+ reflect an error.
+ When set to "true", if a file or directory cannot be deleted,
+ no error is reported. This setting emulates the
+ <code>-f</code> option to the Unix <em>rm</em> command.
+ Default is "false".
+ Setting this to "true" implies setting
+ <code>failonerror</code> to "false".
+ </td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">failonerror</td>
<td valign="top">
- This flag (which is only of relevance if 'quiet' is false),
- controls whether an error -such as a failure to delete a file-
- stops the build task, or is merely reported to the screen.
- The default is "true"
+ Controls whether an error (such as a failure to delete a file)
+ stops the build or is merely reported to the screen.
+ Only relevant if <code>quiet</code> is "false".
+ Default is "true".
</td>
<td align="center" valign="top">No</td>
</tr>
@@ -64,37 +70,6 @@
using filesets. Default is "false".</td>
<td align="center" valign="top">No</td>
</tr>
- <tr>
- <td valign="top">includes</td>
- <td valign="top"><i>Deprecated.</i> Comma separated list of patterns of
files that must be
- deleted. All files are in the current directory
- and any sub-directories are deleted when omitted.</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">includesfile</td>
- <td valign="top"><i>Deprecated.</i> The name of a file. Each line of
this file is
- taken to be an include pattern</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">excludes</td>
- <td valign="top"><i>Deprecated.</i> Comma separated list of patterns of
files that must be
- excluded from the deletion list. No files (except default excludes)
are excluded when omitted.</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">excludesfile</td>
- <td valign="top"><i>Deprecated.</i> The name of a file. Each line of
this file is
- taken to be an exclude pattern</td>
- <td valign="top" align="center">No</td>
- </tr>
- <tr>
- <td valign="top">defaultexcludes</td>
- <td valign="top"><i>Deprecated.</i> Indicates whether default excludes
should be used or not
- ("yes"/"no"). Default excludes are used when
omitted.</td>
- <td valign="top" align="center">No</td>
- </tr>
</table>
<h3>Examples</h3>
<pre> <delete file="/lib/ant.jar"/></pre>
@@ -106,8 +81,8 @@
<fileset dir="." includes="**/*.bak"/>
</delete>
</pre>
-<p>deletes all files with the extension "<code>.bak</code>" from
the current directory
-and any sub-directories.</p>
+<p>deletes all files with the extension <code>.bak</code> from the current
directory
+and any subdirectories.</p>
<pre> <delete includeEmptyDirs="true" >
<fileset dir="build" />
</delete>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
