You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ca...@apache.org on 2006/03/08 20:53:47 UTC

svn commit: r384311 - in /maven/sandbox/wagon-scm/src/site: apt/index.apt apt/usage.apt site.xml

Author: carlos
Date: Wed Mar  8 11:53:47 2006
New Revision: 384311

URL: http://svn.apache.org/viewcvs?rev=384311&view=rev
Log:
Added site documentation

Added:
    maven/sandbox/wagon-scm/src/site/apt/index.apt   (with props)
    maven/sandbox/wagon-scm/src/site/apt/usage.apt   (with props)
    maven/sandbox/wagon-scm/src/site/site.xml   (with props)

Added: maven/sandbox/wagon-scm/src/site/apt/index.apt
URL: http://svn.apache.org/viewcvs/maven/sandbox/wagon-scm/src/site/apt/index.apt?rev=384311&view=auto
==============================================================================
--- maven/sandbox/wagon-scm/src/site/apt/index.apt (added)
+++ maven/sandbox/wagon-scm/src/site/apt/index.apt Wed Mar  8 11:53:47 2006
@@ -0,0 +1,31 @@
+ ------
+ Maven Wagon SCM
+ ------
+ Carlos Sanchez
+ ------
+ 7 March 2006
+ ------
+
+Maven Wagon SCM
+
+ This project is an implementation of Wagon provider for SCM (Source Control Management) systems,
+ using {{{http://maven.apache.org/scm}Maven SCM}}.
+ 
+ It enables Maven to use remote repositories stored in SCM systems (Subversion, CVS, ...)
+ and to store Maven sites in SCMs.
+
+
+Features
+
+ * Deploy files and directories to several SCM using Maven SCM (only tested with CVS and SVN)
+ 
+ * Get files from several SCM using Maven SCM (only tested with CVS and SVN)
+
+
+Known issues
+
+ * If the file is changed by the SCM the checksum calculation may not work
+
+   * SVN: when a file has properties svn:eol-style or svn:keywords set
+
+   * CVS: when keywords are expanded

Propchange: maven/sandbox/wagon-scm/src/site/apt/index.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/sandbox/wagon-scm/src/site/apt/index.apt
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"

Added: maven/sandbox/wagon-scm/src/site/apt/usage.apt
URL: http://svn.apache.org/viewcvs/maven/sandbox/wagon-scm/src/site/apt/usage.apt?rev=384311&view=auto
==============================================================================
--- maven/sandbox/wagon-scm/src/site/apt/usage.apt (added)
+++ maven/sandbox/wagon-scm/src/site/apt/usage.apt Wed Mar  8 11:53:47 2006
@@ -0,0 +1,91 @@
+ ------
+ Maven Wagon SCM
+ ------
+ Carlos Sanchez
+ ------
+ 7 March 2006
+ ------
+
+Maven Wagon SCM Usage
+
+ You need to add some extensions
+ (wagon-scm, maven-scm-manager-plexus and the maven-scm-provider for your SCM system, see examples below)
+ to your pom and use URLs in the
+ {{{http://maven.apache.org/scm/scm-url-format.html}SCM format}}.
+
+
+Deploying your Maven site to Subversion
+
+ Add the following extensions to your pom and use a wagon-scm url in the distributionManagement site url.
+
+------
+  <build>
+    <extensions>
+      <extension>
+        <groupId>org.apache.maven.wagon</groupId>
+        <artifactId>wagon-scm</artifactId>
+        <version>1.0-alpha-7-SNAPSHOT</version>
+      </extension>
+      <extension>
+        <groupId>org.apache.maven.scm</groupId>
+        <artifactId>maven-scm-manager-plexus</artifactId>
+        <version>1.0-beta-3-SNAPSHOT</version>
+      </extension>
+      <extension>
+        <groupId>org.apache.maven.scm</groupId>
+        <artifactId>maven-scm-provider-svnexe</artifactId>
+        <version>1.0-beta-3-SNAPSHOT</version>
+      </extension>
+    </extensions>
+  </build>
+  <distributionManagement>
+    <site>
+      <id>my.svn.server</id>
+      <url>scm:svn:https://username@svn.apache.org/svn/root/module</url>
+    </site>
+  </distributionManagement>
+------
+
+
+Deploying your Maven site to CVS
+
+ Same as before, but changing svnexe to cvsexe and using a CVS svn url.
+
+------
+  <build>
+    <extensions>
+      <extension>
+        <groupId>org.apache.maven.wagon</groupId>
+        <artifactId>wagon-scm</artifactId>
+        <version>1.0-alpha-7-SNAPSHOT</version>
+      </extension>
+      <extension>
+        <groupId>org.apache.maven.scm</groupId>
+        <artifactId>maven-scm-manager-plexus</artifactId>
+        <version>1.0-beta-3-SNAPSHOT</version>
+      </extension>
+      <extension>
+        <groupId>org.apache.maven.scm</groupId>
+        <artifactId>maven-scm-provider-cvsexe</artifactId>
+        <version>1.0-beta-3-SNAPSHOT</version>
+      </extension>
+    </extensions>
+  </build>
+  <distributionManagement>
+    <site>
+      <id>my.cvs.server</id>
+      <url>scm:cvs:ext:username@cvs.apache.org:/cvs/root:module</url>
+    </site>
+  </distributionManagement>
+------
+
+
+
+Using a Subversion based remote repository in Maven 2
+
+ Not tested yet
+
+
+Using a CVS based remote repository in Maven 2
+
+ Not tested yet

Propchange: maven/sandbox/wagon-scm/src/site/apt/usage.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/sandbox/wagon-scm/src/site/apt/usage.apt
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"

Added: maven/sandbox/wagon-scm/src/site/site.xml
URL: http://svn.apache.org/viewcvs/maven/sandbox/wagon-scm/src/site/site.xml?rev=384311&view=auto
==============================================================================
--- maven/sandbox/wagon-scm/src/site/site.xml (added)
+++ maven/sandbox/wagon-scm/src/site/site.xml Wed Mar  8 11:53:47 2006
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="Wagon">
+  <bannerLeft>
+    <name>Wagon</name>
+    <src>http://maven.apache.org/maven2/images/apache-maven-project-2.png</src>
+    <href>http://maven.apache.org/wagon</href>
+  </bannerLeft>
+  <bannerRight>
+    <src>http://maven.apache.org/maven2/images/maven-logo-2.gif</src>
+  </bannerRight>
+  <body>
+    <links>
+      <item name="Apache" href="http://www.apache.org/"/>
+      <item name="Maven 1.x" href="http://maven.apache.org/maven-1.x"/>
+      <item name="Maven 2.x" href="http://maven.apache.org/"/>
+      <item name="Continuum" href="http://maven.apache.org/continuum"/>
+      <item name="SCM" href="http://maven.apache.org/scm"/>
+      <item name="Wagon" href="http://maven.apache.org/wagon"/>
+      <item name="JXR" href="http://maven.apache.org/jxr"/>
+    </links>
+    <menu name="Documentation">
+      <item name="Usage" href="usage.html"/>
+    </menu>
+    <menu name="Providers">
+      <item name="File" href="/wagon-file/"/>
+      <item name="FTP"  href="/wagon-ftp/"/>
+      <item name="HTTP" href="/wagon-http/"/>
+      <item name="HTTP lightweight" href="/wagon-http-lightweight/"/>
+      <item name="SSH"  href="/wagon-ssh/"/>
+      <item name="SSH external" href="/wagon-ssh-external/"/>
+      <item name="SCM" href="/wagon-scm/"/>
+    </menu>
+
+    ${reports}
+  </body>
+</project>

Propchange: maven/sandbox/wagon-scm/src/site/site.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/sandbox/wagon-scm/src/site/site.xml
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"