2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
-->
|
2002-04-15 09:53:24 +00:00
|
|
|
<html>
|
|
|
|
<head>
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2005-04-29 18:58:16 +00:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2002-04-15 09:53:24 +00:00
|
|
|
<title>CvsTagDiff Task</title>
|
|
|
|
</head>
|
|
|
|
<body>
|
2018-01-22 23:52:21 +01:00
|
|
|
<h2 id="cvstagdiff">CvsTagDiff</h2>
|
2002-04-15 09:53:24 +00:00
|
|
|
<h3>Description</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Generates an XML-formatted report file of the changes between two tags or dates recorded in
|
|
|
|
a <a href="https://www.nongnu.org/cvs/" target="_top">CVS</a> repository.</p>
|
|
|
|
<p><strong>Important</strong>: This task needs <code>cvs</code> on the path. If it isn't, you will
|
|
|
|
get an error (such as error <code>2</code> on Windows). If <code><cvs></code> doesn't work,
|
|
|
|
try to execute <code>cvs.exe</code> from the command line in the target directory in which you are
|
|
|
|
working. Also note that this task assumes that the cvs executable is compatible with the Unix
|
|
|
|
version, this is not completely true for certain other CVS clients—like CVSNT for
|
|
|
|
example—and some operation may fail when using such an incompatible client.</p>
|
2002-04-15 09:53:24 +00:00
|
|
|
<h3>Parameters</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2002-04-15 09:53:24 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<th>Attribute</th>
|
|
|
|
<th>Description</th>
|
|
|
|
<th>Required</th>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>startTag</td>
|
|
|
|
<td>The earliest tag from which diffs are to be included in the report.</td>
|
|
|
|
<td rowspan="2">Exactly one of the two</td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>startDate</td>
|
|
|
|
<td class="left">The earliest date from which diffs are to be included in the
|
|
|
|
report.<br/>Accepts all formats accepted by the <code>cvs</code> command for <code>-D
|
|
|
|
date_spec</code> arguments.</td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>endTag</td>
|
|
|
|
<td>The latest tag from which diffs are to be included in the report.</td>
|
|
|
|
<td rowspan="2">Exactly one of the two</td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>endDate</td>
|
|
|
|
<td class="left">The latest date from which diffs are to be included in the report.<br/>Accepts
|
|
|
|
all formats accepted by the <code>cvs</code> command for <code>-D date_spec</code>
|
|
|
|
arguments.</td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>destfile</td>
|
|
|
|
<td>The file in which to write the diff report.</td>
|
|
|
|
<td>Yes</td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
2008-10-16 13:42:30 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>ignoreRemoved</td>
|
|
|
|
<td>When set to <q>true</q>, the report will not include any removed files. <em>Since Apache
|
|
|
|
Ant 1.8.0</em></td>
|
|
|
|
<td>No; defaults to <q>false</q></td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</table>
|
|
|
|
|
|
|
|
<h3>Parameters inherited from the <code>cvs</code> task</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2002-04-15 09:53:24 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<th>Attribute</th>
|
|
|
|
<th>Description</th>
|
|
|
|
<th>Required</th>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>compression</td>
|
|
|
|
<td><q>true</q> (equivalent to <q>3</q>), <q>false</q>, or a number between <q>1</q>
|
|
|
|
and <q>9</q> (corresponding to possible values for CVS <code>-z#</code> argument). Any other
|
|
|
|
value is treated as <q>false</q></td>
|
|
|
|
<td>No; defaults to no compression</td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>cvsRoot</td>
|
|
|
|
<td>the <code>CVSROOT</code> variable.</td>
|
|
|
|
<td>No</td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>cvsRsh</td>
|
|
|
|
<td>the <code>CVS_RSH</code> variable.</td>
|
|
|
|
<td>No</td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>package</td>
|
|
|
|
<td>the package/module to analyze.<br/><em>Since Ant 1.6</em> multiple packages separated by
|
|
|
|
spaces are possible. aliases corresponding to different modules are also possible. Use a
|
|
|
|
nested <code><module></code> element if you want to specify a module with spaces in its
|
|
|
|
name.</td>
|
|
|
|
<td>No</td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>quiet</td>
|
|
|
|
<td>suppress informational messages.</td>
|
|
|
|
<td>No; default <q>false</q></td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>port</td>
|
|
|
|
<td>Port used by CVS to communicate with the server.</td>
|
|
|
|
<td>No; default <q>2401</q></td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>passfile</td>
|
|
|
|
<td>Password file to read passwords from.</td>
|
|
|
|
<td>No; default <q>~/.cvspass</q></td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>failonerror</td>
|
2018-03-02 08:23:45 +01:00
|
|
|
<td>Stop the build process if the command exits with a return code other than <q>0</q>.</td>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>No; defaults to <q>false</q></td>
|
2002-04-15 09:53:24 +00:00
|
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
2008-10-16 15:29:42 +00:00
|
|
|
<h3>Parameters specified as nested elements</h3>
|
2008-10-16 14:39:24 +00:00
|
|
|
|
|
|
|
<h4>module</h4>
|
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Specifies a package/module to work on, unlike the package attribute modules specified using this
|
|
|
|
attribute can contain spaces in their name.</p>
|
2008-10-16 14:39:24 +00:00
|
|
|
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2008-10-16 14:39:24 +00:00
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<th>Attribute</th>
|
|
|
|
<th>Description</th>
|
|
|
|
<th>Required</th>
|
2008-10-16 14:39:24 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>name</td>
|
|
|
|
<td>Name of the module/package.</td>
|
|
|
|
<td>Yes</td>
|
2008-10-16 14:39:24 +00:00
|
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
2002-04-15 09:53:24 +00:00
|
|
|
<h3>Examples</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<pre>
|
|
|
|
<cvstagdiff cvsRoot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic"
|
|
|
|
destfile="tagdiff.xml"
|
|
|
|
package="ant"
|
|
|
|
startTag="ANT_14"
|
|
|
|
endTag="ANT_141"/></pre>
|
|
|
|
|
|
|
|
<p>Generates a <code>tagdiff</code> report for all the changes that have been made in
|
|
|
|
the <code>ant</code> module between the tags <samp>ANT_14</samp> and <samp>ANT_141</samp>. It
|
|
|
|
writes these changes into the file <samp>tagdiff.xml</samp>.</p>
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
<cvstagdiff destfile="tagdiff.xml"
|
|
|
|
package="ant"
|
|
|
|
startDate="2002-01-01"
|
|
|
|
endDate="2002-31-01"/></pre>
|
|
|
|
|
|
|
|
<p>Generates a <code>tagdiff</code> report for all the changes that have been made in
|
|
|
|
the <samp>ant</samp> module in January 2002. In this example <var>cvsRoot</var> has not been
|
|
|
|
set. The current <var>cvsRoot</var> will be used (assuming the build is started from a folder stored
|
|
|
|
in <samp>cvs</samp>. It writes these changes into the file <samp>tagdiff.xml</samp>.</p>
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
<cvstagdiff destfile="tagdiff.xml"
|
|
|
|
package="ant jakarta-gump"
|
|
|
|
startDate="2003-01-01"
|
|
|
|
endDate="2003-31-01"/></pre>
|
|
|
|
|
|
|
|
<p>Generates a <code>tagdiff</code> report for all the changes that have been made in
|
|
|
|
the <samp>ant</samp> and <samp>jakarta-gump</samp> modules in January 2003. In this
|
|
|
|
example <var>cvsRoot</var> has not been set. The current <var>cvsRoot</var> will be used (assuming
|
|
|
|
the build is started from a folder stored in <samp>cvs</samp>. It writes these changes into the
|
|
|
|
file <samp>tagdiff.xml</samp>.</p>
|
2002-09-04 11:51:03 +00:00
|
|
|
|
2002-04-15 09:53:24 +00:00
|
|
|
<h4>Generate Report</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Ant includes a basic XSLT stylesheet that you can use to generate a HTML report based on the xml
|
|
|
|
output. The following example illustrates how to generate a HTML report from the XML report.</p>
|
2002-04-15 09:53:24 +00:00
|
|
|
|
|
|
|
<pre>
|
2018-02-28 07:58:59 +01:00
|
|
|
<style in="tagdiff.xml"
|
|
|
|
out="tagdiff.html"
|
|
|
|
style="${ant.home}/etc/tagdiff.xsl">
|
|
|
|
<param name="title" expression="Ant Diff"/>
|
|
|
|
<param name="module" expression="ant"/>
|
|
|
|
<param name="cvsweb" expression="http://cvs.apache.org/viewcvs/"/>
|
|
|
|
</style></pre>
|
2002-04-15 09:53:24 +00:00
|
|
|
|
2003-11-06 21:15:02 +00:00
|
|
|
<h4>Output</h4>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>The <var>cvsroot</var> and <var>package</var> attributes of the <code>tagdiff</code> element are
|
2018-03-02 08:23:45 +01:00
|
|
|
new in Ant 1.6.<br/> Notes on <code>entry</code> attributes:</p>
|
2018-01-22 23:52:21 +01:00
|
|
|
<table>
|
2018-02-28 07:58:59 +01:00
|
|
|
<tr>
|
|
|
|
<th>Attribute</th>
|
|
|
|
<th>Comment</th>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td>name</td>
|
|
|
|
<td>when reporting on one package, the package name is removed from the output</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td>revision</td>
|
|
|
|
<td>supplied for files which exist at the end of the reporting period</td>
|
|
|
|
</tr>
|
|
|
|
<tr>
|
|
|
|
<td>prevrevision</td>
|
|
|
|
<td>supplied for files which exist at the beginning of the reporting period.<br/>Old CVS servers
|
|
|
|
do not supply it for deleted files. CVS 1.12.2 supplies it.</td>
|
|
|
|
</tr>
|
2003-11-06 21:15:02 +00:00
|
|
|
</table>
|
2002-04-15 09:53:24 +00:00
|
|
|
<pre>
|
|
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
2018-01-22 23:52:21 +01:00
|
|
|
<tagdiff startTag="ANT_14" endTag="ANT_141"
|
2018-02-28 07:58:59 +01:00
|
|
|
cvsroot=":pserver:anoncvs@cvs.apache.org:/home/cvspublic" package="ant">
|
2002-04-15 09:53:24 +00:00
|
|
|
<entry>
|
|
|
|
<file>
|
|
|
|
<name>src/main/org/apache/tools/ant/DirectoryScanner.java</name>
|
|
|
|
<revision>1.15.2.1</revision>
|
|
|
|
<prevrevision>1.15</prevrevision>
|
|
|
|
</file>
|
|
|
|
</entry>
|
|
|
|
</tagdiff>
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
</body>
|
|
|
|
</html>
|