Changelog Task

Changelog

Description

Generates an XML report of the changes recorded in a CVS repository.

Parameters

Attribute	Description	Required
basedir	the directory from which to run "cvs log".	Yes
destfile	the file in which to write the changelog.	Yes
usersfile	property file that contains mapping between userids and display names.	No
daysinpast	sets the start the number of days into the past specified.	No
start	the earliest date of changes that are to be included in report.	No
end	the latest date of changes that are to be included in report.	No

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..

Attribute	Description	Required
displayname	The name to be displayed in CVS changelog.	Yes
userid	The userid of person as they exist on the CVS server.	Yes

Examples

  <changelog basedir="dve/network"
             destfile="changelog.xml"
  />

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".

  <changelog basedir="dve/network"
             destfile="changelog.xml"
             days="10"
  />

Generates a changelog for the dve/network directory for the last 10 days. It writes these changes into the file "changelog.xml".

  <changelog basedir="dve/network"
             destfile="changelog.xml"
             start="20 Feb 2002"
             end="20 Mar 2002"
  />

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".

  <changelog basedir="dve/network"
             destfile="changelog.xml"
             start="20 Feb 2002"
  />

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".

  <changelog basedir="dve/network"
             destfile="changelog.xml"
       <user displayname="Peter Donald" userid="donaldp"/>
  />

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.

Sample Output

<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>