rubys 01/02/13 05:25:55
Modified: docs/manual/CoreTasks Tag: ANT_13_BRANCH tar.html
Log:
Update docs for tar task before I get a conflict on merge, like I
did on the code. Thanks Connor. ;-)
----------------------------------------------------------------------
Revision Changes Path
No revision
No revision
1.1.2.5 +23 -13 jakarta-ant/docs/manual/CoreTasks/tar.html
Index: tar.html
===================================================================
RCS file: /home/cvs/jakarta-ant/docs/manual/CoreTasks/tar.html,v
retrieving revision 1.1.2.4
retrieving revision 1.1.2.5
diff -u -r1.1.2.4 -r1.1.2.5
--- tar.html 2001/02/12 13:29:49 1.1.2.4
+++ tar.html 2001/02/13 13:25:55 1.1.2.5
@@ -22,16 +22,24 @@
to be applied to the tar entries. This is useful, for example, when
preparing archives for
Unix systems where some files need to have execute permission.</p>
-<p>The POSIX tar standard does not support path lengths greater than 100
characters. The
-behaviour of the tar task when it encounters such paths is controlled by the
<i>longfile</i>
-attribute. If this attribute is not present, the tar task will throw an
exception upon encountering
-a long path. If the longfile attribute is set to <code>truncate</code>, any
long paths will be
-truncated to the 100 character maximum length prior to adding to the
archive. This ensures that
-the file will be in the archive and that the archive can be untarred by any
compliant version of
-tar. If the loss of path information is not acceptable, and it rarely is,
longfile may be set to
-the value <code>gnu</code>. The tar task will then produce a GNU tar file
which can have
-arbitrary length paths. Note however, that the resulting archive will only
be able to be untarred
-with GNU tar.</p>
+<p>Early versions of tar did not support path lengths greater than 100
+characters. Modern versions of tar do so, but in incompatible ways.
+The behaviour of the tar task when it encounters such paths is
+controlled by the <i>longfile</i> attribute.
+If the longfile attribute is set to <code>fail</code>, any long paths will
+cause the tar task to fail. If the longfile attribute is set to
+<code>truncate</code>, any long paths will be truncated to the 100 character
+maximum length prior to adding to the archive. If the value of the longfile
+attribute is set to <code>omit</code> then files containing long paths will
be
+omitted from the archive. Either option ensures that the archive can be
+untarred by any compliant version of tar. If the loss of path or file
+information is not acceptable, and it rarely is, longfile may be set to the
+value <code>gnu</code>. The tar task will then produce a GNU tar file which
+can have arbitrary length paths. Note however, that the resulting archive
will
+only be able to be untarred with GNU tar. The default for the longfile
+attribute is <code>warn</code> which behaves just like the gnu option except
+that it produces a warning for each file path encountered that does not
match
+the limit.</p>
<p>Note that this task does not perform compression. You might want to use
the
<a href="gzip.html">GZip</a> task to prepare a .tar.gz package.</p>
@@ -55,9 +63,11 @@
</tr>
<tr>
<td valign="top">longfile</td>
- <td valign="top">Controls how long paths are handled. Allowable
- values are "gnu" and "truncate"</td>
- <td align="center" valign="top">No</td>
+ <td valign="top">Determines how long files (>100 chars) are to be
+ handled. Allowable values are "truncate",
"fail",
+ "warn", "omil" and "gnu". Default is
+ "warn".
+ <td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">includes</td>
