You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2022/01/08 19:50:08 UTC
[maven-scm] 02/02: Use canonical name 'Maven SCM'
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-scm.git
commit 6cf3ed02e19db47f20d95dac4a24f2c40121e67f
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Sat Jan 8 20:49:53 2022 +0100
Use canonical name 'Maven SCM'
---
src/site/apt/guide/index.apt | 2 +-
src/site/apt/guide/new_provider.apt | 20 ++++++++++----------
src/site/apt/guide/usage.apt | 6 +++---
src/site/site.xml | 2 +-
4 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/src/site/apt/guide/index.apt b/src/site/apt/guide/index.apt
index 8838f74..815bbf0 100644
--- a/src/site/apt/guide/index.apt
+++ b/src/site/apt/guide/index.apt
@@ -28,7 +28,7 @@
Guides
-* {{{./usage.html}How to use Maven-SCM in my application?}}
+* {{{./usage.html}How to use Maven SCM in my application?}}
This {{{./usage.html}document}} describe API usage for a SCM client.
diff --git a/src/site/apt/guide/new_provider.apt b/src/site/apt/guide/new_provider.apt
index 1d10177..603601a 100644
--- a/src/site/apt/guide/new_provider.apt
+++ b/src/site/apt/guide/new_provider.apt
@@ -28,7 +28,7 @@
How to write a new SCM provider?
-* What are the steps to write a new Maven-SCM provider?
+* What are the steps to write a new Maven SCM provider?
* Define allowed scm urls for this provider
@@ -59,11 +59,11 @@ How to write a new SCM provider?
[]
In the next section, we'll see all the steps in details to write a new
- Maven-SCM provider.
+ Maven SCM provider.
* Create a new Maven project for the provider
- Your project need to use some jars from the Maven-SCM framework. Add them to your POM.
+ Your project need to use some jars from the Maven SCM framework. Add them to your POM.
+------------------------------------------+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
@@ -78,7 +78,7 @@ How to write a new SCM provider?
<artifactId>maven-scm-provider-YOUR_PROVIDER_NAME</artifactId>
<version>1.0-SNAPSHOT</version>
- <name>My Maven-SCM Provider</name>
+ <name>My Maven SCM Provider</name>
<build>
<plugins>
@@ -100,7 +100,7 @@ How to write a new SCM provider?
+------------------------------------------+
The plexus-component-metadata maven plugin will generate the Plexus meta-data file used by the
- Maven-SCM manager.
+ Maven SCM manager.
* Create an SCM Provider Repository class
@@ -123,7 +123,7 @@ public class MyScmProviderRepository
* Create the Provider class
- This class is the central point of the provider. The Maven-SCM framework will
+ This class is the central point of the provider. The Maven SCM framework will
know only this class in the provider, so this class must validate the scm
url, populate the <<<ScmProviderRepository>>> and provide all commands
supported by your provider. We start with a basic class, then we'll add
@@ -175,8 +175,8 @@ public class MyScmProvider
* Commands implementation
When you write a new SCM command, you must extend base classes for the
- Maven-SCM framework. We have one base command for each command supported by
- Maven-SCM and each command have an <<<execute>>> method that return an SCM
+ Maven SCM framework. We have one base command for each command supported by
+ Maven SCM and each command have an <<<execute>>> method that return an SCM
result.
+------------------------------------------+
@@ -233,12 +233,12 @@ public class MyScmProvider
line you launch in your SCM command is correct
* Implementation of the TCK. The TCK provides a set of tests that validate
- that your implementation is compatible with the Maven-SCM framework. The
+ that your implementation is compatible with the Maven SCM framework. The
TCK requires access to the SCM tool.
** Other tests
- You can do manual tests in the real world with the Maven-SCM plugin,
+ You can do manual tests in the real world with the Maven SCM plugin,
the maven release plugin, the maven changelog plugin and Continuum.
It's important to test your SCM provider with these tools, because they are
diff --git a/src/site/apt/guide/usage.apt b/src/site/apt/guide/usage.apt
index 2b9549e..be9af83 100644
--- a/src/site/apt/guide/usage.apt
+++ b/src/site/apt/guide/usage.apt
@@ -1,5 +1,5 @@
------
- How to use Maven-SCM in my application
+ How to use Maven SCM in my application
------
Maven Team
------
@@ -26,7 +26,7 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-How to use Maven-SCM in my application?
+How to use Maven SCM in my application?
* Create an SCM Manager
@@ -209,4 +209,4 @@ public class MyApp
* Sample code
The code above is available here:
- {{{http://svn.apache.org/repos/asf/maven/scm/trunk/maven-scm-client/}Maven-SCM client}}.
+ {{{http://svn.apache.org/repos/asf/maven/scm/trunk/maven-scm-client/}Maven SCM client}}.
diff --git a/src/site/site.xml b/src/site/site.xml
index d7a51d3..b6a6a15 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -36,7 +36,7 @@
<item name="Subversion" href="/subversion.html"/>
</item>
<item name="Guides" href="/guide/index.html" collapse="true">
- <item name="How to use Maven-SCM in my application" href="/guide/usage.html"/>
+ <item name="How to use Maven SCM in my application" href="/guide/usage.html"/>
<item name="How to write a new SCM provider" href="/guide/new_provider.html"/>
</item>
<item name="SCM Providers Matrix" href="/matrix.html"/>