View All Attachments for Bug 13371

Attachment #3378
The source code	text/plain	2002-10-07 17:23:51 UTC	14.39 KB	no flags	Details

Attachment #3379
The manuel page	text/html	2002-10-07 17:24:25 UTC	7.37 KB	no flags	Details

<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<title>CvsExportDiff Task</title>
</head>

<body>

<h2><a name="CvsExportDiff">CvsExportDiff</a></h2>
<h3>Description</h3>
<p>Exports from CVS all the files changed within a tag or date range.
This is useful in producing delta or patch releases of a project managed by <a href="http://www.cvshome.org/" target="_top">CVS</a>.
You can combine this with the <a href="tar.html">Tar</a> or <a href="zip.html">Zip</a> tasks - an example is shown below.</p>
<p>This tasks uses the <a href="cvstagdiff.html">CvsTagDiff</a> task to generate the list of files that should be exported
and the <a href="cvs.html">Cvs</a> task to <i>checkout</i> the particular version of the files and makes
a clean copy (with no CVS directories) in a destination directory.</p>

<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
  <tr>
    <td valign="top"><b>Attribute</b></td>
    <td valign="top"><b>Description</b></td>
    <td align="center" valign="top"><b>Required</b></td>
  </tr>
  <tr>
    <td valign="top">cvsRoot</td>
    <td valign="top">the CVSROOT variable.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">cvsRsh</td>
    <td valign="top">the CVS_RSH variable.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">dest</td>
    <td valign="top">the directory where the exported files should be placed.</td>
    <td align="center" valign="top">Yes</td>
  </tr>
  <tr>
    <td valign="top">workingDirectory</td>
    <td valign="top">A temporary directory that will be used for the checkout</td>
    <td align="center" valign="top">Yes</td>
  </tr>
  <tr>
    <td valign="top">package</td>
    <td valign="top">the package/module to export.</td>
    <td align="center" valign="top">No</td>
  </tr>
  <tr>
    <td valign="top">startTag</td>
    <td valign="top">The earliest tag from which files are to be
     included in the export.</td>
    <td align="center" valign="top" rowspan="2">exactly one of the two.</td>
  </tr>
  <tr>
    <td valign="top">startDate</td>
    <td valign="top">The earliest date from which files are to be
     included in the export.</td>
  </tr>
  <tr>
    <td valign="top">endTag</td>
    <td valign="top">The latest tag from which files are to be
     included in the export.</td>
    <td align="center" valign="top" rowspan="2">exactly one of the two.</td>
  </tr>
  <tr>
    <td valign="top">endDate</td>
    <td valign="top">The latest date from which files are to be
     included in the export.</td>
  </tr>

  
  <tr>
    <td valign="top">compression</td>
    <td valign="top"><code>true</code> or <code>false</code> - if set
    to true, this is the same as compressionlevel=&quot;3&quot;</td>
    <td align="center" valign="top">No. Defaults to false.</td>
  </tr>
  <tr>
    <td valign="top">compressionlevel</td>
    <td valign="top">A number between 1 and 9 (corresponding to
    possible values for CVS&apos; <code>-z#</code> argument). Any
    other value is treated as compression=&quot;false&quot;</td>
    <td align="center" valign="top">No. Defaults to no compression.</td>
  </tr>
  <tr>
    <td valign="top">port</td>
    <td valign="top">Port used by CVS to communicate with the server.</td>
    <td align="center" valign="top">No, default port 2401.</td>
  </tr>
  <tr>
    <td valign="top">quiet</td>
    <td valign="top">Suppress informational messages.</td>
    <td align="center" valign="top">No, default &quot;false&quot;</td>
  </tr>
  <tr>
    <td valign="top">passfile</td>
    <td valign="top">Password file to read passwords from.</td>
    <td align="center" valign="top">No, default file ~/.cvspass.</td>
  </tr>
  <tr>
    <td valign="top">failonerror</td>
    <td valign="top">Stop the build process if the command exits with a
      return code other than 0. Defaults to false</td>
    <td align="center" valign="top">No</td>
  </tr>
</table>


<h3>Examples</h3>
<pre>  &lt;cvsexportdiff cvsRoot=&quot;:pserver:anoncvs@cvs.apache.org:/home/cvspublic&quot;
                package=&quot;jakarta-ant&quot;
                startTag=&quot;ANT_14&quot;
                endTag=&quot;ANT_141&quot;
                dest=&quot;/my/buildarea&quot;
                workingDirectory=&quot;/tmp/checkoutarea&quot;
  /&gt;</pre>

<p>Determines all files that have been changed
in the <code>jakarta-ant</code> module between the tags <code>ANT_14</code> and <code>ANT_141</code>. 
The version of the files tagged with <code>ANT_141</code> are exported to the directory <code>/my/buildarea</code>.</p>

<pre>  &lt;cvsexportdiff
                package=&quot;jakarta-ant&quot;
                startDate=&quot;2002-01-01&quot;
                endDate=&quot;2002-31-01&quot;
                dest=&quot;/my/buildarea&quot;
                workingDirectory=&quot;/tmp/checkoutarea&quot;
  /&gt;</pre>

<p>Determines all files that have been changed
in the <code>jakarta-ant</code> module in january 2002. In this example <code>cvsRoot</code>
has not been set. The current <code>cvsRoot</code> will be used (assuming the build is started
from a folder stored in <code>cvs</code>.
The latest January version of each of the identified files are exported to the directory <code>/my/buildarea</code>.</p>

<pre>&lt;project name="zammo" default="tar-delta" basedir="."&gt;
    &lt;property name="tar-filename" value="build_20020915_01.tar" /&gt;
    &lt;property name="startTag" value="Release2002Sep13" /&gt;
    &lt;property name="endTag" value="HEAD" /&gt;

    &lt;property name="tars" value="../tars" /&gt;
    &lt;property name="temp" value="../tmp" /&gt;
    &lt;property name="tarbuild" value="../tarbuild" /&gt;

    &lt;target name="tar-delta"&gt;
        &lt;delete dir="${tarbuild}" quiet="true" /&gt;
        &lt;cvsexportdiff cvsRoot=":pserver:anoncvs@mycvsserver.org:/zammo"
            package="phase2/htdocs"
            startTag="${startTag}"
            endTag="${endTag}"
            dest="${tarbuild}"
            workingDirectory="${temp}"
            failOnError="true"
        /&gt;
        &lt;mkdir dir="${tars}" /&gt;
        &lt;tar
            tarfile="${tars}/${tar-filename}"
            basedir="${tarbuild}/phase2"
            longfile="warn"
        &gt;
            &lt;patternset&gt;
                &lt;exclude name="**/cgi-bin/**" /&gt;
                &lt;exclude name="**/!*" /&gt;
                &lt;exclude name="**/pspbrwse.jbf" /&gt;
                &lt;exclude name="**/Thumbs.db" /&gt;
            &lt;/patternset&gt;
        &lt;/tar&gt;
    &lt;/target&gt;
&lt;/project&gt;</pre>

<p>For the <i>zammo</i> project export all the changed files since tag <code>Release2002Sep13</code> 
(the <code>HEAD</code> means <i>latest</i>) 
to a directory symbolically idenitified by the <code>tarbuild</code> property.
Note that the <code>tarbuild</code> directory is cleared first to ensure previous exports are not present there 
(you may or may not want this behaviour).
Then run the <code>tar</code> task on these exported files, omitting certain files; 
specifying a slightly different basedir in order to get a the tar file to contain the right amount of 
'path' for the the process that will use this tar.</p>
<p>

    
<hr><p align="center">Copyright &copy; 2002 Apache Software Foundation. All rights
Reserved.</p>

</body>
</html>