This is an automated email from the ASF dual-hosted git repository.
kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-scm.git
The following commit(s) were added to refs/heads/master by this push:
new 9e39e8722 Migrate remaining APT to Markdown files
9e39e8722 is described below
commit 9e39e87222edb0b13a334efe91a8c51304bb2214
Author: Konrad Windszus <[email protected]>
AuthorDate: Tue Aug 5 17:25:32 2025 +0200
Migrate remaining APT to Markdown files
Fix some typos, remove dead links
Remove invalid comment related to APT format
---
maven-scm-client/src/site/apt/index.apt | 56 -----
maven-scm-client/src/site/markdown/index.md | 52 +++++
.../apt/examples/bootstrapping-with-pom.apt.vm | 128 ------------
.../site/apt/examples/scm-advance-features.apt.vm | 232 ---------------------
maven-scm-plugin/src/site/apt/index.apt | 103 ---------
maven-scm-plugin/src/site/apt/usage.apt.vm | 147 -------------
.../markdown/examples/bootstrapping-with-pom.md.vm | 78 +++++++
.../markdown/examples/scm-advance-features.md.vm | 227 ++++++++++++++++++++
maven-scm-plugin/src/site/markdown/index.md | 63 ++++++
maven-scm-plugin/src/site/markdown/usage.md | 132 ++++++++++++
maven-scm-plugin/src/site/site.xml | 5 +-
src/site/markdown/authentication.md | 2 -
src/site/markdown/git.md | 2 -
src/site/markdown/guide/define_provider.md | 2 -
src/site/markdown/guide/index.md | 2 -
src/site/markdown/guide/new_provider.md | 2 -
src/site/markdown/guide/usage.md | 2 -
src/site/markdown/index.md | 2 -
src/site/markdown/local.md | 2 -
src/site/markdown/mercurial.md | 2 -
src/site/markdown/scm-commands.md | 2 -
src/site/markdown/scm-url-format.md | 2 -
src/site/markdown/scms-overview.md | 2 -
src/site/markdown/subversion.md | 2 -
24 files changed, 555 insertions(+), 694 deletions(-)
diff --git a/maven-scm-client/src/site/apt/index.apt
b/maven-scm-client/src/site/apt/index.apt
deleted file mode 100644
index eb5a9c476..000000000
--- a/maven-scm-client/src/site/apt/index.apt
+++ /dev/null
@@ -1,56 +0,0 @@
- ------
- Introduction
- ------
- Vincent Siveton
- ------
- 2008-08-14
- ------
-
-~~ 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 Client
-
- The Maven SCM client is a simple SCM command line tool.
-
-* Usage
-
-+-----+
-# java -jar target\maven-scm-client-1.1-jar-with-dependencies.jar
-Usage: maven-scm-client <command> <working directory> <scm url> [<scmVersion>
[<scmVersionType>]]
-scmVersion is a branch name/tag name/revision number.
-scmVersionType can be 'branch', 'tag', 'revision'. The default value is
'revision'.
-+-----+
-
-* Example
-
-+-----+
-# java -jar target\maven-scm-client-1.1-jar-with-dependencies.jar checkout
c:\temp\maven-scm-client
scm:svn:http://svn.apache.org/repos/asf/maven/scm/trunk/maven-scm-client
-[INFO] Executing: cmd.exe /X /C "svn --non-interactive checkout
http://svn.apache.org/repos/asf/maven/scm/trunk/maven-scm-client
maven-scm-client"
-[INFO] Working directory: c:\temp
-Checked out these files:
-
maven-scm-client\src\main\java\org\apache\maven\scm\client\cli\MavenScmCli.java
- maven-scm-client\src\main\resources\META-INF\plexus\components.xml
- maven-scm-client\src\main\bash\maven-scm-update
- maven-scm-client\src\main\bash\maven-scm-checkin
- maven-scm-client\src\main\bash\maven-scm-checkout
- maven-scm-client\src\site\site.xml
- maven-scm-client\pom.xml
-+-----+
diff --git a/maven-scm-client/src/site/markdown/index.md
b/maven-scm-client/src/site/markdown/index.md
new file mode 100644
index 000000000..257af336a
--- /dev/null
+++ b/maven-scm-client/src/site/markdown/index.md
@@ -0,0 +1,52 @@
+---
+title: Introduction
+author:
+ - Vincent Siveton
+date: 2008-08-14
+---
+
+<!-- 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.-->
+# Maven SCM Client
+
+The Maven SCM client is a simple SCM command line tool.
+
+## Usage
+
+```unknown
+# java -jar target\maven-scm-client-1.1-jar-with-dependencies.jar
+Usage: maven-scm-client <command> <working directory> <scm url> [<scmVersion>
[<scmVersionType>]]
+scmVersion is a branch name/tag name/revision number.
+scmVersionType can be 'branch', 'tag', 'revision'. The default value is
'revision'.
+```
+
+## Example
+
+```unknown
+# java -jar target\maven-scm-client-1.1-jar-with-dependencies.jar checkout
c:\temp\maven-scm-client
scm:svn:http://svn.apache.org/repos/asf/maven/scm/trunk/maven-scm-client
+[INFO] Executing: cmd.exe /X /C "svn --non-interactive checkout
http://svn.apache.org/repos/asf/maven/scm/trunk/maven-scm-client
maven-scm-client"
+[INFO] Working directory: c:\temp
+Checked out these files:
+
maven-scm-client\src\main\java\org\apache\maven\scm\client\cli\MavenScmCli.java
+ maven-scm-client\src\main\resources\META-INF\plexus\components.xml
+ maven-scm-client\src\main\bash\maven-scm-update
+ maven-scm-client\src\main\bash\maven-scm-checkin
+ maven-scm-client\src\main\bash\maven-scm-checkout
+ maven-scm-client\src\site\site.xml
+ maven-scm-client\pom.xml
+```
+
diff --git
a/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt.vm
b/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt.vm
deleted file mode 100644
index 0a5869ec6..000000000
--- a/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt.vm
+++ /dev/null
@@ -1,128 +0,0 @@
- ------
- Bootstrapping a Project Using a POM
- ------
- Pete Marvin King
- ------
- 2008-08-13
- ------
-
-~~ 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
-
-Bootstrapping a Project Using a POM
-
- Using the <<<scm:bootstrap>>> a project can be build from a fresh copy of the
source in the scm repository.
- This is a convenient way to distribute a project because the bootstrap pom
can be given to a developer to generate
- the maven build environment for the project.
-
- The <<<pom.xml>>> should contain a scm configuration for the bootstrap to
work.
-
-+-----------+
-<project>
- ...
- <packaging>jar</packaging>
- <version>1.0-SNAPSHOT</version>
- <name>SCM Sample Project</name>
- <url>http://somecompany.com</url>
- <scm>
- <connection>scm:svn:http://somerepository.com/svn_repo/trunk</connection>
-
<developerConnection>scm:svn:https://somerepository.com/svn_repo/trunk</developerConnection>
- <url>http://somerepository.com/view.cgi</url>
- </scm>
- ...
- <build>
- ...
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-scm-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <goals>install</goals>
- </configuration>
- </plugin>
- </plugins>
- ...
- </build>
- ...
-</project>
-+-----------+
-
- Assuming the scm configuration has been configured in the <<<pom.xml>>>,
bootstrapping can be invoked by
-
-+---------+
- mvn scm:bootstrap
-+---------+
-
- or in case of a multimodule project, bootstrapping should be invoked as
-
-+---------+
- mvn scm:bootstrap -N
-+---------+
-
- By default the scm plugin will get the latest version from the trunk and
generate it under <<<target/checkout>>> and execute
- the configured goals in it.
-
-Configuring Authentication
-
- Most public repositories requires developers to authenticate first before
they can pull the source from the repository.
- For repositories requiring authentication, the scm plugin needs to be
configured in one of the following ways:
-
- * In the <<<poml.xml>>>
-
-+-----------+
-<project>
- ...
- <build>
- ...
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-scm-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <username>username</username>
- <password>password</password>
- </configuration>
- </plugin>
- </plugins>
- ...
- </build>
- ...
-</project>
-+-----------+
-
- * In the <<<settings.xml>>> via a <<<server>>> entry, using the host name
from the connection URL as the server id
-
-+-----------+
-<settings>
- ...
- <servers>
- <server>
- <id>hostname</id>
- <username>username</username>
- <password>password</password>
- </server>
- </servers>
- ...
-</settings>
-+-----------+
-
- Since version 1.5, the plugin also recognizes
{{{http://maven.apache.org/guides/mini/guide-encryption.html}encrypted
passwords}}.
diff --git a/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt.vm
b/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt.vm
deleted file mode 100644
index e6621672e..000000000
--- a/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt.vm
+++ /dev/null
@@ -1,232 +0,0 @@
- ------
- Other SCM Commands
- ------
- Pete Marvin King
- ------
- 2008-08-13
- ------
-
-~~ 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
-
-Other SCM Commands
-
- The scm plugin requires the scm to be configured in the <<<pom.xml>>>.
-
-+---------+
-<project>
- ...
- <packaging>jar</packaging>
- <version>1.0-SNAPSHOT</version>
- <name>SCM Sample Project</name>
- <url>http://somecompany.com</url>
- <scm>
- <connection>scm:svn:http://somerepository.com/svn_repo/trunk</connection>
-
<developerConnection>scm:svn:https://somerepository.com/svn_repo/trunk</developerConnection>
- <url>http://somerepository.com/view.cgi</url>
- </scm>
- ...
-</project>
-+---------+
-
- If you want to change the default scm provider implementation, for exemple
you want to use the native Git
- instead of the pure Java implementation, you must configure your plugin like
that:
-
-+-----------+
-<project>
- ...
- <build>
- ...
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-scm-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <providerImplementations>
- <git>git</git>
- </providerImplementations>
- </configuration>
- </plugin>
- ...
- </plugins
- ...
- </build>
- ...
-</project>
-+-----------+
-
- Once the scm has been configured, scm operations can be performed.
-
-* changelog - displays the project commit changes for each revisions
-
- <<<pom.xml>>> configuration :
-
-+-----------+
-<project>
- ...
- <build>
- ...
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-scm-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <startDate>YYYY-MM-DD</startDate>
- <endDate>YYYY-MM-DD</endDate>
- </configuration>
- </plugin>
- ...
- </plugins
- ...
- </build>
- ...
-</project>
-+-----------+
-
- Command :
-
-+---------+
- mvn scm:changelog
-+---------+
-
- or you can specify the startDate and endDate on the commandline
-
-+---------+
- mvn -DstartDate=YYYY-MM-DD -DendDate=YYYY-MM-DD scm:changelog
-+---------+
-
-
-* diff
-
- <<<pom.xml>>> configuration :
-
-+-----------+
-<project>
- ...
- <build>
- ...
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-scm-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <startRevision>connection</startRevision>
- <endRevision>connection</endRevision>
- </configuration>
- </plugin>
- ...
- </plugins
- ...
- </build>
- ...
-</project>
-+-----------+
-
- Command :
-
-+---------+
- mvn scm:diff
-+---------+
-
- or you can specify the startRevision and endRevision in the command line
-
-+---------+
- mvn -DstartRevision=<revision> -DendRevision=<revision> scm:diff
-+---------+
-
-* edit - set the edit status of the file, locking the project sources if
supported.
-
- Command :
-
-+---------+
- mvn scm:edit
-+---------+
-
-* status - displays the modified files in the project.
-
- Command :
-
-+---------+
- mvn scm:status
-+---------+
-
-* tag
-
- <<<pom.xml>>> configuration :
-
-+-----------+
-<project>
- ...
- <build>
- ...
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-scm-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <tag>tag name</tag>
- </configuration>
- </plugin>
- ...
- </plugins
- ...
- </build>
- ...
-</project>
-+-----------+
-
- Command :
-
-+---------+
- mvn scm:tag
-+---------+
-
- or you can specify the tag name in the command line
-
-+---------+
- mvn -Dtag="<tag name>" scm:tag
-+---------+
-
-* unedit - unset the edit status of the project sources and unlocking it if
supported.
-
- Command :
-
-+---------+
- mvn scm:unedit
-+---------+
-
-* validate - check if the scm urls configured in the <<<pom.xml>>> is valid.
-
- Command :
-
-+---------+
- mvn scm:validate
-+---------+
-
- or passing the scmConnection or/and the developerConnection in the command
line
-
-+---------+
- mvn -DscmConnection="<scm url>" -DscmDeveloperConnection="<scm url>"
scm:validate
-+---------+
-
diff --git a/maven-scm-plugin/src/site/apt/index.apt
b/maven-scm-plugin/src/site/apt/index.apt
deleted file mode 100644
index f52bd0fbb..000000000
--- a/maven-scm-plugin/src/site/apt/index.apt
+++ /dev/null
@@ -1,103 +0,0 @@
- ------
- Introduction
- ------
- Pete Marvin King
- ------
- 2008-08-13
- ------
-
-~~ 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 Plugin
-
- The SCM Plugin offers vendor independent access to common scm commands by
offering a set
- of command mappings for the configured scm. Each command is implemented as a
goal.
-
-* Goals Overview
-
- The SCM Plugin has the following goals:
-
- * {{{./add-mojo.html}scm:add}} - command to add file
-
- * {{{./bootstrap-mojo.html}scm:bootstrap}} - command to checkout and build a
project
-
- * {{{./branch-mojo.html}scm:branch}} - branch the project
-
- * {{{./changelog-mojo.html}scm:changelog}} - command to show the source code
revisions
-
- * {{{./check-local-modification-mojo.html}scm:check-local-modification}} -
fail the build if there is any local modifications
-
- * {{{./checkin-mojo.html}scm:checkin}} - command for commiting changes
-
- * {{{./checkout-mojo.html}scm:checkout}} - command for getting the source code
-
- * {{{./diff-mojo.html}scm:diff}} - command for showing the difference of the
working copy with the remote one
-
- * {{{./edit-mojo.html}scm:edit}} - command for starting edit on the working
copy
-
- * {{{./export-mojo.html}scm:export}} - command to get a fresh exported copy
-
- * {{{./list-mojo.html}scm:list}} - command for get the list of project files
-
- * {{{./remove-mojo.html}scm:remove}} - command to mark a set of files for
deletion
-
- * {{{./status-mojo.html}scm:status}} - command for showing the scm status of
the working copy
-
- * {{{./tag-mojo.html}scm:tag}} - command for tagging a certain revision
-
- * {{{./unedit-mojo.html}scm:unedit}} - command to stop editing the working
copy
-
- * {{{./update-mojo.html}scm:update}} - command for updating the working copy
with the latest changes
-
- * {{{./update-subprojects-mojo.html}scm:update-subprojects}} - command for
updating all projects in a multi project build
-
- * {{{./validate-mojo.html}scm:validate}} - validate the scm information in
the pom
-
- []
-
-* Usage
-
- General instructions on how to use the SCM Plugin can be found on the
{{{./usage.html}usage page}}. Some more
- specific use cases are described in the examples given below.
-
- In case you still have questions regarding the plugin's usage, please feel
- free to contact the {{{./mailing-lists.html}user mailing list}}. The posts
to the mailing list are archived and could
- already contain the answer to your question as part of an older thread.
Hence, it is also worth browsing/searching
- the {{{./mailing-lists.html}mail archive}}.
-
- If you feel like the plugin is missing a feature or has a defect, you can
fill a feature request or bug report in our
- {{{./issue-management.html}issue tracker}}. When creating a new issue,
please provide a comprehensive description of your
- concern. Especially for fixing bugs it is crucial that the developers can
reproduce your problem. For this reason,
- entire debug logs, POMs or most preferably little demo projects attached to
the issue are very much appreciated.
- Of course, patches are welcome, too. Contributors can check out the project
from our
- {{{./scm.html}source repository}} and will find supplementary information in
the
- {{{http://maven.apache.org/guides/development/guide-helping.html}guide to
helping with Maven}}.
-
-* Examples
-
- To provide you with better understanding on some usages of the Maven SCM
Plugin,
- you can take a look into the following examples:
-
- * {{{./examples/bootstrapping-with-pom.html}Bootstrapping using a POM file}}
-
- * {{{./examples/scm-advance-features.html}Other advanced scm commands}}
-
- []
diff --git a/maven-scm-plugin/src/site/apt/usage.apt.vm
b/maven-scm-plugin/src/site/apt/usage.apt.vm
deleted file mode 100644
index 983c4a43a..000000000
--- a/maven-scm-plugin/src/site/apt/usage.apt.vm
+++ /dev/null
@@ -1,147 +0,0 @@
- ------
- Usage
- ------
- Pete Marvin King
- ------
- 2008-08-13
- ------
-
-~~ 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
-
-Usage
-
- The SCM Plugin maps a lot of commands to a variety of scm implementations.
But there are only 2 frequently
- used commands:
-
- * checkin - commit the changes to the remote repository ( scm server ).
-
- * update - updates the local working copy with the one from the remote
repository ( scm server ).
-
- []
-
-Configuring SCM
-
- Each scm has a different command line invocation to commit the modified
sources. Using maven this process is
- simplified by providing a uniform way to do this by letting maven handle the
command line translation to perform
- the scm task.
-
- To configure the scm support for maven you need the
{{{http://maven.apache.org/pom.html#SCM}scm}} configuration in your
<<<pom.xml>>>.
-
-+---------+
-<project>
- ...
- <packaging>jar</packaging>
- <version>1.0-SNAPSHOT</version>
- <name>SCM Sample Project</name>
- <url>http://somecompany.com</url>
- <scm>
- <connection>scm:svn:http://somerepository.com/svn_repo/trunk</connection>
-
<developerConnection>scm:svn:https://somerepository.com/svn_repo/trunk</developerConnection>
- <url>http://somerepository.com/view.cgi</url>
- </scm>
- ...
-</project>
-+---------+
-
- Maven will use the information embedded in the scm configuration to determine
the command mapping for the scm command.
- The scm configuration url is composed of different information that defines
the mapping:
-
-+------+
- scm:svn:http://somerepository.com/svn_repo/trunk
- <service name>:<scm implementation>:<repository url>
-+------+
-
- Check the {{{http://maven.apache.org/scm/scms-overview.html}maven scm list}}
for the list of supported SCMs.
-
-Committing and updating changes through Maven
-
- Assuming that SCM has been configured in the <<<pom.xml>>> and the project
directory is managed by a SCM, invoking
- the checkin goal in the scm will start the commit process for all configured
sources in your <<<pom.xml>>>.
-
- <<The files should be added beforehand by an external scm client.>>
-
-+-----+
- mvn -Dmessage="<commit_log_here>" scm:checkin
-+-----+
-
- for update
-
-+-----+
- mvn scm:update
-+-----+
-
-Specifying the scm connection to use
-
- There two possible scm connections that can be used in the <<<pom.xml>>>,
connection and developerConnection.
-
- * connection configuration
-
-+-----------+
-<project>
- ...
- <build>
- [...]
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-scm-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <connectionType>connection</connectionType>
- </configuration>
- </plugin>
- ...
- </plugins
- ...
- </build>
- ...
-</project>
-+-----------+
-
- * developerConnection configuration
-
-+-----------+
-<project>
- ...
- <build>
- ...
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-scm-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <connectionType>developerConnection</connectionType>
- </configuration>
- </plugin>
- ...
- </plugins
- ...
- </build>
- ...
-</project>
-+-----------+
-
-Related Links
-
- * {{{../matrix.html}SCM Plugin Matrix}}
-
- []
diff --git
a/maven-scm-plugin/src/site/markdown/examples/bootstrapping-with-pom.md.vm
b/maven-scm-plugin/src/site/markdown/examples/bootstrapping-with-pom.md.vm
new file mode 100644
index 000000000..327b70a0a
--- /dev/null
+++ b/maven-scm-plugin/src/site/markdown/examples/bootstrapping-with-pom.md.vm
@@ -0,0 +1,78 @@
+---
+title: Bootstrapping a Project Using a POM
+author:
+ - Pete Marvin King
+date: 2008-08-13
+---
+
+<!-- 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.-->
+# Bootstrapping a Project Using a POM
+
+Using the `scm:bootstrap` a project can be build from a fresh copy of the
source in the scm repository. This is a convenient way to distribute a project
because the bootstrap POM can be given to a developer to generate the Maven
build environment for the project.
+
+The `pom.xml` should contain an SCM configuration for the bootstrap to work.
+
+```unknown
+<project>
+ ...
+ <packaging>jar</packaging>
+ <version>1.0-SNAPSHOT</version>
+ <name>SCM Sample Project</name>
+ <url>http://somecompany.com</url>
+ <scm>
+ <connection>scm:svn:http://somerepository.com/svn_repo/trunk</connection>
+
<developerConnection>scm:svn:https://somerepository.com/svn_repo/trunk</developerConnection>
+ <url>http://somerepository.com/view.cgi</url>
+ </scm>
+ ...
+ <build>
+ ...
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <goals>install</goals>
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
+```
+
+Assuming the SCM configuration has been configured in the `pom.xml`,
bootstrapping can be invoked by
+
+```unknown
+ mvn scm:bootstrap
+```
+
+or in case of a multi-module project, bootstrapping should be invoked as
+
+```unknown
+ mvn scm:bootstrap -N
+```
+
+By default the SCM plugin will get the latest version from the repository in
its default branch and generate it under `target/checkout` and execute the
configured goals in it.
+
+# Configuring Authentication
+
+Most public repositories require developers to authenticate first before they
can pull the source from the repository. For repositories requiring
authentication, the SCM plugin needs to be [configured
accordingly](../../authentication.html).
+
diff --git
a/maven-scm-plugin/src/site/markdown/examples/scm-advance-features.md.vm
b/maven-scm-plugin/src/site/markdown/examples/scm-advance-features.md.vm
new file mode 100644
index 000000000..b3a7dc7e5
--- /dev/null
+++ b/maven-scm-plugin/src/site/markdown/examples/scm-advance-features.md.vm
@@ -0,0 +1,227 @@
+---
+title: Other SCM Commands
+author:
+ - Pete Marvin King
+date: 2008-08-13
+---
+
+<!-- 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.-->
+# Other SCM Commands
+
+The SCM plugin requires the SCM to be configured in the `pom.xml`.
+
+```unknown
+<project>
+ ...
+ <packaging>jar</packaging>
+ <version>1.0-SNAPSHOT</version>
+ <name>SCM Sample Project</name>
+ <url>http://somecompany.com</url>
+ <scm>
+ <connection>scm:svn:http://somerepository.com/svn_repo/trunk</connection>
+
<developerConnection>scm:svn:https://somerepository.com/svn_repo/trunk</developerConnection>
+ <url>http://somerepository.com/view.cgi</url>
+ </scm>
+ ...
+</project>
+```
+
+Alternatively you can configure the SCM url also in via plugin parameters.
+
+If you want to change the used SCM provider implementation, for example you
want to use the JGit instead of the CLI based default implementation, you must
configure your plugin like that:
+
+```unknown
+<project>
+ ...
+ <build>
+ ...
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <providerImplementations>
+ <git>jgit</git>
+ </providerImplementations>
+ </configuration>
+ </plugin>
+ ...
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
+```
+
+Once the SCM has been configured, SCM operations can be performed.
+
+## changelog - displays the project commit changes for each revisions
+
+`pom.xml` configuration :
+
+```unknown
+<project>
+ ...
+ <build>
+ ...
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <startDate>YYYY-MM-DD</startDate>
+ <endDate>YYYY-MM-DD</endDate>
+ </configuration>
+ </plugin>
+ ...
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
+```
+
+Command :
+
+```unknown
+ mvn scm:changelog
+```
+
+or you can specify the startDate and endDate on the commandline
+
+```unknown
+ mvn -DstartDate=YYYY-MM-DD -DendDate=YYYY-MM-DD scm:changelog
+```
+
+## diff
+
+`pom.xml` configuration :
+
+```unknown
+<project>
+ ...
+ <build>
+ ...
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <startRevision>connection</startRevision>
+ <endRevision>connection</endRevision>
+ </configuration>
+ </plugin>
+ ...
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
+```
+
+Command :
+
+```unknown
+ mvn scm:diff
+```
+
+or you can specify the startRevision and endRevision in the command line
+
+```unknown
+ mvn -DstartRevision=<revision> -DendRevision=<revision> scm:diff
+```
+
+## edit - set the edit status of the file, locking the project sources if
supported.
+
+Command :
+
+```unknown
+ mvn scm:edit
+```
+
+## status - displays the modified files in the project.
+
+Command :
+
+```unknown
+ mvn scm:status
+```
+
+## tag
+
+`pom.xml` configuration :
+
+```unknown
+<project>
+ ...
+ <build>
+ ...
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <tag>tag name</tag>
+ </configuration>
+ </plugin>
+ ...
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
+```
+
+Command :
+
+```unknown
+ mvn scm:tag
+```
+
+or you can specify the tag name in the command line
+
+```unknown
+ mvn -Dtag="<tag name>" scm:tag
+```
+
+## unedit - unset the edit status of the project sources and unlocking it if
supported.
+
+Command :
+
+```unknown
+ mvn scm:unedit
+```
+
+## validate - check if the scm urls configured in the `pom.xml` is valid.
+
+Command :
+
+```unknown
+ mvn scm:validate
+```
+
+or passing the scmConnection or/and the developerConnection in the command line
+
+```unknown
+ mvn -DscmConnection="<scm url>" -DscmDeveloperConnection="<scm url>"
scm:validate
+```
+
diff --git a/maven-scm-plugin/src/site/markdown/index.md
b/maven-scm-plugin/src/site/markdown/index.md
new file mode 100644
index 000000000..d55f86d98
--- /dev/null
+++ b/maven-scm-plugin/src/site/markdown/index.md
@@ -0,0 +1,63 @@
+---
+title: Introduction
+author:
+ - Pete Marvin King
+date: 2008-08-13
+---
+
+<!-- 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.-->
+# Maven SCM Plugin
+
+The SCM Plugin offers vendor independent access to common scm commands by
offering a set of command mappings for the configured scm. Each command is
implemented as a goal.
+
+## Goals Overview
+
+The SCM Plugin has the following goals:
+
+- [scm:add](./add-mojo.html) - command to add file
+- [scm:bootstrap](./bootstrap-mojo.html) - command to checkout and build a
project
+- [scm:branch](./branch-mojo.html) - branch the project
+- [scm:changelog](./changelog-mojo.html) - command to show the source code
revisions
+- [scm:check-local-modification](./check-local-modification-mojo.html) - fail
the build if there is any local modifications
+- [scm:checkin](./checkin-mojo.html) - command for commiting changes
+- [scm:checkout](./checkout-mojo.html) - command for getting the source code
+- [scm:diff](./diff-mojo.html) - command for showing the difference of the
working copy with the remote one
+- [scm:edit](./edit-mojo.html) - command for starting edit on the working copy
+- [scm:export](./export-mojo.html) - command to get a fresh exported copy
+- [scm:list](./list-mojo.html) - command for get the list of project files
+- [scm:remove](./remove-mojo.html) - command to mark a set of files for
deletion
+- [scm:status](./status-mojo.html) - command for showing the scm status of the
working copy
+- [scm:tag](./tag-mojo.html) - command for tagging a certain revision
+- [scm:unedit](./unedit-mojo.html) - command to stop editing the working copy
+- [scm:update](./update-mojo.html) - command for updating the working copy
with the latest changes
+- [scm:update-subprojects](./update-subprojects-mojo.html) - command for
updating all projects in a multi project build
+- [scm:validate](./validate-mojo.html) - validate the scm information in the
pom
+## Usage
+
+General instructions on how to use the SCM Plugin can be found on the [usage
page](./usage.html). Some more specific use cases are described in the examples
given below.
+
+In case you still have questions regarding the plugin's usage, please
feel free to contact the [user mailing list](./mailing-lists.html). The posts
to the mailing list are archived and could already contain the answer to your
question as part of an older thread. Hence, it is also worth browsing/searching
the [mail archive](./mailing-lists.html).
+
+If you feel like the plugin is missing a feature or has a defect, you can fill
a feature request or bug report in our [issue
tracker](./issue-management.html). When creating a new issue, please provide a
comprehensive description of your concern. Especially for fixing bugs it is
crucial that the developers can reproduce your problem. For this reason, entire
debug logs, POMs or most preferably little demo projects attached to the issue
are very much appreciated. Of course, patches are wel [...]
+
+## Examples
+
+To provide you with better understanding on some usages of the Maven SCM
Plugin, you can take a look into the following examples:
+
+- [Bootstrapping using a POM file](./examples/bootstrapping-with-pom.html)
+- [Other advanced scm commands](./examples/scm-advance-features.html)
diff --git a/maven-scm-plugin/src/site/markdown/usage.md
b/maven-scm-plugin/src/site/markdown/usage.md
new file mode 100644
index 000000000..d43b27c92
--- /dev/null
+++ b/maven-scm-plugin/src/site/markdown/usage.md
@@ -0,0 +1,132 @@
+---
+title: Usage
+author:
+ - Pete Marvin King
+date: 2008-08-13
+---
+
+<!-- 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.-->
+# Usage
+
+The SCM Plugin maps a lot of commands to a variety of SCM implementations. But
there are only 2 frequently used commands:
+
+- `checkin` - commit the changes to the remote repository \( SCM server \).
+- `update` - updates the local working copy with the one from the remote
repository \( SCM server \).
+
+# Configuring SCM
+
+Each SCM has a different command line/library API invocation to commit the
modified sources. Using Maven this process is simplified by providing a uniform
way to do this by letting Maven handle the API/CLI translation to perform the
SCM task.
+
+To configure the SCM support for Maven you need the
[SCM](http://maven.apache.org/pom.html#SCM) configuration in your `pom.xml`.
+
+```unknown
+<project>
+ ...
+ <packaging>jar</packaging>
+ <version>1.0-SNAPSHOT</version>
+ <name>SCM Sample Project</name>
+ <url>http://somecompany.com</url>
+ <scm>
+ <connection>scm:svn:http://somerepository.com/svn_repo/trunk</connection>
+
<developerConnection>scm:svn:https://somerepository.com/svn_repo/trunk</developerConnection>
+ <url>http://somerepository.com/view.cgi</url>
+ </scm>
+ ...
+</project>
+```
+
+Maven will use the information embedded in the SCM configuration to determine
the used SCM provider (implementation) and the remote repository URL. The SCM
configuration URL is composed of different information that define the mapping:
+
+```unknown
+ scm:svn:http://somerepository.com/svn_repo/trunk
+ <service name>:<scm implementation>:<repository url>
+```
+
+Check the [Maven SCM list](http://maven.apache.org/scm/scms-overview.html) for
the list of supported SCMs.
+
+# Committing and updating changes through Maven
+
+Assuming that SCM has been configured in the `pom.xml` and the project
directory is managed by a SCM, invoking the checkin goal in the SCM will start
the commit process for all configured sources in your `pom.xml`.
+
+**The files should be added beforehand by an external scm client.**
+
+```unknown
+ mvn -Dmessage="<commit_log_here>" scm:checkin
+```
+
+for update
+
+```unknown
+ mvn scm:update
+```
+
+# Specifying the SCM connection to use
+
+There two possible SCM connections that can be used in the `pom.xml`,
connection and developerConnection.
+
+- connection configuration
+
+ ```unknown
+ <project>
+ ...
+ <build>
+ [...]
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <connectionType>connection</connectionType>
+ </configuration>
+ </plugin>
+ ...
+ </plugins>
+ ...
+ </build>
+ ...
+ </project>
+ ```
+
+- developerConnection configuration
+
+ ```unknown
+ <project>
+ ...
+ <build>
+ ...
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-scm-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <connectionType>developerConnection</connectionType>
+ </configuration>
+ </plugin>
+ ...
+ </plugins>
+ ...
+ </build>
+ ...
+ </project>
+ ```
+
+# Related Links
+
+- [Overview of SCMs](../scms-overview.html)
diff --git a/maven-scm-plugin/src/site/site.xml
b/maven-scm-plugin/src/site/site.xml
index 4254dfb8a..dee3d9a3d 100644
--- a/maven-scm-plugin/src/site/site.xml
+++ b/maven-scm-plugin/src/site/site.xml
@@ -37,8 +37,9 @@
</menu>
<menu name="Quick Links">
- <item name="Maven SCM Home" href="http://maven.apache.org/scm/"/>
- <item name="SCM URL Format"
href="http://maven.apache.org/scm/scm-url-format.html"/>
+ <item name="Maven SCM Home" href="../"/>
+ <item name="SCM URL Format" href="../scm-url-format.html"/>
+ <item name="Authentication" href="../authentication.html"/>
</menu>
<menu ref="reports"/>
diff --git a/src/site/markdown/authentication.md
b/src/site/markdown/authentication.md
index 12ac7ad58..4e756e28d 100644
--- a/src/site/markdown/authentication.md
+++ b/src/site/markdown/authentication.md
@@ -18,8 +18,6 @@ title: SCM Authentication
<!-- 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-->
# Authentication
The most common authentication mechanisms supported by SCM providers are
outlined below.
diff --git a/src/site/markdown/git.md b/src/site/markdown/git.md
index a1887fe3a..aa849a49e 100644
--- a/src/site/markdown/git.md
+++ b/src/site/markdown/git.md
@@ -21,8 +21,6 @@ date: 2008-08-10
<!-- 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
diff --git a/src/site/markdown/guide/define_provider.md
b/src/site/markdown/guide/define_provider.md
index f064478bc..9af4d1eb3 100644
--- a/src/site/markdown/guide/define_provider.md
+++ b/src/site/markdown/guide/define_provider.md
@@ -21,8 +21,6 @@ date: 2013-09-07
<!-- 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?
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.
diff --git a/src/site/markdown/guide/index.md b/src/site/markdown/guide/index.md
index d4c05d3e4..41325c4b4 100644
--- a/src/site/markdown/guide/index.md
+++ b/src/site/markdown/guide/index.md
@@ -21,8 +21,6 @@ date: 2007-03-12
<!-- 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
## [How to use Maven SCM in my application?](./usage.html)
diff --git a/src/site/markdown/guide/new_provider.md
b/src/site/markdown/guide/new_provider.md
index e02594b45..b69214e10 100644
--- a/src/site/markdown/guide/new_provider.md
+++ b/src/site/markdown/guide/new_provider.md
@@ -21,8 +21,6 @@ date: 2007-03-27
<!-- 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?
diff --git a/src/site/markdown/guide/usage.md b/src/site/markdown/guide/usage.md
index 756998d03..8a4054578 100644
--- a/src/site/markdown/guide/usage.md
+++ b/src/site/markdown/guide/usage.md
@@ -21,8 +21,6 @@ date: 2007-03-26
<!-- 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
diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md
index 927aa3150..c54f66e11 100644
--- a/src/site/markdown/index.md
+++ b/src/site/markdown/index.md
@@ -21,8 +21,6 @@ date: 2013-10-27
<!-- 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
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.
diff --git a/src/site/markdown/local.md b/src/site/markdown/local.md
index 2b855f976..82868b6ac 100644
--- a/src/site/markdown/local.md
+++ b/src/site/markdown/local.md
@@ -21,8 +21,6 @@ date: 2005-12-01
<!-- 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
diff --git a/src/site/markdown/mercurial.md b/src/site/markdown/mercurial.md
index aa55bb03d..d82054669 100644
--- a/src/site/markdown/mercurial.md
+++ b/src/site/markdown/mercurial.md
@@ -21,8 +21,6 @@ date: 2007-04-12
<!-- 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
diff --git a/src/site/markdown/scm-commands.md
b/src/site/markdown/scm-commands.md
index 03a9c2672..0053e6e86 100644
--- a/src/site/markdown/scm-commands.md
+++ b/src/site/markdown/scm-commands.md
@@ -21,8 +21,6 @@ date: 2005-12-01
<!-- 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
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:
diff --git a/src/site/markdown/scm-url-format.md
b/src/site/markdown/scm-url-format.md
index b9fd92305..e44b06df0 100644
--- a/src/site/markdown/scm-url-format.md
+++ b/src/site/markdown/scm-url-format.md
@@ -21,8 +21,6 @@ date: 2005-06-05
<!-- 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
diff --git a/src/site/markdown/scms-overview.md
b/src/site/markdown/scms-overview.md
index 58852f21d..ae30a6584 100644
--- a/src/site/markdown/scms-overview.md
+++ b/src/site/markdown/scms-overview.md
@@ -21,8 +21,6 @@ date: 2005-12-01
<!-- 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
## Standard SCM Providers
diff --git a/src/site/markdown/subversion.md b/src/site/markdown/subversion.md
index 18e2a5882..c89a8ceab 100644
--- a/src/site/markdown/subversion.md
+++ b/src/site/markdown/subversion.md
@@ -22,8 +22,6 @@ date: 2011-05-15
<!-- 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
