[maven-scm] branch master updated: [SCM-999] Document provider IDs

[mi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

michaelo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-scm.git


The following commit(s) were added to refs/heads/master by this push:
     new b8060d8d6 [SCM-999] Document provider IDs
b8060d8d6 is described below

commit b8060d8d60e2bb5310917d6cc4dcba4d34c6a273
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Tue Jul 26 09:28:07 2022 +0200

    [SCM-999] Document provider IDs
    
    This closes #160
---
 src/site/apt/scm-url-format.apt | 14 +++++++++-----
 src/site/apt/scms-overview.apt  | 26 +++++++++++++++-----------
 2 files changed, 24 insertions(+), 16 deletions(-)

diff --git a/src/site/apt/scm-url-format.apt b/src/site/apt/scm-url-format.apt
index c906de8b2..b2c543bb6 100644
--- a/src/site/apt/scm-url-format.apt
+++ b/src/site/apt/scm-url-format.apt
@@ -33,11 +33,15 @@ SCM URL Format
   The general format for a SCM URL is
 
 -------
-scm:<scm_provider><delimiter><provider_specific_part>
+scm:<provider id><delimiter><provider-specific part>
 -------
 
-  As delimiter you can use either colon <<<:>>> or, if you use a colon for one
-  of the variables (e.g. a windows path), you can use a pipe <<<|>>>.
+  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 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 {{{./scms-overview.html}SCM implementation}}.
+
+  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/apt/scms-overview.apt b/src/site/apt/scms-overview.apt
index cf805ee76..8e3117324 100644
--- a/src/site/apt/scms-overview.apt
+++ b/src/site/apt/scms-overview.apt
@@ -28,14 +28,18 @@
 
 Overview of SCMs
 
-  This is a list of all currently known SCMs:
-
-* Fully implemented SCMs
-
-  * {{{./git.html}Git}}
-
-  * {{{./mercurial.html}Mercurial}}
-
-  * {{{./subversion.html}Subversion}}
-
-  * {{{./local.html}Local}}
\ No newline at end of file
+  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}} |
+*-----*-------------*-----------------*