mirror of
https://github.com/apache/ant.git
synced 2025-05-18 14:04:48 +00:00
7262a21ade
PR: Obtained from: Submitted by: Reviewed by: git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@272080 13f79535-47bb-0310-9956-ffa450edef68
145 lines
4.8 KiB
HTML
145 lines
4.8 KiB
HTML
<html>
|
|
|
|
<head>
|
|
<meta http-equiv="Content-Language" content="en-us">
|
|
<title>Changelog Task</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<h2><a name="changelog">Changelog</a></h2>
|
|
<h3>Description</h3>
|
|
<p>Generates an XML report of the changes recorded in a
|
|
<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>
|
|
<td valign="top">basedir</td>
|
|
<td valign="top">the directory from which to run "cvs log".</td>
|
|
<td align="center" valign="top">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">destfile</td>
|
|
<td valign="top">the file in which to write the changelog.</td>
|
|
<td align="center" valign="top">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">usersfile</td>
|
|
<td valign="top">property file that contains mapping between userids and display names.</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">daysinpast</td>
|
|
<td valign="top">sets the start the number of days into the past specified.</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">start</td>
|
|
<td valign="top">the earliest date of changes that are to be included in report.</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">end</td>
|
|
<td valign="top">the latest date of changes that are to be included in report.</td>
|
|
<td align="center" valign="top">No</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h4><a name="user">user</a></h4>
|
|
<p>The changelog task all allows a user element. It maps between a usernid
|
|
as it appears on the cvs server and a display name. Any time the userid
|
|
has made a change in the repository, the author tag in report will use
|
|
the supplied displayname rather than the userid..</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">displayname</td>
|
|
<td valign="top">The name to be displayed in CVS changelog.</td>
|
|
<td valign="top" align="center">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">userid</td>
|
|
<td valign="top">The userid of person as they exist on the CVS server.</td>
|
|
<td valign="top" align="center">Yes</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3>Examples</h3>
|
|
<pre> <changelog basedir="dve/network"
|
|
destfile="changelog.xml"
|
|
/></pre>
|
|
|
|
<p>Generates a changelog for the dve/network directory including all changes that
|
|
ever occured on repository. It writes these changes into the file "changelog.xml".</p>
|
|
|
|
<pre> <changelog basedir="dve/network"
|
|
destfile="changelog.xml"
|
|
days="10"
|
|
/></pre>
|
|
|
|
<p>Generates a changelog for the dve/network directory for the last 10 days. It writes
|
|
these changes into the file "changelog.xml".</p>
|
|
|
|
<pre> <changelog basedir="dve/network"
|
|
destfile="changelog.xml"
|
|
start="20 Feb 2002"
|
|
end="20 Mar 2002"
|
|
/></pre>
|
|
|
|
<p>Generates a changelog for the dve/network directory for all the changes that occured
|
|
between the dates 20th of Feb 2002 and 20th of Mar 2002. It writes these changes into the file "changelog.xml".</p>
|
|
|
|
<pre> <changelog basedir="dve/network"
|
|
destfile="changelog.xml"
|
|
start="20 Feb 2002"
|
|
/></pre>
|
|
|
|
<p>Generates a changelog for the dve/network directory for all the changes that occured
|
|
after the 20th of Feb 2002. It writes these changes into the file "changelog.xml".</p>
|
|
|
|
<pre> <changelog basedir="dve/network"
|
|
destfile="changelog.xml"
|
|
<user displayname="Peter Donald" userid="donaldp"/>
|
|
/></pre>
|
|
|
|
<p>Generates a changelog for the dve/network directory for all the changes that
|
|
ever occured. It will also specify the author name as "Peter Donald"
|
|
any time it encounters the username "donaldp" in the changes.</p>
|
|
|
|
<h4>Sample Output</h4>
|
|
<pre>
|
|
<changelog>
|
|
<entry>
|
|
<date>2002-03-06</date>
|
|
<time>12:00</time>
|
|
<author>donaldp</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.
|
|
|
|
This allows temp[lates to be stored inside jar]]></msg>
|
|
</entry>
|
|
</changelog>
|
|
</pre>
|
|
|
|
<hr><p align="center">Copyright © 2001 Apache Software Foundation. All rights
|
|
Reserved.</p>
|
|
|
|
</body>
|
|
</html>
|
|
|