2002-03-28 22:57:20 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
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
|
2002-03-28 22:57:20 +00:00
|
|
|
<a href="http://www.cvshome.org/" target="_top">CVS</a> repository. </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>
|
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>
|
|
|
|
|
</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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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"
|
|
|
|
|
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
|
|
|
|
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>
|
|
|
|
|
<msg><![CDATA[Use URLs directly rather than go via a FIle.
|
2002-03-28 23:01:06 +00:00
|
|
|
|
|
|
|
|
This allows temp[lates 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>
|
|
|
|
|
|
2002-03-28 23:59:20 +00:00
|
|
|
<hr><p align="center">Copyright © 2002 Apache Software Foundation. All rights
|
2002-03-28 22:57:20 +00:00
|
|
|
Reserved.</p>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
|
