You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by br...@apache.org on 2005/01/10 12:53:58 UTC
svn commit: r124795 - /maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/faq.fml /maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/goals.xml /maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml /maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/properties.xml
Author: brett
Date: Mon Jan 10 03:53:56 2005
New Revision: 124795
URL: http://svn.apache.org/viewcvs?view=rev&rev=124795
Log:
add documentation
Modified:
maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/faq.fml
maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/goals.xml
maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml
maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/properties.xml
Modified: maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/faq.fml
Url: http://svn.apache.org/viewcvs/maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/faq.fml?view=diff&rev=124795&p1=maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/faq.fml&r1=124794&p2=maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/faq.fml&r2=124795
==============================================================================
--- maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/faq.fml (original)
+++ maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/faq.fml Mon Jan 10 03:53:56 2005
@@ -20,9 +20,5 @@
<faqs title="Frequently Asked Questions">
<part id="usage">
<title>Plugin Usage</title>
- <faq id="how-use">
- <question>How do I checkout all modules in HEAD for CVS?</question>
- <answer>Set the <code>maven.scm.cvs.module</code> to a single period (i.e. <code>.</code>)</answer>
- </faq>
</part>
</faqs>
Modified: maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/goals.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/goals.xml?view=diff&rev=124795&p1=maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/goals.xml&r1=124794&p2=maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/goals.xml&r2=124795
==============================================================================
--- maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/goals.xml (original)
+++ maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/goals.xml Mon Jan 10 03:53:56 2005
@@ -25,18 +25,22 @@
<body>
<goals>
<goal>
- <name>scm:bootstrap-project</name>
+ <name>scm:bootstrap</name>
<description>Bootstrap a project from SCM</description>
</goal>
<goal>
- <name>scm:checkout-project</name>
+ <name>scm:checkout</name>
<description>Checkout a project</description>
</goal>
<goal>
- <name>scm:update-project</name>
+ <name>scm:update</name>
<description>Update a project from SCM</description>
</goal>
<goal>
+ <name>scm:tag</name>
+ <description>Tag a project in the SCM</description>
+ </goal>
+ <goal>
<name>scm:prepare-release</name>
<description>
Prepare a project for release from SCM. This checks all
@@ -56,9 +60,9 @@
</description>
</goal>
<goal>
- <name>scm:cvs-create-patch</name>
+ <name>scm:create-patch</name>
<description>
- Creates a patch in ${maven.scm.cvs.patch.dir}/${maven.scm.cvs.patch.file}
+ Creates a patch in ${maven.scm.patch.dir}/${maven.scm.patch.file}
of the changes made to the current project
</description>
</goal>
Modified: maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml?view=diff&rev=124795&p1=maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml&r1=124794&p2=maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml&r2=124795
==============================================================================
--- maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml (original)
+++ maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/index.xml Mon Jan 10 03:53:56 2005
@@ -27,7 +27,7 @@
<body>
<section name="Maven SCM Plugin">
<p>
- A plugin for SCM tasks, currently CVS.
+ A plugin for SCM tasks, currently CVS and Subversion.
</p>
<p>
For more information on the functionality provided by this plugin,
Modified: maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/properties.xml
Url: http://svn.apache.org/viewcvs/maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/properties.xml?view=diff&rev=124795&p1=maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/properties.xml&r1=124794&p2=maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/properties.xml&r2=124795
==============================================================================
--- maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/properties.xml (original)
+++ maven/maven-1/plugins/branches/scm-1.5-branch/xdocs/properties.xml Mon Jan 10 03:53:56 2005
@@ -32,154 +32,167 @@
<th>Description</th>
</tr>
<tr>
- <td>maven.scm.method</td>
- <td>Yes</td>
+ <td>maven.scm.url</td>
+ <td>If there is no POM</td>
<td>
- <p>Default value is
- <code>cvs</code>.
- </p>
+ 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.checkout.dir</td>
+ <td>maven.scm.tag</td>
<td>Yes</td>
<td>
- <p>Default value is
- <code>${basedir}/checkouts</code>.
- </p>
+ The tag to use when checking out or tagging a project.
</td>
</tr>
<tr>
- <td>maven.scm.check.tagged</td>
+ <td>maven.scm.bootstrap.goals</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>
+ 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.goals</td>
- <td>No</td>
+ <td>maven.scm.bootstrap.pom.dir</td>
+ <td>Yes</td>
<td>
- <p>Goals to call on the checked out project.</p>
+ The relative path to the <code>project.xml</code> file within the checkout for the
+ bootstrap goal.
</td>
</tr>
<tr>
- <td>maven.scm.bootstrap.pom.dir</td>
+ <td>maven.scm.checkout.dir</td>
<td>Yes</td>
<td>
- <p>Where to find project.xml in the checked out project.</p>
+ The directory to checkout the sources to for the bootstrap and checkout goals.
+ The default is <code>${maven.build.dir}/checkouts</code>.
</td>
</tr>
- </table>
- </subsection>
- <subsection name="CVS Settings">
- <table>
<tr>
- <th>Property</th>
- <th>Optional?</th>
- <th>Description</th>
+ <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.cvs.root</td>
+ <td>maven.scm.patch.dir</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 can set this property to
- <code>${pom.repository.cvsRoot}</code>
+ <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.cvs.update.flags</td>
+ <td>maven.scm.patch.file</td>
<td>Yes</td>
<td>
- <p>Default value is
- <code>-Pd</code>. Note that any environment settings
- (eg .cvsrc) will also affect this.
+ <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>
+ </table>
+ </subsection>
+ <subsection name="Subversion Specific Settings">
+ <table>
<tr>
- <td>maven.scm.cvs.module</td>
- <td>No</td>
- <td>
- <p>The CVS module to checkout</p>
- </td>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Description</th>
</tr>
<tr>
- <td>maven.scm.cvs.sticky.tag</td>
+ <td>maven.scm.svn.tag.base</td>
<td>Yes</td>
<td>
- <p>Sticky tag to use when checking out or updating. Default is none.</p>
+ 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.cvs.quiet</td>
+ <td>maven.scm.method</td>
<td>Yes</td>
<td>
<p>Default value is
- <code>true</code>.
+ <code>cvs</code>.
</p>
</td>
</tr>
<tr>
- <td>maven.scm.cvs.checkout.flags</td>
+ <td>maven.scm.cvs.root</td>
<td>Yes</td>
<td>
- <p>Default value is
- <code>-P</code>. Note that any environment settings
- (eg .cvsrc) will also affect this.
+ <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.rsh</td>
+ <td>maven.scm.cvs.module</td>
<td>Yes</td>
<td>
- <p>Default value is taken from CVS_RSH in the environment.</p>
+ <p>The CVS module to checkout</p>
</td>
</tr>
<tr>
- <td>maven.scm.cvs.tag</td>
+ <td>maven.scm.svn.root</td>
<td>Yes</td>
<td>
- <p>Used as the tag for the
- <code>cvs-tag-project</code> goal.
+ <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.patch.dir</td>
+ <td>maven.scm.svn.module</td>
<td>Yes</td>
<td>
- <p>Working directory for creating a patch file. Used by the
- <code>cvs-create-patch</code> goal.
- </p>
- <p>Defaults to
- <code>${maven.build.dir}/scm/patch</code>
- </p>
+ <p>The SVN module to checkout</p>
</td>
</tr>
<tr>
- <td>maven.scm.cvs.patch.file</td>
+ <td>maven.scm.cvs.sticky.tag</td>
<td>Yes</td>
<td>
- <p>
- The name of the patch file created y the
- <code>cvs-create-patch</code> goal.
- in the
- <code>${maven.scm.cvs.patch.dir}</code> directory
- </p>
- <p>Defaults to
- <code>patch.txt</code>
+ <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>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org