maven-plugins/changelog/xdocs/properties.xml

123 lines
4.3 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<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.basedir</td>
<td>Yes</td>
<td>
Specifies the basedir for changelog execution.
This is used by the "changelog" goal. The default value is
<code>basedir</code>.
</td>
</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>30</code> days.
</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 following SCM factories are supported:
<ul>
<li>CVS (the default): <a
href="apidocs/org/apache/maven/cvslib/CvsChangeLogFactory.html">org.apache.maven.cvslib.CvsChangeLogFactory</a></li>
<li>Perforce: <a
href="apidocs/org/apache/maven/perforcelib/PerforceChangeLogFactory.html">org.apache.maven.perforcelib.PerforceChangeLogFactory</a></li>
<li>Subversion: <a
href="apidocs/org/apache/maven/svnlib/SvnChangeLogFactory.html">org.apache.maven.svnlib.SvnChangeLogFactory</a></li>
<li>Clearcase: <a
href="apidocs/org/apache/maven/clearcaselib/ClearcaseChangeLogFactory.html">org.apache.maven.clearcaselib.ClearcaseChangeLogFactory</a></li>
<li>StarTeam: <a
href="apidocs/org/apache/maven/starteamlib/StarteamChangeLogFactory.html">org.apache.maven.starteamlib.StarteamChangeLogFactory</a></li>
</ul>
</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>
<tr>
<td>maven.changelog.dateformat</td>
<td>Yes</td>
<td>
The date format in input stream. It's only used by Starteam changelog.
</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>