o MAVEN-290: Use changes.xml again
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@112982 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
1
changes/xdocs/.cvsignore
Normal file
1
changes/xdocs/.cvsignore
Normal file
@@ -0,0 +1 @@
|
||||
stylesheets
|
||||
31
changes/xdocs/goals.xml
Normal file
31
changes/xdocs/goals.xml
Normal file
@@ -0,0 +1,31 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Maven Ant Plug-in Goals</title>
|
||||
<author email="dion@multitask.com.au">dIon Gillard</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Goals">
|
||||
<table>
|
||||
<tr><th>Goal</th><th>Description</th></tr>
|
||||
<tr>
|
||||
<td>changelog</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
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
29
changes/xdocs/index.xml
Normal file
29
changes/xdocs/index.xml
Normal file
@@ -0,0 +1,29 @@
|
||||
<?xml version="1.0"?>
|
||||
<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>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Maven Changelog 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.
|
||||
</p>
|
||||
<p>
|
||||
For more information on the functionality provided by this plugin,
|
||||
please see the <a href="goals.html">Goals</a> document.
|
||||
</p>
|
||||
<p>
|
||||
For more information on how to customise the functionality provided
|
||||
by this plugin, please see the <a href="properties.html">properties</a>
|
||||
document.
|
||||
</p>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
18
changes/xdocs/navigation.xml
Normal file
18
changes/xdocs/navigation.xml
Normal file
@@ -0,0 +1,18 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<project name="Maven Change log Plugin">
|
||||
|
||||
<title>Maven Change log Plugin</title>
|
||||
|
||||
<body>
|
||||
<links>
|
||||
<item name="Maven" href="http://jakarta.apache.org/turbine/maven/"/>
|
||||
<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" />
|
||||
<item name="Properties" href="/properties.html" />
|
||||
</menu>
|
||||
</body>
|
||||
</project>
|
||||
88
changes/xdocs/properties.xml
Normal file
88
changes/xdocs/properties.xml
Normal file
@@ -0,0 +1,88 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Changelog Properties</title>
|
||||
<author email="smor@apache.org">Stéphane MOR</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>
|
||||
</body>
|
||||
</document>
|
||||
Reference in New Issue
Block a user