Browse Source

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
Obtained from:
Submitted by:
Reviewed by:


git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@271159 13f79535-47bb-0310-9956-ffa450edef68
master
Diane Holt 23 years ago
parent
commit
5e16daf1e7
1 changed files with 27 additions and 52 deletions
  1. +27
    -52
      docs/manual/CoreTasks/delete.html

+ 27
- 52
docs/manual/CoreTasks/delete.html View File

@@ -9,10 +9,13 @@


<h2><a name="delete">Delete</a></h2> <h2><a name="delete">Delete</a></h2>
<h3>Description</h3> <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> <h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0"> <table border="1" cellpadding="2" cellspacing="0">
<tr> <tr>
@@ -23,38 +26,41 @@ To remove empty directories, use the <em>includeEmptyDirs</em> atribute.</p>
<tr> <tr>
<td valign="top">file</td> <td valign="top">file</td>
<td valign="top">The file to delete.</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>&lt;fileset&gt;</code> is specified.</td>
</tr> </tr>
<tr> <tr>
<td valign="top">dir</td> <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>
<tr> <tr>
<td valign="top">verbose</td> <td valign="top">verbose</td>
<td valign="top">Show name of each deleted file (&quot;true&quot;/&quot;false&quot;).
<td valign="top">Show the name of each deleted file (&quot;true&quot;/&quot;false&quot;).
Default is &quot;false&quot; when omitted.</td> Default is &quot;false&quot; when omitted.</td>
<td align="center" valign="top">No</td> <td align="center" valign="top">No</td>
</tr> </tr>
<tr> <tr>
<td valign="top">quiet</td> <td valign="top">quiet</td>
<td valign="top">If the file does not exist, do not display a diagnostic <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 &quot;rm&quot; command.
(&quot;true&quot;/&quot;false&quot;).
Default is &quot;false&quot; meaning things are &quot;noisy&quot;.</td>
Setting this to true, implies setting failonerror to false.
message (unless Ant
has been invoked with the <code>&#x2011;verbose</code> or
<code>&#x2011;debug</code> switches) or modify the exit status to
reflect an error.
When set to &quot;true&quot;, 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 &quot;false&quot;.
Setting this to &quot;true&quot; implies setting
<code>failonerror</code> to &quot;false&quot;.
</td>
<td align="center" valign="top">No</td> <td align="center" valign="top">No</td>
</tr> </tr>
<tr> <tr>
<td valign="top">failonerror</td> <td valign="top">failonerror</td>
<td valign="top"> <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 &quot;true&quot;
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 &quot;false&quot;.
Default is &quot;true&quot;.
</td> </td>
<td align="center" valign="top">No</td> <td align="center" valign="top">No</td>
</tr> </tr>
@@ -64,37 +70,6 @@ To remove empty directories, use the <em>includeEmptyDirs</em> atribute.</p>
using filesets. Default is &quot;false&quot;.</td> using filesets. Default is &quot;false&quot;.</td>
<td align="center" valign="top">No</td> <td align="center" valign="top">No</td>
</tr> </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
(&quot;yes&quot;/&quot;no&quot;). Default excludes are used when omitted.</td>
<td valign="top" align="center">No</td>
</tr>
</table> </table>
<h3>Examples</h3> <h3>Examples</h3>
<pre> &lt;delete file=&quot;/lib/ant.jar&quot;/&gt;</pre> <pre> &lt;delete file=&quot;/lib/ant.jar&quot;/&gt;</pre>
@@ -106,8 +81,8 @@ and subdirectories of <code>lib</code>.</p>
&lt;fileset dir=&quot;.&quot; includes=&quot;**/*.bak&quot;/&gt; &lt;fileset dir=&quot;.&quot; includes=&quot;**/*.bak&quot;/&gt;
&lt;/delete&gt; &lt;/delete&gt;
</pre> </pre>
<p>deletes all files with the extension &quot;<code>.bak</code>&quot 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> &lt;delete includeEmptyDirs=&quot;true&quot; &gt; <pre> &lt;delete includeEmptyDirs=&quot;true&quot; &gt;
&lt;fileset dir=&quot;build&quot; /&gt; &lt;fileset dir=&quot;build&quot; /&gt;
&lt;/delete&gt; &lt;/delete&gt;


Loading…
Cancel
Save