maven-plugins/scm/xdocs/properties.xml
brett fe10b8f9e2 update docs
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@179031 13f79535-47bb-0310-9956-ffa450edef68
2005-05-30 07:23:10 +00:00

225 lines
7.1 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* 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>Maven Source Control Management Plug-in Properties</title>
</properties>
<body>
<section name="Maven Source Control Management Plug-in Settings">
<subsection name="General SCM Settings">
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>maven.scm.url</td>
<td>If there is no POM</td>
<td>
The URL to use. This overrides the connection setting in the POM if required.
It is required if there is no connection setting in the POM, or there is no POM at all.
</td>
</tr>
<tr>
<td>maven.scm.tag</td>
<td>Yes</td>
<td>
The tag to use when checking out or tagging a project.
</td>
</tr>
<tr>
<td>maven.scm.version</td>
<td>Yes</td>
<td>
The version to use when preparing a release. If omitted, you will be prompted for it.
</td>
</tr>
<tr>
<td>maven.scm.bootstrap.goals</td>
<td>Yes</td>
<td>
The goals to run on the clean checkout of a project for the bootstrap goal. If
none are specified, then the default goal for the project is executed.
Multiple goals should be comma separated.
</td>
</tr>
<tr>
<td>maven.scm.bootstrap.pom.dir</td>
<td>Yes</td>
<td>
The relative path to the <code>project.xml</code> file within the checkout for the
bootstrap goal.
</td>
</tr>
<tr>
<td>maven.scm.checkout.dir</td>
<td>Yes</td>
<td>
The directory to checkout the sources to for the bootstrap and checkout goals.
The default is <code>${maven.build.dir}/checkout</code>.
</td>
</tr>
<tr>
<td>maven.scm.ignore.pom.developerConnection</td>
<td>Yes</td>
<td>
Set to true if you do not wish to use the developer connection for this URL.
The pom.connection setting will be used instead.
</td>
</tr>
<tr>
<td>maven.scm.patch.dir</td>
<td>Yes</td>
<td>
<p>Working directory for creating a patch file. Used by the
<code>create-patch</code> goal.
</p>
<p>Defaults to
<code>${maven.build.dir}/scm/patch</code>
</p>
</td>
</tr>
<tr>
<td>maven.scm.patch.file</td>
<td>Yes</td>
<td>
<p>
The name of the patch file created y the
<code>create-patch</code> goal.
in the
<code>${maven.scm.patch.dir}</code> directory
</p>
<p>Defaults to
<code>patch.diff</code>
</p>
</td>
</tr>
<tr>
<td>maven.scm.username</td>
<td>Yes</td>
<td>
<p>
The username to pass to the SCM. Currently only Subversion is known to honour this.
You can also add it to the URL, eg. <code>http://user@svn.mycompany.com/repos</code>.
</p>
</td>
</tr>
<tr>
<td>maven.scm.password</td>
<td>Yes</td>
<td>
<p>
The password to give to the SCM. Currently only Subversion is known to honour this.
It is not recommended that you use this property, and instead use an alternative authentication
technique such as an ssh agent or Subversion's password caching mechanism.
</p>
</td>
</tr>
</table>
</subsection>
<subsection name="Subversion Specific Settings">
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>maven.scm.svn.tag.base</td>
<td>Yes</td>
<td>
The Subversion URL to copy tagged sources to. The default is <code>../tags</code>, relative
to the URL for the current source tree.
</td>
</tr>
</table>
</subsection>
<subsection name="Deprecated SCM Properties">
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>maven.scm.method</td>
<td>Yes</td>
<td>
<p>Default value is
<code>cvs</code>.
</p>
</td>
</tr>
<tr>
<td>maven.scm.cvs.root</td>
<td>Yes</td>
<td>
<p>
Default value is taken from CVSROOT in the environment.
If you have a valid Maven project descriptor and the repository
element is using CVS, you do not need to set this property.
</p>
</td>
</tr>
<tr>
<td>maven.scm.cvs.module</td>
<td>Yes</td>
<td>
<p>The CVS module to checkout</p>
</td>
</tr>
<tr>
<td>maven.scm.svn.root</td>
<td>Yes</td>
<td>
<p>
If you have a valid Maven project descriptor and the repository
element is using SVN, you do not need to set this property.
</p>
</td>
</tr>
<tr>
<td>maven.scm.cvs.sticky.tag</td>
<td>Yes</td>
<td>
<p>Sticky tag to use when checking out or updating. Default is none.</p>
</td>
</tr>
<tr>
<td>maven.scm.check.tagged</td>
<td>Yes</td>
<td>
<p>When
<code>true</code>, you will be asked for confirmation if
you are attempting to release from
<code>HEAD</code>.
Default value is
<code>true</code>.
</p>
</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>