You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kw...@apache.org on 2025/08/01 12:27:00 UTC
(maven-scm) 02/02: Migrate to Markdown format
This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch feature/apt-to-md
in repository https://gitbox.apache.org/repos/asf/maven-scm.git
commit 8bf953e5bf998ea44c5d7798182001d6154c45fc
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Fri Aug 1 14:26:07 2025 +0200
Migrate to Markdown format
via "doxia-converter-1.4-SNAPSHOT-shaded.jar -from apt -to markdown -in
./apt -out ./markdown -gitMvInputToOutput"
Update to m-site-p 3.21.0 (leveraging Doxia 2) and Fluido Skin 2.1.0
---
.../scm/provider/git/jgit/command/JGitUtils.java | 2 +-
pom.xml | 2 +
src/site/markdown/git.md | 124 ++++++-------
src/site/markdown/guide/define_provider.md | 88 ++++-----
src/site/markdown/guide/index.md | 60 +++---
src/site/markdown/guide/new_provider.md | 201 ++++++++-------------
src/site/markdown/guide/usage.md | 121 ++++++-------
src/site/markdown/index.md | 67 +++----
src/site/markdown/local.md | 93 +++++-----
src/site/markdown/mercurial.md | 97 +++++-----
src/site/markdown/scm-commands.md | 98 +++++-----
src/site/markdown/scm-url-format.md | 80 ++++----
src/site/markdown/scms-overview.md | 76 ++++----
src/site/markdown/subversion.md | 103 +++++------
14 files changed, 552 insertions(+), 660 deletions(-)
diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/JGitUtils.java b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/JGitUtils.java
index 17a0e6664..7a7bdd8e0 100644
--- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/JGitUtils.java
+++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/src/main/java/org/apache/maven/scm/provider/git/jgit/command/JGitUtils.java
@@ -98,7 +98,7 @@ public static Git openRepo(File basedir) throws IOException {
.readEnvironment()
.findGitDir(basedir)
.setMustExist(true)
- .build());
+ .build(), true);
}
/**
diff --git a/pom.xml b/pom.xml
index bb6a67a0f..ecff8482d 100644
--- a/pom.xml
+++ b/pom.xml
@@ -175,6 +175,8 @@
<checkstyle.violation.ignore>RedundantThrows,NewlineAtEndOfFile,ParameterNumber,MethodLength,FileLength,InnerAssignment,MagicNumber</checkstyle.violation.ignore>
<checkstyle.failOnViolation>true</checkstyle.failOnViolation>
<project.build.outputTimestamp>2024-04-11T12:24:41Z</project.build.outputTimestamp>
+ <version.maven-fluido-skin>2.1.0</version.maven-fluido-skin>
+ <version.maven-site-plugin>3.21.0</version.maven-site-plugin>
</properties>
<dependencyManagement>
diff --git a/src/site/markdown/git.md b/src/site/markdown/git.md
index 29ba12517..37fa336c5 100644
--- a/src/site/markdown/git.md
+++ b/src/site/markdown/git.md
@@ -1,83 +1,79 @@
- ------
- SCM Implementation: Git
- ------
- Olivier Lamy
- ------
- 2008-08-10
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-SCM Implementation: Git
-
-* General Info
-
- Link: {{http://git-scm.com/}}
-
- License: GNU General Public License v2
-
-* SCM URL
-
- For all URLs below, we use a colon (:) as separator. If you use a colon for one of the variables (e.g. a windows path), then use a pipe (|) as separator. The separator for the port has to be a colon in any case since this part is specified in the git URL specification. See man git-fetch.
-
--------
+---
+title: SCM Implementation: Git
+author:
+ - Olivier Lamy
+date: 2008-08-10
+---
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+<!-- NOTE: For help with the syntax of this file, see:-->
+<!-- http://maven.apache.org/doxia/references/apt-format.html-->
+# SCM Implementation: Git
+
+## General Info
+
+Link: [http://git-scm.com/](http://git-scm.com/)
+
+License: GNU General Public License v2
+
+## SCM URL
+
+For all URLs below, we use a colon \(:\) as separator. If you use a colon for one of the variables \(e.g. a windows path\), then use a pipe \(|\) as separator. The separator for the port has to be a colon in any case since this part is specified in the git URL specification. See man git-fetch.
+
+```
scm:git:git://server_name[:port]/path_to_repository
scm:git:http://server_name[:port]/path_to_repository
scm:git:https://server_name[:port]/path_to_repository
scm:git:ssh://server_name[:port]/path_to_repository
scm:git:file://[hostname]/path_to_repository
--------
+```
- * Examples
+- Examples
--------
-scm:git:git://github.com/path_to_repository
-scm:git:http://github.com/path_to_repository
-scm:git:https://github.com/path_to_repository
-scm:git:ssh://github.com/path_to_repository
-scm:git:file://localhost/path_to_repository
--------
+ ```
+ scm:git:git://github.com/path_to_repository
+ scm:git:http://github.com/path_to_repository
+ scm:git:https://github.com/path_to_repository
+ scm:git:ssh://github.com/path_to_repository
+ scm:git:file://localhost/path_to_repository
+ ```
-* Different Fetch and Push URLs
+## Different Fetch and Push URLs
- In some cases a different URL has to be used for read and write operations. This can happen if e.g. fetch is performed via the http protocol, but writing to the repository is only possible via ssh. In this case both URLs may be written into the <developerConnection> tag. The fetch URL has to be prefixed with <<<[fetch=]>>> and the push URL with <<<[push=]>>>
+In some cases a different URL has to be used for read and write operations. This can happen if e.g. fetch is performed via the http protocol, but writing to the repository is only possible via ssh. In this case both URLs may be written into the _developerConnection_ tag. The fetch URL has to be prefixed with `[fetch=]` and the push URL with `[push=]`
- * Example:
+- Example:
--------
-<developerConnection>scm:git:[fetch=]http://mywebserver.org/path_to_repository[push=]ssh://username@otherserver:8898/~/repopath.git</developerConnection>
--------
+ ```
+ <developerConnection>scm:git:[fetch=]http://mywebserver.org/path_to_repository[push=]ssh://username@otherserver:8898/~/repopath.git</developerConnection>
+ ```
-* Working with branches
+## Working with branches
- Since version 1.3, we assume that the name of the branch in the upstream repo is the same as the name of the current local branch. So whenever you invoke a maven-scm action which has to access the upstream repository, e.g. start a release, you should be on that very branch.
+Since version 1\.3, we assume that the name of the branch in the upstream repo is the same as the name of the current local branch. So whenever you invoke a maven-scm action which has to access the upstream repository, e.g. start a release, you should be on that very branch.
- In other words: If no branch is specified manually, every git-fetch, git-pull, git-push, etc will always work on the branch in the upstream repository which has the same branch name as your current local branch
+In other words: If no branch is specified manually, every git-fetch, git-pull, git-push, etc will always work on the branch in the upstream repository which has the same branch name as your current local branch
--------
+```
git push pushUrl currentBranch:currentBranch
--------
+```
+## Provider Configuration
-* Provider Configuration
+The provider configuration is defined in `${user.home}/.scm/git-settings.xml`. For more information see the [reference guide](./maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/git-settings.html).
- The provider configuration is defined in <<<$\{user.home\}/.scm/git-settings.xml>>>.
- For more information see the {{{./maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/git-settings.html}reference guide}}.
diff --git a/src/site/markdown/guide/define_provider.md b/src/site/markdown/guide/define_provider.md
index 3e90c41f6..f064478bc 100644
--- a/src/site/markdown/guide/define_provider.md
+++ b/src/site/markdown/guide/define_provider.md
@@ -1,59 +1,48 @@
- ------
- How to define a non Apache Maven hosted implementation
- ------
- Maven Team
- ------
- 2013-09-07
- ------
+---
+title: How to define a non Apache Maven hosted implementation
+author:
+ - Maven Team
+date: 2013-09-07
+---
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+<!-- NOTE: For help with the syntax of this file, see:-->
+<!-- http://maven.apache.org/doxia/references/apt-format.html-->
+# How to define a non Apache Maven hosted implementation?
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
+Apache Maven supports a lot of implementations, but not all. However, with the following steps you can make Maven use this implementation for all your projects.
-How to define a non Apache Maven hosted implementation?
+## Prepare Maven
- Apache Maven supports a lot of implementations, but not all.
- However, with the following steps you can make Maven use this implementation for all your projects.
+Make the SCM implementation available for Maven by downloading the required jars and add them to Maven. If there's a `jar-with-dependencies` or a `shaded jar`, then that's the only jar required. Otherwise check the project for all transitive dependencies.
-* Prepare Maven
+- Maven 3\.x : Add jars to `%M2_HOME%/lib/ext/`
+- Maven 2\.x : Add jars to `%M2_HOME%/lib/`
- Make the SCM implementation available for Maven by downloading the required jars and add them to Maven.
- If there's a <<<jar-with-dependencies>>> or a <<<shaded jar>>>, then that's the only jar required.
- Otherwise check the project for all transitive dependencies.
-
- * Maven 3.x : Add jars to <<<%M2_HOME%/lib/ext/>>>
-
- * Maven 2.x : Add jars to <<<%M2_HOME%/lib/>>>
-
- []
+**Note:**Be aware that these jars now end up next to the root classloader of Maven. If you experience unexpected behavior, verify there's no class collision.
- <<Note:>>Be aware that these jars now end up next to the root classloader of Maven.
- If you experience unexpected behavior, verify there's no class collision.
+## Configure settings.xml
-* Configure settings.xml
+Since it is very well possible to have multiple versions of Maven next to each other, the preferred `settings.xml` to adjust is the instance with the additional jars.
- Since it is very well possible to have multiple versions of Maven next to each other,
- the preferred <<<settings.xml>>> to adjust is the instance with the additional jars.
-
- <<<%M2_HOME%/conf/settings.xml>>>
-
-------------------------------------------
+`%M2_HOME%/conf/settings.xml`
+
+```
<settings>
...
<profiles>
@@ -72,6 +61,7 @@ How to define a non Apache Maven hosted implementation?
</activeProfiles>
</settings>
-------------------------------------------
+```
+
+From now on when this Maven instance is used, it will always use the specified SCM provider implementation.
- From now on when this Maven instance is used, it will always use the specified SCM provider implementation.
diff --git a/src/site/markdown/guide/index.md b/src/site/markdown/guide/index.md
index 815bbf01a..d4c05d3e4 100644
--- a/src/site/markdown/guide/index.md
+++ b/src/site/markdown/guide/index.md
@@ -1,37 +1,35 @@
- ------
- Guides
- ------
- Maven Team
- ------
- 2007-03-12
- ------
+---
+title: Guides
+author:
+ - Maven Team
+date: 2007-03-12
+---
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+<!-- NOTE: For help with the syntax of this file, see:-->
+<!-- http://maven.apache.org/doxia/references/apt-format.html-->
+# Guides
-~~ 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?](./usage.html)
-Guides
+This [document](./usage.html) describe API usage for a SCM client.
-* {{{./usage.html}How to use Maven SCM in my application?}}
+## [How to write a new SCM provider?](./new_provider.html)
- This {{{./usage.html}document}} describe API usage for a SCM client.
+This [document](./new_provider.html) describe step by step the implementation of a new SCM provider.
-* {{{./new_provider.html}How to write a new SCM provider?}}
-
- This {{{./new_provider.html}document}} describe step by step the implementation of a new SCM provider.
diff --git a/src/site/markdown/guide/new_provider.md b/src/site/markdown/guide/new_provider.md
index e770a8796..e02594b45 100644
--- a/src/site/markdown/guide/new_provider.md
+++ b/src/site/markdown/guide/new_provider.md
@@ -1,71 +1,49 @@
- ------
- How to write a new SCM provider
- ------
- Maven Team
- ------
- 2007-03-27
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-How to write a new SCM provider?
-
-* What are the steps to write a new Maven SCM provider?
-
- * Define allowed scm urls for this provider
-
- * Create a class that extends <<<org.apache.maven.scm.provider.ScmProviderRepository>>>
- or <<<org.apache.maven.scm.provider.ScmProviderRepositoryWithHost>>>, this class
- is the corresponding bean of the scm url
-
- * Create a class that extends <<<org.apache.maven.scm.provider.AbstractScmProvider>>>.
- This class parse the scm url and link all scm commands methods to their
- implementations. Important methods are <<<makeProviderScmRepository()>>>
- and <<<validateScmUrl()>>>
-
- * Implement all commands and link them in the scm provider class created in
- the step above
-
- * For each command, implement junit tests that test the command line format
-
- * For each command, implement TCK tests
-
- * Test the release plugin with the new provider. For that, you must add the
- dependency to the release plugin and run it
-
- * Add the dependency to Continuum libs and test the provider with a sample
- project
-
- * Update the site
-
- []
-
- In the next section, we'll see all the steps in details to write a new
- 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.
-
-+------------------------------------------+
+---
+title: How to write a new SCM provider
+author:
+ - Maven Team
+date: 2007-03-27
+---
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+<!-- NOTE: For help with the syntax of this file, see:-->
+<!-- http://maven.apache.org/doxia/references/apt-format.html-->
+# How to write a new SCM provider?
+
+## What are the steps to write a new Maven SCM provider?
+
+- Define allowed scm urls for this provider
+- Create a class that extends `org.apache.maven.scm.provider.ScmProviderRepository` or `org.apache.maven.scm.provider.ScmProviderRepositoryWithHost`, this class is the corresponding bean of the scm url
+- Create a class that extends `org.apache.maven.scm.provider.AbstractScmProvider`. This class parse the scm url and link all scm commands methods to their implementations. Important methods are `makeProviderScmRepository()` and `validateScmUrl()`
+- Implement all commands and link them in the scm provider class created in the step above
+- For each command, implement junit tests that test the command line format
+- For each command, implement TCK tests
+- Test the release plugin with the new provider. For that, you must add the dependency to the release plugin and run it
+- Add the dependency to Continuum libs and test the provider with a sample project
+- Update the site
+
+In the next section, we'll see all the steps in details to write a new 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.
+
+```unknown
<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">
<modelVersion>4.0.0</modelVersion>
@@ -99,17 +77,15 @@ How to write a new SCM provider?
</plugins>
</build>
</project>
-+------------------------------------------+
+```
- The Sisu Maven Plugin will generate the components meta-data file used by the
- DI to discover them inject them to SCM manager.
+The Sisu Maven Plugin will generate the components meta-data file used by the DI to discover them inject them to SCM manager.
-* Create an SCM Provider Repository class
+## Create an SCM Provider Repository class
- This class will contain all SCM information about your SCM connection
- (user, password, host, port, path...).
+This class will contain all SCM information about your SCM connection \(user, password, host, port, path...\).
-+------------------------------------------+
+```unknown
package org.apache.maven.scm.provider.myprovider.repository;
import org.apache.maven.scm.provider.ScmProviderRepository;
@@ -118,23 +94,17 @@ public class MyScmProviderRepository
extends ScmProviderRepository
{
}
-+------------------------------------------+
+```
- Before you add more information to this class, you can look at the
- <<<ScmProviderRepository>>> sub-classes, if they are already implemented.
+Before you add more information to this class, you can look at the `ScmProviderRepository` sub-classes, if they are already implemented.
-* Create the Provider class
+## Create the Provider class
- 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
- commands to it when we implement them.
+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 commands to it when we implement them.
- Before you start to write your SCM provider, you must define the SCM URLs you
- want to support.
+Before you start to write your SCM provider, you must define the SCM URLs you want to support.
-+------------------------------------------+
+```unknown
package org.apache.maven.scm.provider.myprovider;
import org.apache.maven.scm.provider.myprovider.repository.MyScmProviderRepository;
@@ -169,21 +139,15 @@ public class MyScmProvider
return providerRepository;
}
}
-+------------------------------------------+
+```
- The JSR330 annotations will be used by the Sisu Maven Plugin,
- declared in the POM, to generate component meta-data.
- Generally, we use the string just after <scm:> in the scm URL as the
- <provider_name>.
+The JSR330 annotations will be used by the Sisu Maven Plugin, declared in the POM, to generate component meta-data. Generally, we use the string just after _scm:_ in the scm URL as the _provider\_name_.
-* Commands implementation
+## 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
- result.
+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 result.
-+------------------------------------------+
+```unknown
package org.apache.maven.scm.provider.myprovider.command.checkout;
import org.apache.maven.scm.command.checkout.AbstractCheckOutCommand;
@@ -202,15 +166,13 @@ public class MyCheckoutCommand
return result;
}
}
-+------------------------------------------+
+```
-* Allow the command in the SCM provider
+## Allow the command in the SCM provider
- Now that your command is implemented, you need to add it in your SCM provider
- (<<<MyScmProvider>>>). Open the provider class and override the method that
- relates to your command.
+Now that your command is implemented, you need to add it in your SCM provider \(`MyScmProvider`\). Open the provider class and override the method that relates to your command.
-+------------------------------------------+
+```unknown
public class MyScmProvider
extends AbstractScmProvider
{
@@ -224,32 +186,23 @@ public class MyScmProvider
return (CheckOutScmResult) command.execute( repository.getProviderRepository(), fileSet, params );
}
}
-+------------------------------------------+
-
-* Provider Tests
+```
-** Automated tests
+## Provider Tests
- To be sure your provider works as expected, you must implement some tests.
- You can implement two levels of tests:
+### Automated tests
- * Simple JUnit tests that use your command directly and test that the command
- line you launch in your SCM command is correct
+To be sure your provider works as expected, you must implement some tests. You can implement two levels of tests:
- * Implementation of the TCK. The TCK provides a set of tests that validate
- that your implementation is compatible with the Maven SCM framework. The
- TCK requires access to the SCM tool.
+- Simple JUnit tests that use your command directly and test that the command 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 TCK requires access to the SCM tool.
+### Other tests
-** Other tests
+You can do manual tests in the real world with the Maven SCM Plugin, the Maven Release Plugin, the Maven Changelog Plugin and Continuum.
- 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 used by users that will use your provider.
- It's important to test your SCM provider with these tools, because they are
- used by users that will use your provider.
+## Document your provider
-* Document your provider
+Now that your provider works fine, you must document it \(which scm URLs are supported, which commands are supported...\). You can use the same template that is used by the other providers.
- Now that your provider works fine, you must document it (which scm URLs are
- supported, which commands are supported...). You can use the same template
- that is used by the other providers.
diff --git a/src/site/markdown/guide/usage.md b/src/site/markdown/guide/usage.md
index be9af836f..756998d03 100644
--- a/src/site/markdown/guide/usage.md
+++ b/src/site/markdown/guide/usage.md
@@ -1,42 +1,37 @@
- ------
- How to use Maven SCM in my application
- ------
- Maven Team
- ------
- 2007-03-26
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ 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?
-
-* Create an SCM Manager
-
-** With Plexus IOC
-
- With {{{http://codehaus-plexus.github.io/}Plexus}}, it's very easy to use Maven SCM
- because it injects all dependencies in fields, so you only have to write
- minimal code.
-
-+------------------------------------------+
+---
+title: How to use Maven SCM in my application
+author:
+ - Maven Team
+date: 2007-03-26
+---
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+<!-- 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?
+
+## Create an SCM Manager
+
+### With Plexus IOC
+
+With [Plexus](http://codehaus-plexus.github.io/), it's very easy to use Maven SCM because it injects all dependencies in fields, so you only have to write minimal code.
+
+```unknown
import org.apache.maven.scm.manager.ScmManager;
public class MyApp
@@ -56,15 +51,13 @@ public class MyApp
{
return scmManager;
}
-+------------------------------------------+
+```
+### Without Plexus IOC
-** Without Plexus IOC
+Without Plexus, you must add all your SCM providers in the manager and that will require more work. You can use the basic SCM manager or write your own:
- Without Plexus, you must add all your SCM providers in the manager and that
- will require more work. You can use the basic SCM manager or write your own:
-
-+------------------------------------------+
+```unknown
import org.apache.maven.scm.manager.BasicScmManager;
public class MyApp
@@ -85,14 +78,13 @@ public class MyApp
{
return scmManager;
}
-+------------------------------------------+
+```
-* Run a SCM command
+## Run a SCM command
- Before you call a command, the SCM manager needs an <<<ScmRepository>>>. This
- object contains all the information about the SCM connection.
+Before you call a command, the SCM manager needs an `ScmRepository`. This object contains all the information about the SCM connection.
-+------------------------------------------+
+```unknown
public ScmRepository getScmRepository( String scmUrl )
throw Exception
{
@@ -111,11 +103,11 @@ public class MyApp
throw new Exception( "Error while connecting to the repository", ex );
}
}
-+------------------------------------------+
+```
-** Checkout command
+### Checkout command
-+------------------------------------------+
+```unknown
public void checkOut( ScmRepository scmRepository, File workingDirectory )
throws ScmException
{
@@ -149,11 +141,11 @@ public class MyApp
System.out.println( " " + file.getPath() );
}
}
-+------------------------------------------+
+```
-** Update command
+### Update command
-+------------------------------------------+
+```unknown
public void update( ScmRepository scmRepository, File workingDirectory )
throws ScmException
{
@@ -179,14 +171,13 @@ public class MyApp
System.out.println( " " + file.getPath() );
}
}
-+------------------------------------------+
+```
-* The checkResult method
+## The checkResult method
- In each sample command code, we use the <<<checkResult>>> method, it isn't
- required but can be useful if something failed in the command execution.
+In each sample command code, we use the `checkResult` method, it isn't required but can be useful if something failed in the command execution.
-+------------------------------------------+
+```unknown
public void checkResult( ScmResult result )
throws Exception
{
@@ -204,9 +195,9 @@ public class MyApp
"Command failed." + StringUtils.defaultString( result.getProviderMessage() ) );
}
}
-+------------------------------------------+
+```
+
+## Sample code
-* Sample code
+The code above is available here: [Maven SCM client](http://svn.apache.org/repos/asf/maven/scm/trunk/maven-scm-client/).
- The code above is available here:
- {{{http://svn.apache.org/repos/asf/maven/scm/trunk/maven-scm-client/}Maven SCM client}}.
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index f2c9c1184..927aa3150 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -1,42 +1,33 @@
- ------
- Home
- ------
- Wim Deblauwe
- ------
- 2013-10-27
- ------
+---
+title: Home
+author:
+ - Wim Deblauwe
+date: 2013-10-27
+---
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+<!-- NOTE: For help with the syntax of this file, see:-->
+<!-- http://maven.apache.org/doxia/references/apt-format.html-->
+# Maven SCM
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
+Maven SCM supports Maven plugins \(for example [maven-release-plugin](https://maven.apache.org/plugins/maven-release-plugin/)\) and other tools by providing them with [a common API](./maven-scm-api/apidocs) for source code management operations. You can look at [the list of SCMs](./scms-overview.html) for more information on using Maven SCM with your favorite SCM tool.
-Maven SCM
+In addition, Maven SCM provides two tools to directly use it:
- Maven SCM supports Maven plugins (for example
- {{{https://maven.apache.org/plugins/maven-release-plugin/}maven-release-plugin}})
- and other tools by providing them with {{{./maven-scm-api/apidocs}a common API}} for
- source code management operations. You can look at
- {{{./scms-overview.html}the list of SCMs}} for more information on using
- Maven SCM with your favorite SCM tool.
-
- In addition, Maven SCM provides two tools to directly use it:
-
- * {{{./maven-scm-plugin}<<<maven-scm-plugin>>>}}: a Maven plugin, where each SCM command is implemented as a plugin goal,
-
- * {{{./maven-scm-client}<<<maven-scm-client>>>}}: a simple SCM command line tool.
+- [`maven-scm-plugin`](./maven-scm-plugin): a Maven plugin, where each SCM command is implemented as a plugin goal,
+- [`maven-scm-client`](./maven-scm-client): a simple SCM command line tool.
diff --git a/src/site/markdown/local.md b/src/site/markdown/local.md
index f9d7e031b..2b855f976 100644
--- a/src/site/markdown/local.md
+++ b/src/site/markdown/local.md
@@ -1,55 +1,52 @@
- ------
- SCM Implementation: File System
- ------
- Wim Deblauwe
- ------
- 2005-12-01
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-SCM Implementation: File System
-
-* General Info
-
- Link: -
-
- License: -
-
-* SCM URL
-
- For all URLs below, we use a colon (:) as separator. If you use a colon for one of the variables (e.g. a windows path), then use a pipe (|) as separator.
-
--------
+---
+title: SCM Implementation: File System
+author:
+ - Wim Deblauwe
+date: 2005-12-01
+---
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+<!-- NOTE: For help with the syntax of this file, see:-->
+<!-- http://maven.apache.org/doxia/references/apt-format.html-->
+# SCM Implementation: File System
+
+## General Info
+
+Link: -
+
+License: -
+
+## SCM URL
+
+For all URLs below, we use a colon \(:\) as separator. If you use a colon for one of the variables \(e.g. a windows path\), then use a pipe \(|\) as separator.
+
+```
scm:local<delimiter>path_to_repository<delimiter>module_name
--------
+```
- <path_to_repository>: The absolute or relative path to the parent directory of your pom.xml
+_path\_to\_repository_: The absolute or relative path to the parent directory of your pom.xml
- <module_name>: The name of the directory that contains your pom.xml
+_module\_name_: The name of the directory that contains your pom.xml
+## Examples
-* Examples
-
--------
+```
scm:local:/usr/modules:my_module
scm:local|C:/javaprojects|my_module
--------
+```
+
diff --git a/src/site/markdown/mercurial.md b/src/site/markdown/mercurial.md
index 255a8602d..97670523e 100644
--- a/src/site/markdown/mercurial.md
+++ b/src/site/markdown/mercurial.md
@@ -1,57 +1,54 @@
- ------
- SCM Implementation: Mercurial (hg)
- ------
- Ryan Daum
- ------
- 2007-04-12
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-SCM Implementation: Mercurial
-
-* General Info
-
- Link: {{http://www.selenic.com/mercurial/wiki/}}
-
- License: GNU General Public License
-
- "Mercurial: a fast, lightweight Source Control Management system designed for efficient handling of very large distributed projects."
-
- This provider supports version 0.9.2 and greater of Mercurial.
-
-* SCM URL
-
- Path or url to the branch location.
- Supported protocols: HTTP, HTTPS, FILE, and local path.
-
--------
+---
+title: SCM Implementation: Mercurial (hg)
+author:
+ - Ryan Daum
+date: 2007-04-12
+---
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+<!-- NOTE: For help with the syntax of this file, see:-->
+<!-- http://maven.apache.org/doxia/references/apt-format.html-->
+# SCM Implementation: Mercurial
+
+## General Info
+
+Link: [http://www.selenic.com/mercurial/wiki/](http://www.selenic.com/mercurial/wiki/)
+
+License: GNU General Public License
+
+"Mercurial: a fast, lightweight Source Control Management system designed for efficient handling of very large distributed projects."
+
+This provider supports version 0\.9\.2 and greater of Mercurial.
+
+## SCM URL
+
+Path or url to the branch location. Supported protocols: HTTP, HTTPS, FILE, and local path.
+
+```
scm:hg:url_to_repository/local_repository_directory
--------
+```
-* Examples
+## Examples
--------
+```
scm:hg:http://host/v3
scm:hg:file://C:/dev/project/v3 (windows drive)
scm:hg:file:///home/smorgrav/dev/project/v3 (linux drive)
scm:hg:/home/smorgrav/dev/project/v3 (local directory)
--------
+```
+
diff --git a/src/site/markdown/scm-commands.md b/src/site/markdown/scm-commands.md
index 2f577749a..632029f33 100644
--- a/src/site/markdown/scm-commands.md
+++ b/src/site/markdown/scm-commands.md
@@ -1,75 +1,69 @@
- ------
- SCM Commands
- ------
- Wim Deblauwe
- ------
- 2005-12-01
- ------
+---
+title: SCM Commands
+author:
+ - Wim Deblauwe
+date: 2005-12-01
+---
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+<!-- NOTE: For help with the syntax of this file, see:-->
+<!-- http://maven.apache.org/doxia/references/apt-format.html-->
+# Maven SCM Commands
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
+Maven SCM uses a exposes a fixed set of commands for it users. The providers for each SCM must implements those commands through the ScmProvider interface. This is an overview of all the commands:
-Maven SCM Commands
+## Add
- Maven SCM uses a exposes a fixed set of commands for it users. The providers for each SCM must implements those commands through
- the ScmProvider interface. This is an overview of all the commands:
+Adds a new file to the source control system
-* Add
+## Changelog
- Adds a new file to the source control system
+Produces a list of changed \(a new version has been put in the system\) files. This list can then be used to display the latest changes or the developer\(s\) who did the latest changes.
-* Changelog
+## Checkin
- Produces a list of changed (a new version has been put in the system) files. This list can then be used to display the latest changes
- or the developer(s) who did the latest changes.
+Save the changes you have done into the repository. This will create a new version of the file or directory in the repository.
-* Checkin
+## Checkout
- Save the changes you have done into the repository. This will create a new version of the file or
- directory in the repository.
+Copy \(part of\) the contents of the source control system to a certain location on your local machine. It should be possible to scm operations in that location.
-* Checkout
+## Edit
- Copy (part of) the contents of the source control system to a certain location on your local machine. It should be possible to scm operations in that location.
+Mark a file as editable with the source control system. This is used in source control systems where you look at read-only files and you need to make them not read-only anymore before you can edit them. In some scm's this means that no other user can then do an edit at the same time.
-* Edit
+## Diff
- Mark a file as editable with the source control system. This is used in source control systems where you look at read-only files
- and you need to make them not read-only anymore before you can edit them. In some scm's this means that no other user can then do an edit at the same time.
+TODO
-* Diff
+## Remove
- TODO
+Removes a file from the source control system
-* Remove
+## Status
- Removes a file from the source control system
+Gives a list of files that still need some source control operation \(files that still need to be added, files that are in edit mode, ...\)
-* Status
+## Tag
- Gives a list of files that still need some source control operation (files that still need to be added, files that are in edit mode, ...)
+Tags \(label in some scm's\) a source tree with a certain tag. This allows to make reproducable builds later by checking out the source code that has this tag.
-* Tag
+## Update
- Tags (label in some scm's) a source tree with a certain tag. This allows to make reproducable builds later by checking out the source code that has this tag.
+Updates the checkout'ed source code to the latest state in the source control repository.
-* Update
-
- Updates the checkout'ed source code to the latest state in the source control repository.
diff --git a/src/site/markdown/scm-url-format.md b/src/site/markdown/scm-url-format.md
index b2c543bb6..4e9a2d364 100644
--- a/src/site/markdown/scm-url-format.md
+++ b/src/site/markdown/scm-url-format.md
@@ -1,47 +1,41 @@
- ------
- SCM URL format
- ------
- Emmanuel Venisse
- ------
- 2005-06-05
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-SCM URL Format
-
-* SCM URL
-
- The general format for a SCM URL is
-
--------
+---
+title: SCM URL format
+author:
+ - Emmanuel Venisse
+date: 2005-06-05
+---
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+<!-- NOTE: For help with the syntax of this file, see:-->
+<!-- http://maven.apache.org/doxia/references/apt-format.html-->
+# SCM URL Format
+
+## SCM URL
+
+The general format for a SCM URL is
+
+```
scm:<provider id><delimiter><provider-specific part>
--------
+```
- As delimiter you can use either colon <<<:>>> or a pipe <<<|>>>, if you use a
- colon for one of the variables (e.g. a Windows path).
+As delimiter you can use either colon `:` or a pipe `|`, if you use a colon for one of the variables \(e.g. a Windows path\).
- For information about supported provider IDs and the provider-specific part,
- see the appropriate {{{./scms-overview.html}SCM implementation}}.
+For information about supported provider IDs and the provider-specific part, see the appropriate [SCM implementation](./scms-overview.html).
+
+Provider IDs may be mapped with the help of the plugin parameter `providerImplementations` supported by both [maven-release-plugin](https://maven.apache.org/maven-release/maven-release-plugin/prepare-mojo.html#providerImplementations) and [maven-scm-plugin](./maven-scm-plugin/checkout-mojo.html#providerImplementations).
- Provider IDs may be mapped with the help of the plugin parameter <<<providerImplementations>>> supported
- by both {{{https://maven.apache.org/maven-release/maven-release-plugin/prepare-mojo.html#providerImplementations}maven-release-plugin}}
- and {{{./maven-scm-plugin/checkout-mojo.html#providerImplementations}maven-scm-plugin}}.
diff --git a/src/site/markdown/scms-overview.md b/src/site/markdown/scms-overview.md
index 8e3117324..10332be3d 100644
--- a/src/site/markdown/scms-overview.md
+++ b/src/site/markdown/scms-overview.md
@@ -1,45 +1,37 @@
- ------
- Overview of SCMs
- ------
- Wim Deblauwe
- ------
- 2005-12-01
- ------
+---
+title: Overview of SCMs
+author:
+ - Wim Deblauwe
+date: 2005-12-01
+---
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+<!-- NOTE: For help with the syntax of this file, see:-->
+<!-- http://maven.apache.org/doxia/references/apt-format.html-->
+# Overview of SCMs
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
+This is a list of all standard SCMs:
-Overview of SCMs
-
- This is a list of all standard SCMs:
-
-*-----*-------------*-----------------*
-| <<SCM>> | <<Provider ID>> | <<Provider Module>> |
-*-----*-------------*-----------------*
-| {{{./git.html}Git}} | <<<git>>> | {{{./maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/index.html}Git Executable Provider}} |
-*-----*-------------*-----------------*
-| {{{./git.html}Git}} | <<<jgit>>> | {{{./maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/index.html}JGit Provider}} |
-*-----*-------------*-----------------*
-| {{{./subversion.html}Subversion}} | <<<svn>>> | {{{./maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/index.html}SVN Executable Provider}} |
-*-----*-------------*-----------------*
-| {{{./mercurial.html}Mercurial}} | <<<hg>>> | {{{./maven-scm-providers/maven-scm-provider-hg/index.html}Mercurial (Hg) Provider}} |
-*-----*-------------*-----------------*
-| {{{./local.html}Local}} | <<<local>>> | {{{./maven-scm-providers/maven-scm-provider-local/index.html}Local Provider}} |
-*-----*-------------*-----------------*
+| | | |
+|:---:|:---:|:---:|
+|**SCM**|**Provider ID**|**Provider Module**|
+|[Git](./git.html)|`git`|[Git Executable Provider](./maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/index.html)|
+|[Git](./git.html)|`jgit`|[JGit Provider](./maven-scm-providers/maven-scm-providers-git/maven-scm-provider-jgit/index.html)|
+|[Subversion](./subversion.html)|`svn`|[SVN Executable Provider](./maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svnexe/index.html)|
+|[Mercurial](./mercurial.html)|`hg`|[Mercurial \(Hg\) Provider](./maven-scm-providers/maven-scm-provider-hg/index.html)|
+|[Local](./local.html)|`local`|[Local Provider](./maven-scm-providers/maven-scm-provider-local/index.html)|
diff --git a/src/site/markdown/subversion.md b/src/site/markdown/subversion.md
index 0f3f43815..7d936d05e 100644
--- a/src/site/markdown/subversion.md
+++ b/src/site/markdown/subversion.md
@@ -1,72 +1,69 @@
- ------
- SCM Implementation: Subversion
- ------
- Wim Deblauwe
- Olivier Lamy
- ------
- 2011-05-15
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-SCM Implementation: Subversion
-
-* General Info
-
- Link: {{http://subversion.apache.org/}}
-
- License: Apache License, Version 2.0
-
-* SCM URL
-
- For all URLs below, we use a colon (:) as separator. If you use a colon for one of the variables (e.g. a windows path), then use a pipe (|) as separator.
-
--------
+---
+title: SCM Implementation: Subversion
+author:
+ - Wim Deblauwe
+ - Olivier Lamy
+date: 2011-05-15
+---
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+<!-- NOTE: For help with the syntax of this file, see:-->
+<!-- http://maven.apache.org/doxia/references/apt-format.html-->
+# SCM Implementation: Subversion
+
+## General Info
+
+Link: [http://subversion.apache.org/](http://subversion.apache.org/)
+
+License: Apache License, Version 2\.0
+
+## SCM URL
+
+For all URLs below, we use a colon \(:\) as separator. If you use a colon for one of the variables \(e.g. a windows path\), then use a pipe \(|\) as separator.
+
+```
scm:svn:svn://[username[:password]@]server_name[:port]/path_to_repository
scm:svn:svn+ssh://[username@]server_name[:port]/path_to_repository
scm:svn:file://[hostname]/path_to_repository
scm:svn:http://[username[:password]@]server_name[:port]/path_to_repository
scm:svn:https://[username[:password]@]server_name[:port]/path_to_repository
--------
+```
-* Examples
+## Examples
--------
+```
scm:svn:file:///svn/root/module
scm:svn:file://localhost/path_to_repository
scm:svn:file://my_server/path_to_repository
scm:svn:http://svn.apache.org/svn/root/module
scm:svn:https://username@svn.apache.org/svn/root/module
scm:svn:https://username:password@svn.apache.org/svn/root/module
--------
+```
-* Provider Configuration
+## Provider Configuration
- The provider configuration is defined in <<<$\{user.home\}/.scm/svn-settings.xml>>>.
- For more information see the {{{./maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/svn-settings.html}reference guide}}.
+The provider configuration is defined in `${user.home}/.scm/svn-settings.xml`. For more information see the [reference guide](./maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/svn-settings.html).
-** Configuration directory
+### 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.
+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
--------
+```
+