org.apache.tools.ant.taskdefs.cvslib

Class ChangeLogTask

public class ChangeLogTask extends AbstractCvsTask

Examines the output of cvs log and group related changes together. It produces an XML output representing the list of changes.
 <!-- Root element -->
 <!ELEMENT changelog 
 (entry+)
 >
 <!-- CVS Entry -->
 <!ELEMENT entry 
 (date,author,file+,msg)
 >
 <!-- Date of cvs entry -->
 <!ELEMENT date (#PCDATA)
 >
 <!-- Author of change -->
 <!ELEMENT author (#PCDATA)
 >
 <!-- List of files affected -->
 <!ELEMENT msg (#PCDATA)
 >
 <!-- File changed -->
 <!ELEMENT file 
 (name,revision,prevrevision?
 )>
 <!-- Name of the file -->
 <!ELEMENT name (#PCDATA)
 >
 <!-- Revision number -->
 <!ELEMENT revision 
 (#PCDATA)>
 <!-- Previous revision number -->
 <!ELEMENT prevrevision 
 (#PCDATA)>
 

Since: Ant 1.5

UNKNOWN: name="cvschangelog" category="scm"

Method Summary
voidaddFileset(FileSet fileSet)
Adds a set of files about which cvs logs will be generated.
voidaddUser(CvsUser user)
Add a user to list changelog knows about.
voidexecute()
Execute task
voidsetDaysinpast(int days)
Set the number of days worth of log entries to process.
voidsetDestfile(File destFile)
Set the output file for the log.
voidsetDir(File inputDir)
Set the base dir for cvs.
voidsetEnd(Date endDate)
Set the date at which the changelog should stop.
voidsetStart(Date start)
Set the date at which the changelog should start.
voidsetUsersfile(File usersFile)
Set a lookup list of user names & addresses

Method Detail

addFileset

public void addFileset(FileSet fileSet)
Adds a set of files about which cvs logs will be generated.

Parameters: fileSet a set of files about which cvs logs will be generated.

addUser

public void addUser(CvsUser user)
Add a user to list changelog knows about.

Parameters: user the user

execute

public void execute()
Execute task

Throws: BuildException if something goes wrong executing the cvs command

setDaysinpast

public void setDaysinpast(int days)
Set the number of days worth of log entries to process.

Parameters: days the number of days of log to process.

setDestfile

public void setDestfile(File destFile)
Set the output file for the log.

Parameters: destFile The new destfile value

setDir

public void setDir(File inputDir)
Set the base dir for cvs.

Parameters: inputDir The new dir value

setEnd

public void setEnd(Date endDate)
Set the date at which the changelog should stop.

Parameters: endDate The date at which the changelog should stop.

setStart

public void setStart(Date start)
Set the date at which the changelog should start.

Parameters: start The date at which the changelog should start.

setUsersfile

public void setUsersfile(File usersFile)
Set a lookup list of user names & addresses

Parameters: usersFile The file containing the users info.