wangwei
/
antliscence
forked from youys/ant

<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 &quot;cvs log&quot;.</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>

<h3>Parameters specified as nested elements</h3>
<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>  &lt;changelog basedir=&quot;dve/network&quot;
             destfile=&quot;changelog.xml&quot;
  /&gt;</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 &quot;changelog.xml&quot;.</p>

<pre>  &lt;changelog basedir=&quot;dve/network&quot;
             destfile=&quot;changelog.xml&quot;
             daysinpast=&quot;10&quot;
  /&gt;</pre>

<p>Generates a changelog for the dve/network directory for the last 10 days. It writes
these changes into the file &quot;changelog.xml&quot;.</p>

<pre>  &lt;changelog basedir=&quot;dve/network&quot;
             destfile=&quot;changelog.xml&quot;
             start=&quot;20 Feb 2002&quot;
             end=&quot;20 Mar 2002&quot;
  /&gt;</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 &quot;changelog.xml&quot;.</p>

<pre>  &lt;changelog basedir=&quot;dve/network&quot;
             destfile=&quot;changelog.xml&quot;
             start=&quot;20 Feb 2002&quot;
  /&gt;</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 &quot;changelog.xml&quot;.</p>

<pre>  &lt;changelog basedir=&quot;dve/network&quot;
             destfile=&quot;changelog.xml&quot;
       &lt;user displayname=&quot;Peter Donald&quot; userid=&quot;donaldp&quot;/&gt;
  /&gt;</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 &quot;Peter Donald&quot;
any time it encounters the username &quot;donaldp&quot; in the changes.</p>

<h4>Sample Output</h4>
<pre>
&lt;changelog&gt;
	&lt;entry&gt;
		&lt;date&gt;2002-03-06&lt;/date&gt;
		&lt;time&gt;12:00&lt;/time&gt;
		&lt;author&gt;donaldp&lt;/author&gt;
		&lt;file&gt;
			&lt;name&gt;org/apache/myrmidon/build/AntlibDescriptorTask.java&lt;/name&gt;
			&lt;revision&gt;1.3&lt;/revision&gt;
			&lt;prevrevision&gt;1.2&lt;/prevrevision&gt;
		&lt;/file&gt;
		&lt;msg&gt;&lt;![CDATA[Use URLs directly rather than go via a FIle.

This allows temp[lates to be stored inside jar]]&gt;&lt;/msg&gt;
	&lt;/entry&gt;
&lt;/changelog&gt;
</pre>

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

</body>
</html>