maven-plugins/scm/xdocs/scmurl.xml

71 lines
2.2 KiB
XML

<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2005 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>SCM URL Format</title>
<author email="brett@apache.org">Brett Porter</author>
</properties>
<!-- TODO: move to SCM documentation -->
<body>
<section name="SCM URL Format">
<p>
The SCM URL is used to provide any necessary information to connect to your
source control system. It is much like a JDBC connection URL.
</p>
<p>
The format is as follows:
</p>
<source>scm:&lt;provider&gt;[:&lt;provider specific connection string&gt;]</source>
<p>
The available providers and their particular connection strings are listed below.
</p>
<subsection name="CVS">
<p>
The full connection string for CVS is as follows:
</p>
<source>scm:cvs:&lt;protocol&gt;[:&lt;host&gt;]:&lt;CVS root&gt;:&lt;CVS module&gt;</source>
<p>
For example:
</p>
<source>
scm:cvs:pserver:anoncvs@cvs.apache.org:/cvs/root:module
scm:cvs:ext:username@cvs.apache.org:/cvs/root:module
scm:cvs:local:/cvs/root:module</source>
</subsection>
<subsection name="Subversion">
<p>
The full connection string for Subversion is as follows:
</p>
<source>scm:svn:&lt;url&gt;</source>
<p>
For example:
</p>
<source>
scm:svn:file:///svn/root/module
scm:svn:http://svn.apache.org/svn/root/module
scm:cvs:https://username@svn.apache.org/svn/root/module</source>
</subsection>
</section>
</body>
</document>