Changeset 91

Show
Ignore:
Timestamp:
07/11/06 06:55:48 (2 years ago)
Author:
mrook
Message:

Add some clarifying notes about the basedir attribute in TarTask and ZipTask

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • branches/2.2/docs/phing_guide/book/chapters/appendixes/AppendixC-OptionalTasks.html

    r88 r91  
    850850<h2><a name="TarTask"></a>TarTask</h2> 
    851851<p> The <em>TarTask</em> creates a tarball from a fileset or directory.</p> 
    852 <h3>Example</h3> 
    853 <pre>&lt;tar destfile=&quot;phing.tar&quot; basedir=&quot;.&quot; compression=&quot;gzip&quot;&gt; 
     852 
     853<h3>Examples</h3> 
     854<pre>&lt;tar destfile=&quot;phing.tar&quot; compression=&quot;gzip&quot;&gt; 
    854855 &lt;fileset dir=&quot;.&quot;&gt; 
    855856         &lt;include name=&quot;**/**&quot; /&gt; 
    …… 
    861862the archive.</p> 
    862863 
     864<pre>&lt;tar destfile=&quot;phing.tar&quot; basedir=&quot;.&quot; compression=&quot;gzip&quot;/&gt;</pre> 
     865 
     866<p>The second example uses the basedir attribute to include the contents of that directory (including 
     867subdirectories) in the archive.</p> 
     868 
    863869<h3>Attributes</h3> 
    864870<table> 
    …… 
    898904</table> 
    899905 
    900 <p><b>Important note:</b> files are not replaced if they are already present in the 
     906<p><b>Important note #1:</b> files are not replaced if they are already present in the 
    901907archive.</p> 
     908 
     909<p><b>Important note #2:</b> using basedir and fileset simultaneously can result in 
     910strange contents in the archive.</p> 
    902911 
    903912<h3>Supported Nested Tags</h3> 
    …… 
    959968<h2><a name="ZipTask"></a>ZipTask</h2> 
    960969<p> The <em>ZipTask</em> creates a .zip archive from a fileset or directory.</p> 
     970 
     971<h3>Examples</h3> 
     972<pre>&lt;zip destfile=&quot;phing.zip&quot;&gt; 
     973 &lt;fileset dir=&quot;.&quot;&gt; 
     974         &lt;include name=&quot;**/**&quot; /&gt; 
     975 &lt;/fileset&gt; 
     976&lt;/zip&gt; 
     977</pre> 
     978 
     979<p>The above example uses a fileset to determine which files to include in 
     980the archive.</p> 
     981 
     982<pre>&lt;zip destfile=&quot;phing.zip&quot; basedir=&quot;.&quot;/&gt;</pre> 
     983 
     984<p>The second example uses the basedir attribute to include the contents of that directory (including 
     985subdirectories) in the archive.</p> 
     986 
    961987<h3>Example</h3> 
    962 <pre>&lt;zip destfile=&quot;phing.zip&quot; basedir=&quot;.&quot;/&gt; 
    963 </pre> 
    964988 
    965989<h3>Attributes</h3> 
    …… 
    9921016  </tbody> 
    9931017</table> 
     1018 
     1019<p><b>Important note:</b> using basedir and fileset simultaneously can result in 
     1020strange contents in the archive.</p> 
    9941021 
    9951022<h3>Supported Nested Tags</h3>