ddb957d938
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@371829 13f79535-47bb-0310-9956-ffa450edef68
192 lines
7.3 KiB
XML
192 lines
7.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.type</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Indicates what the change log is based on.
|
|
This is used by the "changelog" goal.
|
|
Possible values are: <code>range</code> (meaning a date range),
|
|
<code>date</code> (meaning an absolute date),
|
|
or <code>tag</code> (meaning a tag).
|
|
The default value is <code>range</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 if the maven.changelog.type
|
|
property is "range". The default value is
|
|
<code>30</code> days.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.changelog.date</td>
|
|
<td>No (if type==date)</td>
|
|
<td>
|
|
Specifies an absolute date to use when generating the change log.
|
|
This is used by the "changelog" goal if the maven.changelog.type
|
|
property is "date". The log will contain changes made after this date.
|
|
If it is set to '<code>lastRelease</code>', the date found for
|
|
the last release in <code>changes.xml</code> is used.
|
|
The date format is that specified by maven.changelog.dateformat if
|
|
present; otherwise, the format is yyyy-MM-dd.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.changelog.tag</td>
|
|
<td>No (if type==tag)</td>
|
|
<td>
|
|
Specifies the range to use when generating the change log.
|
|
This is used by the "changelog" goal if the maven.changelog.type
|
|
property is "tag". The log will contain changes made after this
|
|
tag. Currently, this is supported for CVS only.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.changelog.commentFormat</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies the RCS query to use when generating the comment for change log.
|
|
This is currently only used by the Clearcase change log. The default value is
|
|
<code>%Sn - %c - Activity: %[activity]p\\n</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>
|
|
<li>Visual Source Safe: <a
|
|
href="apidocs/org/apache/maven/vsslib/VssChangeLogFactory.html">org.apache.maven.vsslib.VssChangeLogFactory</a></li>
|
|
<li>MKS Source Integrity: <a
|
|
href="apidocs/org/apache/maven/mkslib/MksChangeLogFactory.html">org.apache.maven.mkslib.MksChangeLogFactory</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 and/or when specifying an absolute date.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.changelog.svn.baseurl</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
The base address of the svn url. Use it for creating correct links
|
|
when the current project is a sub-project in the svn repository.
|
|
Only used if <code>repository.connection</code>
|
|
starts with <code>scm:svn</code>.
|
|
Defaults to <code>${pom.repository.url}</code>.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>maven.changelog.quoteDate</td>
|
|
<td>Yes</td>
|
|
<td>
|
|
Specifies whether to put quotation marks around the date argument.
|
|
This is required on some ssh clients.
|
|
Currently only used by cvs. Defaults to <code>false</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>
|