You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by vm...@apache.org on 2003/06/05 22:34:13 UTC
cvs commit: maven/src/plugins-build/changes/xdocs changes.xml goals.xml index.xml navigation.xml properties.xml
vmassol 2003/06/05 13:34:13
Modified: src/plugins-build/changes plugin.jelly plugin.properties
project.xml
src/plugins-build/changes/xdocs goals.xml index.xml
navigation.xml properties.xml
Added: src/plugins-build/changes/xdocs changes.xml
Log:
Fixed plugin documentation and lots of other "typos"...
Revision Changes Path
1.6 +2 -2 maven/src/plugins-build/changes/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/maven/src/plugins-build/changes/plugin.jelly,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- plugin.jelly 30 Mar 2003 16:17:19 -0000 1.5
+++ plugin.jelly 5 Jun 2003 20:34:13 -0000 1.6
@@ -14,7 +14,7 @@
<j:if test="${changes.exists()}">
<doc:registerReport
name="Changes"
- pluginName="maven-changes-plugin"
+ pluginName="changes"
link="changes-report"
description="Report on the project changes."/>
</j:if>
@@ -29,7 +29,7 @@
<!-- ================================================================== -->
<goal
- name="maven-changes-plugin:report"
+ name="changes:report"
description="Generate a changes report">
<ant:property name="maven.docs.src"
value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('maven.docs.src')}"/>
1.2 +0 -7 maven/src/plugins-build/changes/plugin.properties
Index: plugin.properties
===================================================================
RCS file: /home/cvs/maven/src/plugins-build/changes/plugin.properties,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- plugin.properties 24 Feb 2003 13:04:43 -0000 1.1
+++ plugin.properties 5 Jun 2003 20:34:13 -0000 1.2
@@ -3,10 +3,3 @@
# -------------------------------------------------------------------
# changes plugin.
# -------------------------------------------------------------------
-# These three don't belong here.
-maven.build.dir = ${basedir}/target
-maven.gen.docs = ${maven.build.dir}/generated-xdocs
-maven.docs.outputencoding = ISO-8859-1
-
-maven.changelog.range = 30
-maven.changelog.factory = org.apache.maven.cvslib.CvsChangeLogFactory
1.9 +27 -35 maven/src/plugins-build/changes/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/maven/src/plugins-build/changes/project.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- project.xml 9 Apr 2003 01:06:44 -0000 1.8
+++ project.xml 5 Jun 2003 20:34:13 -0000 1.9
@@ -5,7 +5,7 @@
<pomVersion>3</pomVersion>
<id>maven-changes-plugin</id>
<name>Maven Changes Plug-in</name>
- <currentVersion>1.2</currentVersion>
+ <currentVersion>1.2-SNAPSHOT</currentVersion>
<shortDescription>Java Project Management Tools</shortDescription>
<url>http://maven.apache.org/reference/plugins/changes/</url>
<siteDirectory>/www/maven.apache.org/reference/plugins/changes/</siteDirectory>
@@ -13,8 +13,24 @@
<connection>scm:cvs:pserver:anoncvs@cvs.apache.org:/home/cvspublic:maven/src/plugins-build/changes/</connection>
<url>http://cvs.apache.org/viewcvs/maven/src/plugins-build/changes/</url>
</repository>
+ <versions>
+ <version>
+ <id>1.2</id>
+ <name>1.2</name>
+ <tag>HEAD</tag>
+ </version>
+ </versions>
<developers>
<developer>
+ <name>Vincent Massol</name>
+ <id>vmassol</id>
+ <email>vmassol@pivolis.com</email>
+ <organization>Pivolis</organization>
+ <roles>
+ <role>Java Developer</role>
+ </roles>
+ </developer>
+ <developer>
<name>Ben Walding</name>
<id>bwalding</id>
<email>bwalding@apache.org</email>
@@ -24,38 +40,14 @@
</roles>
</developer>
</developers>
- <dependencies>
- <dependency>
- <id>ant</id>
- <version>1.5.1</version>
- <properties>
- <classloader>root</classloader>
- </properties>
- </dependency>
- <dependency>
- <groupId>commons-jelly</groupId>
- <artifactId>commons-jelly-tags-jsl</artifactId>
- <version>20030211.143151</version>
- <properties>
- <classloader>root.maven</classloader>
- </properties>
- </dependency>
- <dependency>
- <groupId>commons-jelly</groupId>
- <artifactId>commons-jelly-tags-xml</artifactId>
- <version>20030211.142705</version>
- <url>http://jakarta.apache.org/commons/jelly/libs/xml/</url>
- <properties>
- <classloader>root.maven</classloader>
- </properties>
- </dependency>
- <dependency>
- <id>commons-logging</id>
- <version>1.0.1</version>
- </dependency>
- <dependency>
- <id>junit</id>
- <version>3.8.1</version>
- </dependency>
- </dependencies>
+ <dependencies/>
+ <reports>
+ <report>maven-changes-plugin</report>
+ <report>maven-changelog-plugin</report>
+ <report>maven-file-activity-plugin</report>
+ <report>maven-developer-activity-plugin</report>
+ <report>maven-file-activity-plugin</report>
+ <report>maven-license-plugin</report>
+ <report>maven-linkcheck-plugin</report>
+ </reports>
</project>
1.2 +10 -13 maven/src/plugins-build/changes/xdocs/goals.xml
Index: goals.xml
===================================================================
RCS file: /home/cvs/maven/src/plugins-build/changes/xdocs/goals.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- goals.xml 24 Feb 2003 13:05:01 -0000 1.1
+++ goals.xml 5 Jun 2003 20:34:13 -0000 1.2
@@ -2,27 +2,24 @@
<document>
<properties>
- <title>Maven Ant Plug-in Goals</title>
- <author email="dion@multitask.com.au">dIon Gillard</author>
+ <title>Maven Changes Plug-in Goals</title>
+ <author email="vmassol@apache.org">Vincent Massol</author>
</properties>
<body>
<section name="Goals">
+ <p>
+ This plugin is called automatically by the
+ <code>site</code> plugin when it generates the project
+ web site.
+ </p>
<table>
<tr><th>Goal</th><th>Description</th></tr>
<tr>
- <td>changelog</td>
+ <td>report</td>
<td>
- This is the default goal of the plugin and simply attains
- the <code>changelog:generate</code> goal.
- </td>
- </tr>
- <tr>
- <td>changelog:generate</td>
- <td>
- Generates a report from the source control system showing
- changes by date along with the message, if any, provided
- by the developer when making the change
+ Generate the Changes reports showing the difference between
+ project releases.
</td>
</tr>
</table>
1.2 +39 -14 maven/src/plugins-build/changes/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/maven/src/plugins-build/changes/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 24 Feb 2003 13:05:01 -0000 1.1
+++ index.xml 5 Jun 2003 20:34:13 -0000 1.2
@@ -2,27 +2,52 @@
<document>
<properties>
- <title>Maven Changelog Plug-in</title>
- <author email="jason@zenplex.com">Jason van Zyl</author>
- <author email="dion@multitask.com.au">dIon Gillard</author>
+ <title>Maven Changes Plug-in</title>
+ <author email="vmassol@apache.org">Vincent Massol</author>
</properties>
<body>
- <section name="Maven Changelog Plug-in">
+ <section name="Maven Changes Plug-in">
<p>
- This plugin produces a nicely formatted changelog report so project
- team members can see at a glance what changes have been made
- recently to the project. Currently, there are three supported
- source control systems: CVS, StarTeam and Subversion.
+ This plugin produces a changes report showing the differences
+ between different releases of the project using it.
</p>
- <p>
- For more information on the functionality provided by this plugin,
- please see the <a href="goals.html">Goals</a> document.
+ <p>
+ In order to use this plugin, simply create a <code>changes.xml</code>
+ file in your <code>xdocs</code> directory. Here's an example of a
+ typical <code>changes.xml</code>, showing the syntax:
</p>
+<source><![CDATA[
+<document>
+ <properties>
+ <title>Page title</title>
+ <author email="vmassol@apache.org">Vincent Massol</author>
+ </properties>
+ <body>
+
+ <release version="2.0" date="in CVS">
+ <action dev="vmassol" type="update">
+ Blah blah.
+ </action>
+ </release>
+
+ <release version="1.0" date="2003-06-05">
+ <action dev="vmassol" type="add">
+ Added blah blah.
+ </action>
+ <action dev="vmassol" type="fix">
+ Corrected bug blah blah.
+ </action>
+ <action dev="vmassol" type="remove">
+ Removed blah blah.
+ </action>
+ </release>
+ </body>
+</document>
+]]></source>
<p>
- For more information on how to customise the functionality provided
- by this plugin, please see the <a href="properties.html">properties</a>
- document.
+ A live Changes example report can be found
+ <a href="http://maven.apache.org/reference/plugins/cactus/changes-report.html">here</a>.
</p>
</section>
</body>
1.3 +2 -5 maven/src/plugins-build/changes/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/maven/src/plugins-build/changes/xdocs/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- navigation.xml 19 Mar 2003 05:54:20 -0000 1.2
+++ navigation.xml 5 Jun 2003 20:34:13 -0000 1.3
@@ -1,14 +1,11 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
-<project name="Maven Change log Plugin">
+<project name="Maven Changes log Plugin">
- <title>Maven Change log Plugin</title>
+ <title>Maven Changes log Plugin</title>
<body>
<links>
<item name="Maven" href="http://maven.apache.org/"/>
- <item name="CVS" href="http://www.cvshome.org/"/>
- <item name="StarTeam" href="http://www.starbase.com/product_starteam/"/>
- <item name="Subversion" href="http://subversion.tigris.org/" />
</links>
<menu name="Overview">
<item name="Goals" href="/goals.html" />
1.2 +6 -78 maven/src/plugins-build/changes/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/maven/src/plugins-build/changes/xdocs/properties.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- properties.xml 24 Feb 2003 13:05:01 -0000 1.1
+++ properties.xml 5 Jun 2003 20:34:13 -0000 1.2
@@ -2,87 +2,15 @@
<document>
<properties>
- <title>Changelog Properties</title>
- <author email="smor@apache.org">St�phane MOR</author>
+ <title>Changes Properties</title>
+ <author email="vmassol@apache.org">Vincent Massol</author>
</properties>
<body>
- <section name="Changelog Properties">
- <table>
- <tr>
- <th>Property name</th>
- <th>Optional?</th>
- <th>Description</th>
- </tr>
- <tr>
- <td>maven.changelog.range</td>
- <td>Yes</td>
- <td>
- Specifies the range to use when generating the change log.
- This is used by the "changelog" goal. The default value is
- <code>5</code> days. Note: when using the Subversion
- changelog factory, you <b>must</b> set this property to an
- empty value because the Subversion ra_dav module (used to
- access DAV repositories) does not support date operations
- yet. If you are using a local repository (ra_local), then
- this does not apply to you.
- </td>
- </tr>
- <tr>
- <td>maven.changelog.factory</td>
- <td>Yes</td>
- <td>
- 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 "changelog" and "activity" goals.
- The default value is <a
- href="../apidocs/org/apache/maven/cvslib/CvsChangeLogFactory.html">
- org.apache.maven.cvslib.CvsChangeLogFactory</a>. In
- addition, there is also a Subversion factory (<a
- href="../apidocs/org/apache/maven/svnlib/SvnChangeLogFactory.html">
- org.apache.maven.svnlib.SvnChangeLogFactory</a>) as well as
- a StarTeam factory (<a
- href="../apidocs/org/apache/maven/starteamlib/StarteamChangeLogFactory.html">
- org.apache.maven.starteamlib.StarteamChangeLogFactory</a>).
- </td>
- </tr>
- <tr>
- <td>maven.docs.outputencoding</td>
- <td>Yes</td>
- <td>
- The output encoding for the generated xml documents. Set by
- the xdoc plugin, it defaults to <code>ISO-8859-1</code>
- </td>
- </tr>
- </table>
- </section>
- <section name="Other properties">
- <table>
- <tr>
- <th>Property name</th>
- <th>Optional?</th>
- <th>Description</th>
- </tr>
- <tr>
- <td>maven.gen.docs</td>
- <td>Yes</td>
- <td>
- The directory where the generated report is created.
- This directory holds the generated documents for
- processing by the xdoc plugin.
- </td>
- </tr>
- <tr>
- <td>maven.mode.online</td>
- <td>Yes</td>
- <td>
- Used by the plugin to check if the user is currently 'online'
- and hence has access to the source code repository.
- </td>
- </tr>
- </table>
+ <section name="Changes Properties">
+ <p>
+ There are no properties for this plugin.
+ </p>
</section>
</body>
</document>
1.1 maven/src/plugins-build/changes/xdocs/changes.xml
Index: changes.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Changes</title>
<author email="vmassol@apache.org">Vincent Massol</author>
</properties>
<body>
<release version="1.2" date="in CVS">
<action dev="vmassol" type="fix">
Fixed the xdocs which were simply a copy of the changelog plugin
docs.
</action>
</release>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org