Repository: maven-scm Updated Branches: refs/heads/master db35b5a1f -> 302ccb485
[SCM-873] Improve documentation on svn-settings.xml and git-settings.xml Project: http://git-wip-us.apache.org/repos/asf/maven-scm/repo Commit: http://git-wip-us.apache.org/repos/asf/maven-scm/commit/609c4bdc Tree: http://git-wip-us.apache.org/repos/asf/maven-scm/tree/609c4bdc Diff: http://git-wip-us.apache.org/repos/asf/maven-scm/diff/609c4bdc Branch: refs/heads/master Commit: 609c4bdc7668ff11cee5dba51e4ac2ff3e6dce51 Parents: db35b5a Author: Michael Osipov <[email protected]> Authored: Sat Mar 17 01:22:09 2018 +0100 Committer: Michael Osipov <[email protected]> Committed: Sat Mar 17 01:22:09 2018 +0100 ---------------------------------------------------------------------- .../maven-scm-provider-git-commons/pom.xml | 19 ++++++++++++++++++- .../src/main/mdo/git-settings.mdo | 4 ++-- .../src/site/site.xml | 1 + .../src/main/mdo/svn-settings.mdo | 2 +- src/site/apt/git.apt | 11 ++--------- src/site/apt/subversion.apt | 19 ++----------------- 6 files changed, 26 insertions(+), 30 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/maven-scm/blob/609c4bdc/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/pom.xml ---------------------------------------------------------------------- diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/pom.xml b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/pom.xml index 88a4a5a..6173948 100644 --- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/pom.xml +++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/pom.xml @@ -40,11 +40,28 @@ <artifactId>modello-maven-plugin</artifactId> <executions> <execution> + <id>generate-xsd-site</id> + <phase>pre-site</phase> + <goals> + <goal>xsd</goal> + </goals> + <configuration> + <outputDirectory>${project.reporting.outputDirectory}/xsd</outputDirectory> + </configuration> + </execution> + <execution> + <id>site-docs</id> + <phase>pre-site</phase> + <goals> + <goal>xdoc</goal> + </goals> + </execution> + <execution> + <id>standard</id> <goals> <goal>java</goal> <goal>xpp3-reader</goal> <goal>xpp3-writer</goal> - <goal>xsd</goal> </goals> </execution> </executions> http://git-wip-us.apache.org/repos/asf/maven-scm/blob/609c4bdc/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/mdo/git-settings.mdo ---------------------------------------------------------------------- diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/mdo/git-settings.mdo b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/mdo/git-settings.mdo index 2b3c192..daeed6d 100644 --- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/mdo/git-settings.mdo +++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/main/mdo/git-settings.mdo @@ -23,9 +23,9 @@ xsi:schemaLocation="https://codehaus-plexus.github.io/MODELLO/1.1.0 https://codehaus-plexus.github.io/modello/xsd/modello-1.1.0.xsd"; xml.namespace="http://maven.apache.org/SCM/GIT/${version}"; xml.schemaLocation="http://maven.apache.org/xsd/scm-git-${version}.xsd";> - <id>git</id> + <id>git-settings</id> <name>Git</name> - <description>git Provider Model.</description> + <description>Git Provider Model</description> <defaults> <default> <key>package</key> http://git-wip-us.apache.org/repos/asf/maven-scm/blob/609c4bdc/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/site/site.xml ---------------------------------------------------------------------- diff --git a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/site/site.xml b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/site/site.xml index bc040b1..f246331 100644 --- a/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/site/site.xml +++ b/maven-scm-providers/maven-scm-providers-git/maven-scm-provider-git-commons/src/site/site.xml @@ -30,6 +30,7 @@ <item name="JavaDocs" href="apidocs/index.html"/> <item name="Source Xref" href="xref/index.html"/> <!--item name="FAQ" href="faq.html"/--> + <item name="git-settings.xml Reference" href="git-settings.html"/> </menu> <menu ref="reports" inherit="bottom" /> http://git-wip-us.apache.org/repos/asf/maven-scm/blob/609c4bdc/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/mdo/svn-settings.mdo ---------------------------------------------------------------------- diff --git a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/mdo/svn-settings.mdo b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/mdo/svn-settings.mdo index dd898ec..62e150f 100644 --- a/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/mdo/svn-settings.mdo +++ b/maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/src/main/mdo/svn-settings.mdo @@ -25,7 +25,7 @@ xml.schemaLocation="http://maven.apache.org/xsd/svn-settings-${version}.xsd";> <id>svn-settings</id> <name>Svn</name> - <description>SVN Provider Model.</description> + <description>Subversion Provider Model</description> <defaults> <default> <key>package</key> http://git-wip-us.apache.org/repos/asf/maven-scm/blob/609c4bdc/src/site/apt/git.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/git.apt b/src/site/apt/git.apt index 1dfbe33..29ba125 100644 --- a/src/site/apt/git.apt +++ b/src/site/apt/git.apt @@ -79,12 +79,5 @@ git push pushUrl currentBranch:currentBranch * Provider Configuration - The provider configuration is defined in <<<${user.home}/.scm/git-settings.xml>>>. - -------- -<git-settings> - <!-- will had the option --no-verify to the commit command can be helpfull to ignore trailing spaces issues with cygwin and the release plugin --> - <commitNoVerify>false</commitNoVerify> -</git-settings> -------- - + 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}}. http://git-wip-us.apache.org/repos/asf/maven-scm/blob/609c4bdc/src/site/apt/subversion.apt ---------------------------------------------------------------------- diff --git a/src/site/apt/subversion.apt b/src/site/apt/subversion.apt index e5ebe55..0f3f438 100644 --- a/src/site/apt/subversion.apt +++ b/src/site/apt/subversion.apt @@ -60,23 +60,8 @@ scm:svn:https://username:[email protected]/svn/root/module * Provider Configuration - The provider configuration is defined in <<<${user.home}/.scm/svn-settings.xml>>>. - - Here is an example of what a configuration file might look like: - -------- -<svn-settings> - <configDirectory>your_configuration_directory</configDirectory> - <useCygwinPath>true in order to use cygwin path /cygdrive/c</useCygwinPath> - <cygwinMountPath>the mount path to use default is /cygwin</cygwinMountPath> - <useNonInteractive>if false --non-interactive will not be used in the svn command line</useNonInteractive> - <useAuthCache>if true --no-auth-cache will not be used in the svn command line</useAuthCache> - <trustServerCert>if true --trust-server-cert will be used in the cli</trustServerCert> -</svn-settings> -------- - - For more info 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 {{{./maven-scm-providers/maven-scm-providers-svn/maven-scm-provider-svn-commons/svn-settings.html}reference guide}}. ** Configuration directory
