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-03-28 22:57:20 +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-03-31 01:17:57 +00:00
|
|
|
<title>ChangeLog Task</title>
|
2002-03-28 22:57:20 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
2002-04-03 09:11:09 +00:00
|
|
|
<h2><a name="changelog">CvsChangeLog</a></h2>
|
2002-03-28 22:57:20 +00:00
|
|
|
<h3>Description</h3>
|
2002-03-31 01:17:57 +00:00
|
|
|
<p>Generates an XML-formatted report file of the change logs recorded in a
|
2005-10-01 11:20:08 +00:00
|
|
|
<a href="http://www.nongnu.org/cvs/" target="_top">CVS</a> repository. </p>
|
2008-10-16 12:22:05 +00:00
|
|
|
<p><b>Important:</b> 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>
|
2003-04-22 15:31:03 +00:00
|
|
|
from the command line in the target directory in which you are working.
|
2008-10-16 12:22:05 +00:00
|
|
|
Also note that this task assumes that the cvs exceutable is compatible
|
|
|
|
|
with the Unix version from cvshome.org, 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-03-28 22:57:20 +00:00
|
|
|
<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>
|
2004-01-28 22:47:14 +00:00
|
|
|
<tr>
|
2005-04-29 18:58:16 +00:00
|
|
|
<td colspan="3">Attributes from parent Cvs task which are meaningful here<br>
|
2004-01-28 22:47:14 +00:00
|
|
|
Since ant 1.6.1</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">cvsRoot</td>
|
|
|
|
|
<td valign="top">the <code>CVSROOT</code> variable.</td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">cvsRsh</td>
|
|
|
|
|
<td valign="top">the <code>CVS_RSH</code> variable.</td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">package</td>
|
2008-10-16 14:39:24 +00:00
|
|
|
<td valign="top">the package/module to check out. <b>Note:</b>
|
|
|
|
|
multiple attributes can be split using spaces. Use a nested
|
|
|
|
|
<module> element if you want to specify a module with
|
|
|
|
|
spaces in its name.</td>
|
2004-01-28 22:47:14 +00:00
|
|
|
<td align="center" valign="top">No</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">passfile</td>
|
|
|
|
|
<td valign="top">Password file to read passwords from.</td>
|
2004-11-19 09:07:12 +00:00
|
|
|
<td align="center" valign="top">No, default file <code>~/.cvspass</code>.</td>
|
2004-01-28 22:47:14 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">failonerror</td>
|
|
|
|
|
<td valign="top">Stop the build process if the command exits with a
|
|
|
|
|
return code other than <code>0</code>. Defaults to false</td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">tag</td>
|
|
|
|
|
<td valign="top">query the changelog for a specific branch.</td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td colspan="3">Specific attributes</td>
|
|
|
|
|
</tr>
|
2002-03-28 22:57:20 +00:00
|
|
|
<tr>
|
2002-03-30 23:51:33 +00:00
|
|
|
<td valign="top">dir</td>
|
2002-03-31 01:17:57 +00:00
|
|
|
<td valign="top">The directory from which to run the CVS <em>log</em>
|
|
|
|
|
command.</td>
|
|
|
|
|
<td align="center" valign="top">No; defaults to ${basedir}.</td>
|
2002-03-28 22:57:20 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">destfile</td>
|
2002-03-31 01:17:57 +00:00
|
|
|
<td valign="top">The file in which to write the change log report.</td>
|
2002-03-28 22:57:20 +00:00
|
|
|
<td align="center" valign="top">Yes</td>
|
|
|
|
|
</tr>
|
2002-03-28 23:37:19 +00:00
|
|
|
<tr>
|
|
|
|
|
<td valign="top">usersfile</td>
|
2002-03-31 01:17:57 +00:00
|
|
|
<td valign="top">Property file that contains name-value pairs mapping
|
|
|
|
|
user IDs and names that should be used in the report in place of
|
|
|
|
|
the user ID.</td>
|
2002-03-28 23:37:19 +00:00
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
2002-03-28 23:11:06 +00:00
|
|
|
<tr>
|
|
|
|
|
<td valign="top">daysinpast</td>
|
2002-03-31 01:17:57 +00:00
|
|
|
<td valign="top">Sets the number of days into the past for which the
|
|
|
|
|
change log information should be retrieved.</td>
|
2002-03-28 23:11:06 +00:00
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
2002-03-28 22:57:20 +00:00
|
|
|
<tr>
|
|
|
|
|
<td valign="top">start</td>
|
2002-03-31 01:17:57 +00:00
|
|
|
<td valign="top">The earliest date from which change logs are to be
|
|
|
|
|
included in the report.</td>
|
2002-03-28 22:57:20 +00:00
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">end</td>
|
2002-03-31 01:17:57 +00:00
|
|
|
<td valign="top">The latest date to which change logs are to be
|
|
|
|
|
included in the report.</td>
|
2002-03-28 22:57:20 +00:00
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
2008-10-17 15:16:28 +00:00
|
|
|
<tr>
|
|
|
|
|
<td valign="top">remote</td>
|
|
|
|
|
<td valign="top">If set to true, works against the repository
|
|
|
|
|
(using rlog) without a working copy. Default is
|
|
|
|
|
false. <em>Since Ant 1.8.0</em></td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
2008-10-17 15:49:19 +00:00
|
|
|
<tr>
|
|
|
|
|
<td valign="top">startTag</td>
|
|
|
|
|
<td valign="top">The start of a tag range. If endTag is also
|
|
|
|
|
specified, they must both be on the same branch. If endTag is not
|
|
|
|
|
specified, the end of the range will be the latest on the same
|
|
|
|
|
branch on which startTag lives. <em>Since Ant 1.8.0</em></td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">endTag</td>
|
|
|
|
|
<td valign="top">The end of a tag range. If startTag is also
|
|
|
|
|
specified, they must both be on the same branch. If startTag is
|
|
|
|
|
not specified, the start of the range will be the top of the
|
|
|
|
|
branch on which endTag lives.</td> included in the report.
|
|
|
|
|
<em>Since Ant 1.8.0</em></td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
2002-03-28 22:57:20 +00:00
|
|
|
</table>
|
|
|
|
|
|
2002-03-29 01:55:59 +00:00
|
|
|
<h3>Parameters specified as nested elements</h3>
|
2002-03-28 22:57:20 +00:00
|
|
|
<h4><a name="user">user</a></h4>
|
2002-03-31 01:17:57 +00:00
|
|
|
<p>The nested <code><user></code> element allows you to specify a
|
|
|
|
|
mapping between a user ID as it appears on the CVS server and a name to
|
|
|
|
|
include in the formatted report.
|
|
|
|
|
Anytime the specified user ID has made a change in the repository, the
|
|
|
|
|
<code><author></code> tag in the report file will include
|
|
|
|
|
the name specified in <code>displayname</code> rather than the user ID.
|
|
|
|
|
</p>
|
2002-03-28 22:57:20 +00:00
|
|
|
|
|
|
|
|
<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">displayname</td>
|
2002-03-31 01:17:57 +00:00
|
|
|
<td valign="top">The name to be used in the CVS change log report.</td>
|
2002-03-28 22:57:20 +00:00
|
|
|
<td valign="top" align="center">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">userid</td>
|
2002-03-31 01:17:57 +00:00
|
|
|
<td valign="top">The userid of the person as it exists on the CVS server.
|
|
|
|
|
</td>
|
2002-03-28 22:57:20 +00:00
|
|
|
<td valign="top" align="center">Yes</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
|
2008-10-16 14:39:24 +00:00
|
|
|
<h4>module</h4>
|
|
|
|
|
|
|
|
|
|
<p>Specifies a package/module to work on, unlike the package attribute
|
|
|
|
|
modules specified using this attribute can contain spaces in their
|
|
|
|
|
name.</p>
|
|
|
|
|
|
|
|
|
|
<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">name</td>
|
|
|
|
|
<td valign="top">The module's/package's name.</td>
|
|
|
|
|
<td align="center" valign="top">Yes.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
2002-03-28 22:57:20 +00:00
|
|
|
|
|
|
|
|
<h3>Examples</h3>
|
2002-04-03 09:11:09 +00:00
|
|
|
<pre> <cvschangelog dir="dve/network"
|
|
|
|
|
destfile="changelog.xml"
|
2002-03-28 22:57:20 +00:00
|
|
|
/></pre>
|
|
|
|
|
|
2002-03-31 01:17:57 +00:00
|
|
|
<p>Generates a change log report for all the changes that have been made
|
|
|
|
|
under the <code>dve/network</code> directory.
|
|
|
|
|
It writes these changes into the file <code>changelog.xml</code>.</p>
|
2002-03-28 22:57:20 +00:00
|
|
|
|
2002-04-03 09:11:09 +00:00
|
|
|
<pre> <cvschangelog dir="dve/network"
|
|
|
|
|
destfile="changelog.xml"
|
|
|
|
|
daysinpast="10"
|
2002-03-28 23:11:06 +00:00
|
|
|
/></pre>
|
|
|
|
|
|
2002-03-31 01:17:57 +00:00
|
|
|
<p>Generates a change log report for any changes that were made
|
|
|
|
|
under the <code>dve/network</code> directory in the past 10 days.
|
|
|
|
|
It writes these changes into the file <code>changelog.xml</code>.</p>
|
2002-03-28 23:11:06 +00:00
|
|
|
|
2002-04-03 09:11:09 +00:00
|
|
|
<pre> <cvschangelog dir="dve/network"
|
|
|
|
|
destfile="changelog.xml"
|
|
|
|
|
start="20 Feb 2002"
|
|
|
|
|
end="20 Mar 2002"
|
2002-03-28 22:57:20 +00:00
|
|
|
/></pre>
|
|
|
|
|
|
2002-03-31 01:17:57 +00:00
|
|
|
<p>Generates a change log report for any changes that were made
|
|
|
|
|
between February 20, 2002 and March 20, 2002
|
|
|
|
|
under the <code>dve/network</code> directory.
|
|
|
|
|
It writes these changes into the file <code>changelog.xml</code>.</p>
|
2002-03-28 22:57:20 +00:00
|
|
|
|
2002-04-03 09:11:09 +00:00
|
|
|
<pre> <cvschangelog dir="dve/network"
|
|
|
|
|
destfile="changelog.xml"
|
|
|
|
|
start="20 Feb 2002"
|
2002-03-28 22:57:20 +00:00
|
|
|
/></pre>
|
|
|
|
|
|
2002-03-31 01:17:57 +00:00
|
|
|
<p>Generates a change log report for any changes that were made
|
|
|
|
|
after February 20, 2002 under the <code>dve/network</code> directory.
|
|
|
|
|
It writes these changes into the file <code>changelog.xml</code>.</p>
|
2002-03-28 22:57:20 +00:00
|
|
|
|
2002-04-03 09:11:09 +00:00
|
|
|
<pre> <cvschangelog dir="dve/network"
|
2003-04-21 07:07:08 +00:00
|
|
|
destfile="changelog.xml">
|
2002-03-28 22:57:20 +00:00
|
|
|
<user displayname="Peter Donald" userid="donaldp"/>
|
2002-04-03 09:11:09 +00:00
|
|
|
</cvschangelog></pre>
|
2002-03-28 22:57:20 +00:00
|
|
|
|
2002-03-31 01:17:57 +00:00
|
|
|
<p>Generates a change log report for all the changes that were made
|
|
|
|
|
under the <code>dve/network</code> directory, substituting the name
|
|
|
|
|
"Peter Donald" in the <code><author></code> tags
|
|
|
|
|
anytime it encounters a change made by the user ID "donaldp".
|
|
|
|
|
It writes these changes into the file <code>changelog.xml</code>.</p>
|
2002-03-28 22:57:20 +00:00
|
|
|
|
2004-01-28 22:47:14 +00:00
|
|
|
<p>Generates a change log report on the <code>ANT_16_BRANCH</code>.</p>
|
|
|
|
|
<pre>
|
|
|
|
|
<cvschangelog dir="c:/dev/asf/ant.head" passfile="c:/home/myself/.cvspass"
|
2004-11-19 09:07:12 +00:00
|
|
|
destfile="changelogant.xml" tag="ANT_16_BRANCH"/>
|
2004-01-28 22:47:14 +00:00
|
|
|
</pre>
|
2002-04-06 01:32:22 +00:00
|
|
|
<h4>Generate Report</h4>
|
|
|
|
|
<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>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
<style in="changelog.xml"
|
|
|
|
|
out="changelog.html"
|
|
|
|
|
style="${ant.home}/etc/changelog.xsl">
|
|
|
|
|
<param name="title" expression="Ant ChangeLog"/>
|
2003-02-19 09:23:20 +00:00
|
|
|
<param name="module" expression="ant"/>
|
2002-04-06 01:32:22 +00:00
|
|
|
<param name="cvsweb" expression="http://cvs.apache.org/viewcvs/"/>
|
|
|
|
|
</style>
|
|
|
|
|
</pre>
|
|
|
|
|
|
2002-03-28 23:01:06 +00:00
|
|
|
<h4>Sample Output</h4>
|
|
|
|
|
<pre>
|
|
|
|
|
<changelog>
|
2002-03-31 01:17:57 +00:00
|
|
|
<entry>
|
|
|
|
|
<date>2002-03-06</date>
|
|
|
|
|
<time>12:00</time>
|
|
|
|
|
<author>Peter Donald</author>
|
|
|
|
|
<file>
|
|
|
|
|
<name>org/apache/myrmidon/build/AntlibDescriptorTask.java</name>
|
|
|
|
|
<revision>1.3</revision>
|
|
|
|
|
<prevrevision>1.2</prevrevision>
|
|
|
|
|
</file>
|
2004-11-16 08:12:35 +00:00
|
|
|
<msg><![CDATA[Use URLs directly rather than go via a File.
|
2002-03-28 23:01:06 +00:00
|
|
|
|
2004-11-16 08:12:35 +00:00
|
|
|
This allows templates to be stored inside jar]]></msg>
|
2002-03-31 01:17:57 +00:00
|
|
|
</entry>
|
2002-03-28 23:01:06 +00:00
|
|
|
</changelog>
|
|
|
|
|
</pre>
|
|
|
|
|
|
2006-09-11 20:22:51 +00:00
|
|
|
|
2002-03-28 22:57:20 +00:00
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
|
