Author: jhm
Date: Tue Dec 18 00:41:04 2007
New Revision: 605137
URL: http://svn.apache.org/viewvc?rev=605137&view=rev
Log:
<tar> examples:
- tar: tarfile is deprecated since 1.5
- gzip: zipfile is not deprecated, but use of common name
- fix attribute names (Bug 44082)
Modified:
ant/core/trunk/docs/manual/CoreTasks/tar.html
Modified: ant/core/trunk/docs/manual/CoreTasks/tar.html
URL:
http://svn.apache.org/viewvc/ant/core/trunk/docs/manual/CoreTasks/tar.html?rev=605137&r1=605136&r2=605137&view=diff
==============================================================================
--- ant/core/trunk/docs/manual/CoreTasks/tar.html (original)
+++ ant/core/trunk/docs/manual/CoreTasks/tar.html Tue Dec 18 00:41:04 2007
@@ -71,6 +71,11 @@
</tr>
<tr>
<td valign="top">destfile</td>
+ <td valign="top" rowspan="2">the tar-file to create.</td>
+ <td align="center" valign="top" rowspan="2">Yes</td>
+ </tr>
+ <tr>
+ <td valign="top">destfile</td>
<td valign="top">the tar-file to create.</td>
<td align="center" valign="top">Yes</td>
</tr>
@@ -156,15 +161,16 @@
<h3>Examples</h3>
<pre>
-<tar tarfile="${dist}/manual.tar"
basedir="htdocs/manual"/>
-<gzip zipfile="${dist}/manual.tar.gz"
src="${dist}/manual.tar"/></pre>
+<tar destfile="${dist}/manual.tar"
basedir="htdocs/manual"/>
+<gzip destfile="${dist}/manual.tar.gz"
src="${dist}/manual.tar"/></pre>
<p>tars all files in the <code>htdocs/manual</code> directory into a file
called <code>manual.tar</code>
in the <code>${dist}</code> directory, then applies the gzip task to compress
it.</p>
+
<pre>
<tar destfile="${dist}/manual.tar"
- basedir="htdocs/manual"
- excludes="mydocs/**, **/todo.html"
+ basedir="htdocs/manual"
+ excludes="mydocs/**, **/todo.html"
/></pre>
<p>tars all files in the <code>htdocs/manual</code> directory into a file
called <code>manual.tar</code>
in the <code>${dist}</code> directory. Files in the directory
<code>mydocs</code>,
@@ -183,7 +189,6 @@
<include name="*.html"/>
</tarfileset>
</tar></pre>
-
<p>
Writes the file <code>docs/readme.txt</code> as
<code>/usr/doc/ant/README</code> into the archive. All
@@ -193,10 +198,9 @@
<code>/usr/doc/ant/index.html</code> to the archive.
</p>
-
<pre>
<tar longfile="gnu"
- destfile="${dist.base}/${dist.name}-src.tar" >
+ destfile="${dist.base}/${dist.name}-src.tar">
<tarfileset dir="${dist.name}/.." mode="755"
username="ant" group="ant">
<include name="${dist.name}/bootstrap.sh"/>
<include name="${dist.name}/build.sh"/>
@@ -208,7 +212,6 @@
</tarfileset>
</tar>
</pre>
-
<p>This example shows building a tar which uses the GNU extensions for long
paths and
where some files need to be marked as executable (mode 755)
and the rest are use the default mode (read-write by owner). The first
@@ -228,23 +231,24 @@
of a directory, so <code>${dist.name}</code> is a valid path relative
to <code>${dist.name}/..</code>.</p>
+
<pre>
-<tar dest="release.tar.gz" compress="gzip">
+<tar destfile="release.tar.gz" compression="gzip">
<zipfileset src="release.zip"/>
</tar>
</pre>
-
<p>Re-packages a ZIP archive as a GZip compressed tar archive. If
Unix file permissions have been stored as part of the ZIP file, they
will be retained in the resulting tar archive.</p>
- <p><strong>Note:</strong>
- Please note the tar task creates a tar file, it does not append
- to an existing tar file. The existing tar file is replaced instead.
- As with most tasks in Ant, the task only takes action if the output
- file (the tar file in this case) is older than the input files, or
- if the output file does not exist.
- </p>
+
+<p><strong>Note:</strong>
+ Please note the tar task creates a tar file, it does not append
+ to an existing tar file. The existing tar file is replaced instead.
+ As with most tasks in Ant, the task only takes action if the output
+ file (the tar file in this case) is older than the input files, or
+ if the output file does not exist.
+</p>
</body>
</html>
