diff --git a/changes/xdocs/changes.xml b/changes/xdocs/changes.xml
index 1553af6b..dd99746a 100644
--- a/changes/xdocs/changes.xml
+++ b/changes/xdocs/changes.xml
@@ -24,7 +24,10 @@
changes.xml file.
+ This plugin produces a changes report showing the differences between different releases of the project using it.
+
In order to use this plugin, simply create a changes.xml
file in your xdocs directory. Here's an example of a
@@ -53,20 +55,109 @@
A live Changes example report can be found - here. + here.
+ +
+ The following attributes are supported for the <release>
+ element:
+
| Attribute name | +Description | +Required? | +
|---|---|---|
| version | +
+ Name of the version for which to describe the changes. For each
+ change, add a nested <action> element as
+ described below.
+ |
+ yes | +
| date | ++ Date at which the version was released. You can use a free form + comment such as "in CVS" for unreleased versions. + | +yes | +
+ The following attributes are supported for the <action>
+ element:
+
| Attribute name | +Description | +Required? | +
|---|---|---|
| dev | +
+ Name of developer who committed the change. This must be the name
+ of the developer as described in the developers
+ section of the POM (project.xml file).
+ |
+ yes | +
| type | +
+ Type of change. There are four valid values:
+ add, fix, remove,
+ update.
+ |
+ yes | +
| issue | +
+ Id of the issue related to this change. This is the id in your
+ bug tracking system. The Changes plugin will generate a URL out
+ of this id. The URL is constructed by using the
+ maven.changes.issue.template property. See the
+ page for more details.
+ |
+ no | +
| due-to | ++ Name of the person to be credited for this change. To be used + when a patch is submitted by a non-committer. + | +no | +
| due-to-email | ++ Email of the person to be credited for this change. + | +no | +