From d8285a9c53b19c186b5f7e6b21457a97701867c4 Mon Sep 17 00:00:00 2001
From: ltheussl
Date: Wed, 5 Apr 2006 20:22:38 +0000
Subject: [PATCH] Use maven-scm-provider-cvs maven-scm-provider-svn in
scm-usage page.
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@391782 13f79535-47bb-0310-9956-ffa450edef68
---
xdoc/project.xml | 10 +
.../org/apache/maven/xdoc/util/ScmUtil.java | 154 +++++++++++++++
.../plugin-resources/templates/cvs-usage.xml | 180 ------------------
.../plugin-resources/templates/scm/cvs.xml | 17 +-
.../plugin-resources/templates/scm/svn.xml | 16 +-
5 files changed, 181 insertions(+), 196 deletions(-)
delete mode 100644 xdoc/src/plugin-resources/templates/cvs-usage.xml
diff --git a/xdoc/project.xml b/xdoc/project.xml
index a393bd08..d8e8ee94 100644
--- a/xdoc/project.xml
+++ b/xdoc/project.xml
@@ -273,6 +273,16 @@
maven-scm-api
1.0-beta-2
+
+ org.apache.maven.scm
+ maven-scm-provider-cvs
+ 1.0-beta-2
+
+
+ org.apache.maven.scm
+ maven-scm-provider-svn
+ 1.0-beta-2
+
org.apache.maven.scm
maven-scm-provider-perforce
diff --git a/xdoc/src/main/org/apache/maven/xdoc/util/ScmUtil.java b/xdoc/src/main/org/apache/maven/xdoc/util/ScmUtil.java
index a8ec5d2e..a1f463bf 100644
--- a/xdoc/src/main/org/apache/maven/xdoc/util/ScmUtil.java
+++ b/xdoc/src/main/org/apache/maven/xdoc/util/ScmUtil.java
@@ -21,6 +21,10 @@ import java.util.ArrayList;
import java.util.List;
import org.apache.commons.lang.StringUtils;
+import org.apache.maven.scm.provider.cvslib.CvsScmProvider;
+import org.apache.maven.scm.provider.cvslib.repository.CvsScmProviderRepository;
+import org.apache.maven.scm.provider.svn.SvnScmProvider;
+import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;
import org.apache.maven.scm.provider.clearcase.ClearCaseScmProvider;
import org.apache.maven.scm.provider.clearcase.repository.ClearCaseScmProviderRepository;
import org.apache.maven.scm.provider.perforce.PerforceScmProvider;
@@ -136,6 +140,156 @@ public final class ScmUtil {
}
}
+ /**
+ * Create the documentation to provide an anonymous access with a CVS SCM.
+ * For example, generate the following command line:
+ * cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login
+ * cvs -z3 -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic co maven-plugins/dist
+ *
+ * @param cvsRepo
+ * @see https://www.cvshome.org/docs/manual/cvs-1.12.12/cvs_16.html#SEC115
+ */
+ public String anonymousAccessCVS( String connection )
+ {
+
+ char delim = getSCMConnectionSeparator(connection).charAt(0);
+
+ CvsScmProvider cvsProvider = new CvsScmProvider();
+ CvsScmProviderRepository cvsRepo;
+
+ String scmSpecificUrl = connection.substring(8);
+
+ try {
+ cvsRepo = (CvsScmProviderRepository) cvsProvider
+ .makeProviderScmRepository(scmSpecificUrl, delim);
+ } catch (ScmRepositoryException e) {
+ System.err
+ .println("Your developerConnection does not seem to be valid: "
+ + e.getMessage());
+ return "";
+ }
+
+ StringBuffer command = new StringBuffer();
+ command.append( "cvs -d " ).append( cvsRepo.getCvsRoot() ).append( " login" );
+ command.append( "\n" );
+ command.append( "cvs -z3 -d " ).append( cvsRepo.getCvsRoot() );
+ command.append( " co " ).append( cvsRepo.getModule() );
+
+ return command.toString();
+ }
+
+ /**
+ * Create the documentation to provide an developer access with a CVS SCM.
+ * For example, generate the following command line:
+ * export CVS_RSH=ssh
+ * cvs -z3 -d :ext:username@cvs.apache.org:/home/cvs co maven-plugins/dist
+ *
+ * @param cvsRepo
+ * @see https://www.cvshome.org/docs/manual/cvs-1.12.12/cvs_16.html#SEC115
+ */
+ public String developerAccessCVS( String devConnection )
+ {
+
+ char delim = getSCMConnectionSeparator(devConnection).charAt(0);
+
+ CvsScmProvider cvsProvider = new CvsScmProvider();
+ CvsScmProviderRepository cvsRepo;
+
+ String scmSpecificUrl = devConnection.substring(8);
+
+ try {
+ cvsRepo = (CvsScmProviderRepository) cvsProvider
+ .makeProviderScmRepository(scmSpecificUrl, delim);
+ } catch (ScmRepositoryException e) {
+ System.err
+ .println("Your developerConnection does not seem to be valid: "
+ + e.getMessage());
+ return "";
+ }
+
+
+ // Safety: remove the username if present
+ String cvsRoot = StringUtils.replace( cvsRepo.getCvsRoot(), cvsRepo.getUser(), "username" );
+
+ StringBuffer command = new StringBuffer();
+ command.append( "export CVS_RSH=ssh" );
+ command.append( "\n" );
+ command.append( "cvs -z3 -d " ).append( cvsRoot ).append( " co " ).append( cvsRepo.getModule() );
+
+ return command.toString();
+ }
+
+ /**
+ * Create the documentation to provide an anonymous access with a SVN SCM.
+ * For example, generate the following command line:
+ * svn checkout http://svn.apache.org/repos/asf/maven/components/trunk maven
+ *
+ * @param svnRepo
+ * @see http://svnbook.red-bean.com/
+ */
+ public String anonymousAccessSVN( String connection, String checkoutDirectoryName )
+ {
+
+ char delim = getSCMConnectionSeparator(connection).charAt(0);
+
+ SvnScmProvider svnProvider = new SvnScmProvider();
+ SvnScmProviderRepository svnRepo;
+
+ String scmSpecificUrl = connection.substring(8);
+
+ try {
+ svnRepo = (SvnScmProviderRepository) svnProvider
+ .makeProviderScmRepository(scmSpecificUrl, delim);
+ } catch (ScmRepositoryException e) {
+ System.err
+ .println("Your developerConnection does not seem to be valid: "
+ + e.getMessage());
+ return "";
+ }
+
+ StringBuffer command = new StringBuffer();
+ command.append( "svn checkout " ).append( svnRepo.getUrl() ).append( " " ).append( checkoutDirectoryName );
+
+ return command.toString();
+ }
+
+ /**
+ * Create the documentation to provide an developer access with a SVN SCM.
+ * For example, generate the following command line:
+ * svn checkout https://svn.apache.org/repos/asf/maven/components/trunk maven
+ * svn commit --username your-username -m "A message"
+ *
+ * @param svnRepo
+ * @see http://svnbook.red-bean.com/
+ */
+ public String developerAccessSVN( String devConnection, String checkoutDirectoryName )
+ {
+
+ char delim = getSCMConnectionSeparator(devConnection).charAt(0);
+
+ SvnScmProvider svnProvider = new SvnScmProvider();
+ SvnScmProviderRepository svnRepo;
+
+ String scmSpecificUrl = devConnection.substring(8);
+
+ try {
+ svnRepo = (SvnScmProviderRepository) svnProvider
+ .makeProviderScmRepository(scmSpecificUrl, delim);
+ } catch (ScmRepositoryException e) {
+ System.err
+ .println("Your developerConnection does not seem to be valid: "
+ + e.getMessage());
+ return "";
+ }
+
+ StringBuffer command = new StringBuffer();
+
+ command.append( "svn checkout " ).append( svnRepo.getUrl() ).append( " " ).append( checkoutDirectoryName );
+
+ return command.toString();
+ }
+
+
/**
* Create the documentation to provide an developer access with a
* Perforce SCM. For example, generate the following command
diff --git a/xdoc/src/plugin-resources/templates/cvs-usage.xml b/xdoc/src/plugin-resources/templates/cvs-usage.xml
deleted file mode 100644
index e72e1125..00000000
--- a/xdoc/src/plugin-resources/templates/cvs-usage.xml
+++ /dev/null
@@ -1,180 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
- #set ($repository = $project.repository)
-
- #if (!$repository)
-
- #else
- #if ($repository.url && $repository.url != '')
- #set ($url = $escape.getText($repository.url))
-
- #end
-
- #if ($repository.connection && $repository.connection != '')
- #set ($connscm = $scmUtil.getScmType($repository.connection))
-
- #if ($connscm == 'cvs')
- #set ($conn = $scmUtil.getCvsConnection($repository.connection, ''))
- #set ($module = $scmUtil.getCvsModule($repository.connection))
-
-
-
-
-
-
-
-
-
- cvs -d $conn login
-
- cvs -z3 -d $conn co $module
-
-
-
-
-
-
- #end
- #end
-
- #if ($repository.developerConnection && $repository.developerConnection != '')
- #set ($connscm = $scmUtil.getScmType($repository.developerConnection))
-
- #if ($connscm == 'cvs')
- #set ($conn = $scmUtil.getCvsConnection($repository.developerConnection, 'username'))
- #set ($module = $scmUtil.getCvsModule($repository.developerConnection))
- #set ($server = $scmUtil.getCvsServer($repository.developerConnection))
-
-
-
-
-
-
-
-
-
-
- export CVS_RSH=ssh
-
- cvs -z3 -d $conn co $module
-
-
-
-
-
-
-
- #end
- #end
-
- #if ($repository.url && $repository.url != '' && $repository.connection && $repository.connection != '')
- #set ($connscm = $scmUtil.getScmType($repository.connection))
-
- #if ($connscm == 'cvs')
-
- #end
- #end
- #end
-
-
diff --git a/xdoc/src/plugin-resources/templates/scm/cvs.xml b/xdoc/src/plugin-resources/templates/scm/cvs.xml
index 19180a5e..58affbbe 100644
--- a/xdoc/src/plugin-resources/templates/scm/cvs.xml
+++ b/xdoc/src/plugin-resources/templates/scm/cvs.xml
@@ -11,7 +11,6 @@
#if ($repository.connection && $repository.connection != '')
- #set ($connscm = $scmUtil.getScmType($repository.connection))
#set ($conn = $scmUtil.getCvsConnection($repository.connection, ''))
#set ($module = $scmUtil.getCvsModule($repository.connection))
@@ -27,12 +26,14 @@
+ #set ($command = $scmUtil.anonymousAccessCVS($repository.connection))
+
@@ -41,8 +42,7 @@
bundle="plugin-resources.templates.templates" />
- cvs -d $conn login
-cvs -z3 -d $conn co $module
+ $command
#end
#if ($repository.developerConnection && $repository.developerConnection != '')
- #set ($connscm = $scmUtil.getScmType($repository.developerConnection))
#set ($conn = $scmUtil.getCvsConnection($repository.developerConnection, 'username'))
#set ($module = $scmUtil.getCvsModule($repository.developerConnection))
@@ -68,7 +67,7 @@ cvs -z3 -d $conn co $module
@@ -79,6 +78,8 @@ cvs -z3 -d $conn co $module
+ #set ($command = $scmUtil.developerAccessCVS($repository.developerConnection))
+
@@ -88,9 +89,7 @@ cvs -z3 -d $conn co $module
bundle="plugin-resources.templates.templates" />
- export CVS_RSH=ssh
-cvs -z3 -d $conn co $module
-
+ $command
#if ($repository.connection && $repository.connection != '')
- #set ($connscm = $scmUtil.getScmType($repository.connection))
#set ($svnconn = $scmUtil.getSvnConnection($repository.connection))
#set ($conn = $repository.connection)
@@ -27,12 +26,14 @@
+ #set ($command = $scmUtil.anonymousAccessSVN($repository.connection, $project.artifactId))
+
@@ -41,13 +42,12 @@
bundle="plugin-resources.templates.templates" />
- svn checkout $svnconn $project.artifactId
+ $command
#end
#if ($repository.developerConnection && $repository.developerConnection != '')
- #set ($connscm = $scmUtil.getScmType($repository.developerConnection))
#set ($svnconn = $scmUtil.getSvnConnection($repository.developerConnection))
#set ($conn = $repository.developerConnection)
@@ -63,13 +63,15 @@
+ #set ($command = $scmUtil.developerAccessSVN($repository.developerConnection, $project.artifactId))
+
@@ -79,7 +81,7 @@
bundle="plugin-resources.templates.templates" />
- svn checkout $svnconn $project.artifactId
+ $command
@@ -91,7 +93,7 @@
- svn checkout $conn $project.artifactId
+ $command