glennm 02/05/27 14:25:27
Modified: src/java/org/apache/maven/changelog ChangeLog.java
ChangeLogEntry.java
src/java/org/apache/maven/cvslib CvsChangeLogGenerator.java
CvsChangeLogParser.java
src/templates/build default.properties
src/templates/build/plugins/core default.properties
src/templates/build/plugins/docs Control.vm build.xml
xdocs/ref build-file.xml properties.xml
Added: src/java/org/apache/maven/changelog ChangeLogFactory.java
src/java/org/apache/maven/cvslib CvsChangeLogFactory.java
Log:
Glenn McAllister - 2002/05/27
- Added a ChangeLogFactory interface to simplify creating instances of
ChangeLogGenerator and ChangeLogParser. Added CvsChangeLogFactory
implementation. Which factory class to use is controlled by the
maven.changelog.factory property. And yes, I documented this change. :)
Thanks to Pete Kazmier for the suggestion.
- Changed the resolution of grouping files in a ChangeLogEntry from 1 second to
1 minute.
- Changed the name of the "cvs-change-log" target to "change-log", and
documented the change.
- Added some static SimpleDateFormat objects in ChangeLogEntry to reduce
creating objects during every setDate and getDateFormat and getTimeFormat
method call. Also changed the setDate and getDate methods to use defensive
copying.
Revision Changes Path
1.4 +23 -64
jakarta-turbine-maven/src/java/org/apache/maven/changelog/ChangeLog.java
Index: ChangeLog.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/changelog/ChangeLog.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ChangeLog.java 27 May 2002 13:34:31 -0000 1.3
+++ ChangeLog.java 27 May 2002 21:25:26 -0000 1.4
@@ -85,7 +85,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]";>dIon Gillard</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Stefan Bodewig</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Peter Donald</a>
- * @version $Id: ChangeLog.java,v 1.3 2002/05/27 13:34:31 dion Exp $
+ * @version $Id: ChangeLog.java,v 1.4 2002/05/27 21:25:26 glennm Exp $
*/
public class ChangeLog extends ProjectExecutor
{
@@ -108,41 +108,23 @@
private Collection entries;
/**
- * The name of the ChangeLogGenerator class, defaulting to Maven's built in
- * CVS generator.
+ * The classname of our ChangeLogFactory, defaulting to Maven's built in
+ * CVS factory.
*/
- private String clGeneratorClass =
- "org.apache.maven.cvslib.CvsChangeLogGenerator";
+ private String clFactoryClass =
+ "org.apache.maven.cvslib.CvsChangeLogFactory";
/**
- * The name of the ChangeLogParser class, defaulting to Maven's built in
- * CVS parser.
- */
- private String clParserClass =
- "org.apache.maven.cvslib.CvsChangeLogParser";
-
- /**
- * Set the ChangeLogGenerator class name. If this isn't set, the generator
- * defaults to Maven's built in CVS generator.
- *
- * @param generatorClassName the fully qualified generator class name
- */
- public void setGenerator(String generatorClassName)
- {
- clGeneratorClass = generatorClassName;
- }
-
- /**
- * Set the ChangeLogParser class name. If this value isn't set, the parser
- * defaults to Maven's built in CVS parser.
+ * Set the ChangeLogFactory class name. If this isn't set, the factory
+ * defaults to Maven's build in CVS factory.
*
- * @param parserClassName the fully qualified parser class name.
+ * @param factoryClassName the fully qualified factory class name
*/
- public void setParser(String parserClassName)
+ public void setFactory(String factoryClassName)
{
- clParserClass = parserClassName;
+ clFactoryClass = factoryClassName;
}
-
+
/**
* Set the range of log entries to process; the interpretation of this
* parameter depends on the generator.
@@ -220,8 +202,9 @@
*/
private void generateEntries() throws IOException
{
- ChangeLogGenerator generator = createGenerator();
- ChangeLogParser parser = createParser();
+ ChangeLogFactory factory = createFactory();
+ ChangeLogGenerator generator = factory.createGenerator();
+ ChangeLogParser parser = factory.createParser();
generator.init(this);
parser.init(this);
@@ -239,56 +222,32 @@
}
/**
- * Create an instance of the ChangeLogGenerator specified by the {@link
- * clGeneratorClass} member.
- *
- * @return the change log generator
- * @throws IOException if there is a problem creating the generator
- */
- private ChangeLogGenerator createGenerator() throws IOException
- {
- return (ChangeLogGenerator) createObject(clGeneratorClass);
- }
-
- /**
- * Create an instance of the ChangeLogParser specified by the {@link
- * clParserClass} member.
- *
- * @return the change log parser
- * @throws IOException if there is a problem creating the parser
- */
- private ChangeLogParser createParser() throws IOException
- {
- return (ChangeLogParser) createObject(clParserClass);
- }
-
- /**
- * Create a new instance of class <code>className</code>.
+ * Create a new instance of the ChangeLogFactory specified by the
+ * <code>clFactory</code> member.
*
- * @param className the class to instantiate
- * @return the new instance
+ * @return the new ChangeLogFactory instance
* @throws IOException if there is a problem creating the instance.
*/
- private Object createObject(String className) throws IOException
+ private ChangeLogFactory createFactory() throws IOException
{
try
{
- Class clazz = Class.forName(className);
- return clazz.newInstance();
+ Class clazz = Class.forName(clFactoryClass);
+ return (ChangeLogFactory)clazz.newInstance();
}
catch (ClassNotFoundException cnfe)
{
- throw new IOException("Cannot find class " + className +
+ throw new IOException("Cannot find class " + clFactoryClass +
" " + cnfe.toString());
}
catch (IllegalAccessException iae)
{
- throw new IOException("Cannot access class " + className +
+ throw new IOException("Cannot access class " + clFactoryClass +
" " + iae.toString());
}
catch (InstantiationException ie)
{
- throw new IOException("Cannot instantiate class " + className +
+ throw new IOException("Cannot instantiate class " + clFactoryClass +
" " + ie.toString());
}
}
1.4 +29 -13
jakarta-turbine-maven/src/java/org/apache/maven/changelog/ChangeLogEntry.java
Index: ChangeLogEntry.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/changelog/ChangeLogEntry.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ChangeLogEntry.java 27 May 2002 13:34:31 -0000 1.3
+++ ChangeLogEntry.java 27 May 2002 21:25:26 -0000 1.4
@@ -68,16 +68,37 @@
* @todo add time of change to the entry
* @todo investigate betwixt for toXML method
* @author <a href="mailto:[EMAIL PROTECTED]";>dIon Gillard</a>
- * @version $Id: ChangeLogEntry.java,v 1.3 2002/05/27 13:34:31 dion Exp $
+ * @version $Id: ChangeLogEntry.java,v 1.4 2002/05/27 21:25:26 glennm Exp $
*/
public class ChangeLogEntry
{
+ /**
+ * Formatter used by the getDateFormatted method.
+ */
+ private static final SimpleDateFormat DATE_FORMAT =
+ new SimpleDateFormat("yyyy-MM-dd");
+
+ /**
+ * Formatter used by the getTimeFormatted method.
+ */
+ private static final SimpleDateFormat TIME_FORMAT =
+ new SimpleDateFormat("HH:mm:ss");
+
+ /**
+ * Formatter used to parse CVS date/timestamp.
+ */
+ private static final SimpleDateFormat CVS_TIMESTAMP_FORMAT =
+ new SimpleDateFormat("yyyy/MM/dd HH:mm:ss");
+
/** Date the changes were committed */
private Date date;
+
/** User who made changes */
private String author;
+
/** comment provided at commit time */
private String comment = "";
+
/** ChangeLogFiles committed on the date, by the author, with comment*/
private Vector files = new Vector();
@@ -137,7 +158,6 @@
public String toXML()
{
StringBuffer buffer = new StringBuffer();
- //SimpleDateFormat outputTime = new SimpleDateFormat("hh:mm");
buffer.append("\t<changelog-entry>\n")
.append("\t\t<date>")
@@ -149,10 +169,10 @@
.append("\t\t<author><![CDATA[")
.append(author)
.append("]]></author>\n");
- ChangeLogFile file = null;
+
for (Enumeration e = files.elements(); e.hasMoreElements();)
{
- file = (ChangeLogFile) e.nextElement();
+ ChangeLogFile file = (ChangeLogFile) e.nextElement();
buffer.append("\t\t<file>\n")
.append("\t\t\t<name>")
.append(file.getName())
@@ -210,7 +230,7 @@
*/
public Date getDate()
{
- return date;
+ return (Date) date.clone();
}
/**
@@ -219,7 +239,7 @@
*/
public void setDate(Date date)
{
- this.date = date;
+ this.date = new Date(date.getTime());
}
/**
@@ -228,11 +248,9 @@
*/
public void setDate(String date)
{
- SimpleDateFormat inputDate =
- new SimpleDateFormat("yyyy/MM/dd HH:mm:ss");
try
{
- this.date = inputDate.parse(date);
+ this.date = CVS_TIMESTAMP_FORMAT.parse(date);
}
catch (ParseException e)
{
@@ -247,8 +265,7 @@
*/
public String getDateFormatted()
{
- SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
- return dateFormat.format(getDate());
+ return DATE_FORMAT.format(getDate());
}
/**
@@ -256,8 +273,7 @@
*/
public String getTimeFormatted()
{
- SimpleDateFormat timeFormat = new SimpleDateFormat("HH:mm:ss");
- return timeFormat.format(getDate());
+ return TIME_FORMAT.format(getDate());
}
}
1.1
jakarta-turbine-maven/src/java/org/apache/maven/changelog/ChangeLogFactory.java
Index: ChangeLogFactory.java
===================================================================
package org.apache.maven.changelog;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Maven" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Maven", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* ====================================================================
*/
/**
* An AbstractFactory interface for creating the required ChangeLogGenerator
* and ChangeLogParser pairs.
*
* @author Glenn McAllister
* @version $Id: ChangeLogFactory.java,v 1.1 2002/05/27 21:25:26 glennm Exp $
*/
public interface ChangeLogFactory
{
/**
* Create the ChangeLogGenerator that extracts data from an SCM to be
* parsed by an associated ChangeLogParser.
*
* @return The ChangeLogGenerator for a particular SCM.
*/
ChangeLogGenerator createGenerator();
/**
* Create the ChangeLogParser that consumes the output from the
* ChangeLogGenerator to produce the set of ChangeLogEntry objects.
*
* @return The ChangeLogParser for a particular SCM.
*/
ChangeLogParser createParser();
}
1.5 +2 -2
jakarta-turbine-maven/src/java/org/apache/maven/cvslib/CvsChangeLogGenerator.java
Index: CvsChangeLogGenerator.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/cvslib/CvsChangeLogGenerator.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CvsChangeLogGenerator.java 27 May 2002 12:30:13 -0000 1.4
+++ CvsChangeLogGenerator.java 27 May 2002 21:25:26 -0000 1.5
@@ -87,9 +87,9 @@
* @author <a href="mailto:[EMAIL PROTECTED]";>dIon Gillard</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Stefan Bodewig</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Peter Donald</a>
- * @version $Id: CvsChangeLogGenerator.java,v 1.4 2002/05/27 12:30:13 dion Exp $
+ * @version $Id: CvsChangeLogGenerator.java,v 1.5 2002/05/27 21:25:26 glennm Exp $
*/
-public class CvsChangeLogGenerator
+class CvsChangeLogGenerator
implements ChangeLogGenerator, ExecuteStreamHandler
{
/**
1.5 +14 -4
jakarta-turbine-maven/src/java/org/apache/maven/cvslib/CvsChangeLogParser.java
Index: CvsChangeLogParser.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/java/org/apache/maven/cvslib/CvsChangeLogParser.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- CvsChangeLogParser.java 27 May 2002 12:30:13 -0000 1.4
+++ CvsChangeLogParser.java 27 May 2002 21:25:26 -0000 1.5
@@ -60,8 +60,10 @@
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.IOException;
+import java.text.SimpleDateFormat;
import java.util.Collection;
import java.util.Collections;
+import java.util.Date;
import java.util.Map;
import java.util.StringTokenizer;
import java.util.TreeMap;
@@ -75,10 +77,16 @@
* A class to parse cvs log output
*
* @author <a href="mailto:[EMAIL PROTECTED]";>dIon Gillard</a>
- * @version $Id: CvsChangeLogParser.java,v 1.4 2002/05/27 12:30:13 dion Exp $
+ * @version $Id: CvsChangeLogParser.java,v 1.5 2002/05/27 21:25:26 glennm Exp $
*/
-public class CvsChangeLogParser implements ChangeLogParser
+class CvsChangeLogParser implements ChangeLogParser
{
+ /**
+ * Custom date/time formatter. Rounds ChangeLogEntry times to the nearest
+ * minute.
+ */
+ private static final SimpleDateFormat ENTRY_KEY_TIMESTAMP_FORMAT =
+ new SimpleDateFormat( "yyyyMMddHHmm" );
/**
* rcs entries, in reverse (date, time, author, comment) order
@@ -196,8 +204,10 @@
return;
}
- String key = entry.getDateFormatted() + entry.getTimeFormatted() +
- entry.getAuthor() + entry.getComment();
+ String key = ENTRY_KEY_TIMESTAMP_FORMAT.format(entry.getDate()) +
+ entry.getAuthor() +
+ entry.getComment();
+
if (!entries.containsKey(key))
{
entry.addFile(file);
1.1
jakarta-turbine-maven/src/java/org/apache/maven/cvslib/CvsChangeLogFactory.java
Index: CvsChangeLogFactory.java
===================================================================
package org.apache.maven.cvslib;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Maven" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Maven", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* ====================================================================
*/
import org.apache.maven.changelog.ChangeLogFactory;
import org.apache.maven.changelog.ChangeLogGenerator;
import org.apache.maven.changelog.ChangeLogParser;
/**
* Provides CVS specific instances of the ChangeLogGenerator and
* ChangeLogParser interfaces.
*
* @author Glenn McAllister
* @version $Id: CvsChangeLogFactory.java,v 1.1 2002/05/27 21:25:26 glennm Exp $
*/
public class CvsChangeLogFactory implements ChangeLogFactory
{
/**
* Default no-arg constructor.
*/
public CvsChangeLogFactory()
{
}
/**
* Create a CVS specific ChangeLogGenerator.
*
* @return a CVS specific ChangeLogGenerator.
*/
public ChangeLogGenerator createGenerator()
{
return new CvsChangeLogGenerator();
}
/**
* Create a CVS specific ChangeLogParser.
*
* @return a CVS specific ChangeLogParser.
*/
public ChangeLogParser createParser()
{
return new CvsChangeLogParser();
}
}
1.40 +1 -2 jakarta-turbine-maven/src/templates/build/default.properties
Index: default.properties
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/src/templates/build/default.properties,v
retrieving revision 1.39
retrieving revision 1.40
diff -u -r1.39 -r1.40
--- default.properties 17 May 2002 21:08:17 -0000 1.39
+++ default.properties 27 May 2002 21:25:26 -0000 1.40
@@ -160,8 +160,7 @@
##
maven.changelog.range = 5
maven.activitylog.range = 30
-maven.changelog.generator = org.apache.maven.cvslib.CvsChangeLogGenerator
-maven.changelog.parser = org.apache.maven.cvslib.CvsChangeLogParser
+maven.changelog.factory = org.apache.maven.cvslib.CvsChangeLogFactory
# -------------------------------------------------------------------
# M A V E N U P D A T E S I T E A N D S E L F U P D A T I N G
1.5 +1 -2
jakarta-turbine-maven/src/templates/build/plugins/core/default.properties
Index: default.properties
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/templates/build/plugins/core/default.properties,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- default.properties 27 May 2002 08:02:41 -0000 1.4
+++ default.properties 27 May 2002 21:25:27 -0000 1.5
@@ -163,8 +163,7 @@
#
maven.changelog.range = 5
maven.activitylog.range = 30
-maven.changelog.generator = org.apache.maven.cvslib.CvsChangeLogGenerator
-maven.changelog.parser = org.apache.maven.cvslib.CvsChangeLogParser
+maven.changelog.factory = org.apache.maven.cvslib.CvsChangeLogFactory
# -------------------------------------------------------------------
# M A V E N U P D A T E S I T E A N D S E L F U P D A T I N G
1.2 +1 -1
jakarta-turbine-maven/src/templates/build/plugins/docs/Control.vm
Index: Control.vm
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/templates/build/plugins/docs/Control.vm,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- Control.vm 15 May 2002 19:17:44 -0000 1.1
+++ Control.vm 27 May 2002 21:25:27 -0000 1.2
@@ -25,5 +25,5 @@
## -------------------------------------------------------
## Make the list of callbacks
## -------------------------------------------------------
-$callbacks.put( "$plugin", ["pre-site", "post-site", "pre-fo", "post-fo",
"pre-pdf", "post-pdf", "pre-docs", "post-docs", "pre-docs-quick", "post-docs-quick",
"pre-deploy-site", "post-deploy-site", "pre-cross-ref", "post-cross-ref",
"pre-cvs-change-log", "post-cvs-change-log", "pre-activity-log", "post-activity-log",
"pre-task-list", "post-task-list", "pre-javadocs", "post-javadocs" ] )
+$callbacks.put( "$plugin", ["pre-site", "post-site", "pre-fo", "post-fo",
"pre-pdf", "post-pdf", "pre-docs", "post-docs", "pre-docs-quick", "post-docs-quick",
"pre-deploy-site", "post-deploy-site", "pre-cross-ref", "post-cross-ref",
"pre-change-log", "post-change-log", "pre-activity-log", "post-activity-log",
"pre-task-list", "post-task-list", "pre-javadocs", "post-javadocs" ] )
1.5 +7 -9 jakarta-turbine-maven/src/templates/build/plugins/docs/build.xml
Index: build.xml
===================================================================
RCS file:
/home/cvs/jakarta-turbine-maven/src/templates/build/plugins/docs/build.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- build.xml 27 May 2002 08:02:41 -0000 1.4
+++ build.xml 27 May 2002 21:25:27 -0000 1.5
@@ -25,7 +25,7 @@
<target
name="docs"
- depends="local-init, #callback("pre-docs"),jdepend-metrics, junit-report,
checkstyle-report, cvs-change-log, activity-log, generate-xdocs,
docs:site,#callback("post-docs")"
+ depends="local-init, #callback("pre-docs"),jdepend-metrics, junit-report,
checkstyle-report, change-log, activity-log, generate-xdocs,
docs:site,#callback("post-docs")"
description="o Generate html project documentation xdoc sources">
</target>
@@ -112,14 +112,14 @@
</target>
<!-- ================================================================== -->
- <!-- C V S C H A N G E L O G R E P O R T -->
+ <!-- C H A N G E L O G R E P O R T -->
<!-- ================================================================== -->
<target
- name="cvs-change-log"
-
depends="local-init,#callback("pre-cvs-change-log"),do-cvs-change-log,#callback("post-cvs-change-log")"/>
+ name="change-log"
+
depends="local-init,#callback("pre-change-log"),do-change-log,#callback("post-change-log")"/>
- <target name="do-cvs-change-log">
+ <target name="do-change-log">
<taskdef
name="change-log"
@@ -133,8 +133,7 @@
baseDir="."
output="${maven.gen.docs}/changelog.xml"
range="${maven.changelog.range}"
- generator="${maven.changelog.generator}"
- parser="${maven.changelog.parser}"
+ factory="${maven.changelog.factory}"
/>
</target>
@@ -161,8 +160,7 @@
baseDir="."
output="${maven.build.dir}/activity-log.xml"
range="${maven.activitylog.range}"
- generator="${maven.changelog.generator}"
- parser="${maven.changelog.parser}"
+ factory="${maven.changelog.factory}"
/>
<taskdef name="dvsl" classname="org.apache.tools.dvsl.DVSLTask">
1.16 +7 -6 jakarta-turbine-maven/xdocs/ref/build-file.xml
Index: build-file.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/ref/build-file.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- build-file.xml 15 May 2002 19:17:45 -0000 1.15
+++ build-file.xml 27 May 2002 21:25:27 -0000 1.16
@@ -524,12 +524,12 @@
<td>Generate the Javadoc API documentation.</td>
</tr>
<tr>
- <td><a href="#maven:cvs-change-log">maven:cvs-change-log</a></td>
- <td>Generate the change log from CVS.</td>
+ <td><a href="#maven:change-log">maven:change-log</a></td>
+ <td>Generate the change log from the version control system.</td>
</tr>
<tr>
<td><a href="#maven:activity-log">maven:activity-log</a></td>
- <td>Generate the activity log from CVS.</td>
+ <td>Generate the activity log from the version control system.</td>
</tr>
<tr>
<td><a href="#maven:cross-ref">maven:cross-ref</a></td>
@@ -598,9 +598,9 @@
it is created.
</p>
</subsection>
- <subsection name="maven:cvs-change-log">
+ <subsection name="maven:change-log">
<p>
- The <code>maven:cvs-change-log</code> target generates a
+ The <code>maven:change-log</code> target generates a
change log for the project by parsing the output of the
changelog generator. This output is then sorted and displayed
in an easy to read manner. Developer names are displayed by
@@ -618,7 +618,8 @@
reports on the commit activity of a project. The first report
displays commits by developer, and the second displays commits
by file. Developer names are displayed by mapping usernames
- to full names using the <code> <a
href="project-descriptor.html#developers">developers</a>
+ to full names using the <code>
+ <a href="project-descriptor.html#developers">developers</a>
</code> element from the project descriptor. By default, only
the past 30 days of changes are displayed (see the <a
href="properties.html#Miscellaneous Settings">Properties</a>
1.20 +12 -27 jakarta-turbine-maven/xdocs/ref/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/ref/properties.xml,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- properties.xml 27 May 2002 20:41:42 -0000 1.19
+++ properties.xml 27 May 2002 21:25:27 -0000 1.20
@@ -1316,35 +1316,20 @@
</td>
</tr>
<tr>
- <td>maven.changelog.generator</td>
+ <td>maven.changelog.factory</td>
<td>Yes</td>
<td>
- Specifies a fully qualified class name implementing
- <code>org.apache.maven.changelog.ChangeLogGenerator</code>. This
- class creates an <code>InputStream</code> that is parsed by the
- class specified by the <code>changelog.parser</code> property to create
- a collection of <code>ChangeLogEntry</code> objects. This is used
- by the <a
- href="build-file.html#maven:cvs-change-log">maven:cvs-change-log</a>
- target. The default value is
- <a href="../apidocs/org/apache/maven/cvslib/CvsChangeLogGenerator.html">
- org.apache.maven.cvslib.CvsChangeLogGenerator</a>.
- </td>
- </tr>
- <tr>
- <td>maven.changelog.parser</td>
- <td>Yes</td>
- <td>
- Specifies a fully qualified class name implementing
- <code>org.apache.maven.changelog.ChangeLogParser</code>. This
- class parses the <code>InputStream</code> created by the class
- specified by the <code>changelog.generator</code> property to
- create a collection of <code>ChnageLogEntry</code> objects.
- This is used by the <a
- href="build-file.html#maven:cvs-change-log">maven:cvs-change-log</a>
- target. The default value is
- <a href="../apidocs/org/apache/maven/cvslib/CvsChangeLogParser.html">
- org.apache.maven.cvslib.CvsChangeLogParser</a>.
+ Specifies a fully qualified class name implementing the
+ <code>org.apache.maven.changelog.ChangeLogFactory</code> interface.
+ The class creates the <code>ChangeLogGenerator</code> and
+ <code>ChangeLogParser</code> pair required to create the change
+ log. This is used by the <a
+ href="build-file.html#maven:change-log">maven:change-log</a>
+ and <a
+ href="build-file.html#maven:activity-log">maven:activity-log</a>
+ targets. The default value is <a
+ href="../apidocs/org/apache/maven/cvslib/CvsChangeLogFactory.html">
+ org.apache.maven.cvslib.CvsChangeLogFactory</a>.
</td>
</tr>
<tr>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
