Author: dennisl
Date: Sun May 15 16:17:21 2011
New Revision: 1103443
URL: http://svn.apache.org/viewvc?rev=1103443&view=rev
Log:
[SCM-620] Publish the XML schema for svn-settings
- The generated xsd is included in the site
- Reference documentation is generated and included in the site
Modified:
maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/pom.xml
maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/mdo/svn-settings.mdo
maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/site/site.xml
maven/scm/trunk/src/site/apt/subversion.apt
Modified:
maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/pom.xml
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/pom.xml?rev=1103443&r1=1103442&r2=1103443&view=diff
==============================================================================
---
maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/pom.xml
(original)
+++
maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/pom.xml
Sun May 15 16:17:21 2011
@@ -31,7 +31,7 @@
<artifactId>maven-scm-provider-svn-commons</artifactId>
<name>Maven SCM Subversion Provider - Common library</name>
- <description>Common library for SCM SVN Provider.</description>
+ <description>Common library for SCM SVN Provider. Includes the
svn-settings.xml configuration model.</description>
<build>
<plugins>
@@ -40,11 +40,28 @@
<artifactId>modello-maven-plugin</artifactId>
<executions>
<execution>
+ <id>generate-xsd-site</id>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>xsd</goal>
+ </goals>
+ <configuration>
+
<outputDirectory>${project.reporting.outputDirectory}/xsd</outputDirectory>
+ </configuration>
+ </execution>
+ <execution>
+ <id>site-docs</id>
+ <phase>pre-site</phase>
+ <goals>
+ <goal>xdoc</goal>
+ </goals>
+ </execution>
+ <execution>
+ <id>standard</id>
<goals>
<goal>java</goal>
<goal>xpp3-reader</goal>
<goal>xpp3-writer</goal>
- <goal>xsd</goal>
</goals>
</execution>
</executions>
Modified:
maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/mdo/svn-settings.mdo
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/mdo/svn-settings.mdo?rev=1103443&r1=1103442&r2=1103443&view=diff
==============================================================================
---
maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/mdo/svn-settings.mdo
(original)
+++
maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/mdo/svn-settings.mdo
Sun May 15 16:17:21 2011
@@ -22,8 +22,8 @@
<model xmlns="http://modello.codehaus.org/MODELLO/1.1.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://modello.codehaus.org/MODELLO/1.1.0
http://modello.codehaus.org/xsd/modello-1.1.0.xsd";
xml.namespace="http://maven.apache.org/SCM/SVN/${version}";
- xml.schemaLocation="http://maven.apache.org/xsd/scm-svn-${version}.xsd";>
- <id>svn</id>
+ xml.schemaLocation="http://maven.apache.org/xsd/svn-settings-${version}.xsd";>
+ <id>svn-settings</id>
<name>Svn</name>
<description>SVN Provider Model.</description>
<defaults>
@@ -52,7 +52,7 @@
<type>boolean</type>
<defaultValue>false</defaultValue>
<description><![CDATA[
- Must be true if svn is a cygwin svn command.
+ Must be <code>true</code> if svn is a cygwin svn command.
]]></description>
</field>
<field>
@@ -61,7 +61,7 @@
<type>String</type>
<defaultValue>/cygwin</defaultValue>
<description><![CDATA[
- The cygwin mount path. The default value is '/cygwin'.
+ The cygwin mount path.
]]></description>
</field>
<field>
@@ -70,7 +70,7 @@
<type>boolean</type>
<defaultValue>true</defaultValue>
<description><![CDATA[
- Switch off if you do not like to use --non-interactive e.g. on
Leopard (see SCM-402).
+ Switch off if you do not like to use
<code>--non-interactive</code> e.g. on Leopard (see SCM-402).
]]></description>
</field>
<field>
@@ -79,7 +79,8 @@
<type>boolean</type>
<defaultValue>false</defaultValue>
<description><![CDATA[
- Switch on if you want to cache authentication credentials
(Warning: this will overwrite existing authentication credentials on your
working copy)
+ Switch on if you want to cache authentication credentials
(Warning: this will overwrite existing authentication credentials on your
working copy).
+ If you don't change this, the command line option
<code>--no-auth-cache</code> is used.
]]></description>
</field>
<field>
@@ -88,7 +89,7 @@
<type>boolean</type>
<defaultValue>false</defaultValue>
<description><![CDATA[
- to use svn command line option : --trust-server-cert
+ Switch on to use svn command line option:
<code>--trust-server-cert</code>.
]]></description>
</field>
</fields>
Modified:
maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/site/site.xml?rev=1103443&r1=1103442&r2=1103443&view=diff
==============================================================================
---
maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/site/site.xml
(original)
+++
maven/scm/trunk/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/site/site.xml
Sun May 15 16:17:21 2011
@@ -25,6 +25,7 @@
<menu name="Overview">
<item name="Introduction" href="index.html"/>
+ <item name="svn-settings.xml Reference" href="svn-settings.html"/>
</menu>
<menu ref="reports" inherit="bottom" />
Modified: maven/scm/trunk/src/site/apt/subversion.apt
URL:
http://svn.apache.org/viewvc/maven/scm/trunk/src/site/apt/subversion.apt?rev=1103443&r1=1103442&r2=1103443&view=diff
==============================================================================
--- maven/scm/trunk/src/site/apt/subversion.apt (original)
+++ maven/scm/trunk/src/site/apt/subversion.apt Sun May 15 16:17:21 2011
@@ -60,11 +60,9 @@ scm:svn:https://username:[email protected]
* Provider Configuration
- The provider configuration is defined in ${user.home}/.scm/svn-settings.xml
+ The provider configuration is defined in
<<<${user.home}/.scm/svn-settings.xml>>>.
-** Configuration directory
-
- You can define the subversion configuration directory ('--config-dir' svn
global option) in the provider configuration file or with
'maven.scm.svn.config_directory' command line parameter.
+ Here is an example of what a configuration file might look like:
-------
<svn-settings>
@@ -77,6 +75,13 @@ scm:svn:https://username:[email protected]
</svn-settings>
-------
+ For more info see the
+
{{{http://maven.apache.org/scm/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/svn-settings.html}reference
guide}}.
+
+** Configuration directory
+
+ You can define the subversion configuration directory ('--config-dir' svn
global option) in the provider configuration file or with
'maven.scm.svn.config_directory' command line parameter.
+
-------
mvn -Dmaven.scm.svn.config_directory=your_configuration_directory scm:update
-------
