Author: dennisl Date: Sat Jul 14 12:57:56 2007 New Revision: 556332 URL: http://svn.apache.org/viewvc?view=rev&rev=556332 Log: o Sync titles. o Use standard indentation in the pom examples, 2 spaces. o Use version 1.0 of the SCM plugin in the pom examples, instead of 1.0-SNAPSHOT.
Modified: maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt maven/scm/trunk/maven-scm-plugin/src/site/apt/index.apt maven/scm/trunk/maven-scm-plugin/src/site/apt/usage.apt maven/scm/trunk/maven-scm-plugin/src/site/site.xml Modified: maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt?view=diff&rev=556332&r1=556331&r2=556332 ============================================================================== --- maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt (original) +++ maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/bootstrapping-with-pom.apt Sat Jul 14 12:57:56 2007 @@ -1,12 +1,12 @@ ------ - Maven SCM Plugin - bootstrapping using a pom + Bootstrapping a Project Using a POM ------ Pete Marvin King ------ 20 July 2006 ------ -Bootstrapping a project using a pom file +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 @@ -15,34 +15,34 @@ The <<<pom.xml>>> should contain a scm configuration for the bootstrap to work. +-----------+ - <project> +<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.cvs</url> - <scm> - [...] - <build> - [...] - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-scm-plugin</artifactId> - <version>1.0-SNAPSHOT</version> - <configuration> - <goals>install</goals> - </configuration> - </plugin> - </plugins> - [...] - </build> + <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.cvs</url> + <scm> [...] - </project> + <build> + [...] + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scm-plugin</artifactId> + <version>1.0</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 @@ -63,25 +63,20 @@ +-----------+ [...] - <build> - [...] - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-scm-plugin</artifactId> - <version>1.0-SNAPSHOT</version> - <configuration> - <username>username</username> - <password>password</password> - </configuration> - </plugin> - </plugins> - [...] - </build> + <build> + [...] + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scm-plugin</artifactId> + <version>1.0</version> + <configuration> + <username>username</username> + <password>password</password> + </configuration> + </plugin> + </plugins> + [...] + </build> [...] +-----------+ - - - - - Modified: maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt?view=diff&rev=556332&r1=556331&r2=556332 ============================================================================== --- maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt (original) +++ maven/scm/trunk/maven-scm-plugin/src/site/apt/examples/scm-advance-features.apt Sat Jul 14 12:57:56 2007 @@ -1,26 +1,26 @@ ------ - Maven SCM Plugin - other scm features + Other SCM Commands ------ Pete Marvin King ------ 20 July 2006 ------ -Basic SCM Configuration +Other SCM Commands The scm plugin requires the scm to be configured in the <<<pom.xml>>>. +---------+ [...] - <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.cvs</url> - </scm> + <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.cvs</url> + </scm> [...] +---------+ @@ -28,24 +28,24 @@ instead of the pure java implementation, you must configure your plugin like that: +-----------+ -[...] - <build> - [...] - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-scm-plugin</artifactId> - <configuration> - <providerImplementations> - <cvs>cvs_native</cvs> - </providerImplementations> - </configuration> - </plugin> - [...] - </plugins - [...] - </build> -[...] + [...] + <build> + [...] + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scm-plugin</artifactId> + <configuration> + <providerImplementations> + <cvs>cvs_native</cvs> + </providerImplementations> + </configuration> + </plugin> + [...] + </plugins + [...] + </build> + [...] +-----------+ Once the scm has been configured, scm operations can be performed. @@ -55,24 +55,24 @@ <<<pom.xml>>> configuration : +-----------+ -[...] - <build> - [...] - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-scm-plugin</artifactId> - <version>1.0-SNAPSHOT</version> - <configuration> - <startDate>YYYY-MM-DD</startDate> - <endDate>YYYY-MM-DD</endDate> - </configuration> - </plugin> - [...] - </plugins - [...] - </build> -[...] + [...] + <build> + [...] + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scm-plugin</artifactId> + <version>1.0</version> + <configuration> + <startDate>YYYY-MM-DD</startDate> + <endDate>YYYY-MM-DD</endDate> + </configuration> + </plugin> + [...] + </plugins + [...] + </build> + [...] +-----------+ Command : @@ -93,24 +93,24 @@ <<<pom.xml>>> configuration : +-----------+ -[...] - <build> - [...] - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-scm-plugin</artifactId> - <version>1.0-SNAPSHOT</version> - <configuration> - <startRevision>connection</startRevision> - <endRevision>connection</endRevision> - </configuration> - </plugin> - [...] - </plugins - [...] - </build> -[...] + [...] + <build> + [...] + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scm-plugin</artifactId> + <version>1.0</version> + <configuration> + <startRevision>connection</startRevision> + <endRevision>connection</endRevision> + </configuration> + </plugin> + [...] + </plugins + [...] + </build> + [...] +-----------+ Command : @@ -146,23 +146,23 @@ <<<pom.xml>>> configuration : +-----------+ -[...] - <build> - [...] - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-scm-plugin</artifactId> - <version>1.0-SNAPSHOT</version> - <configuration> - <tagName>tag</tagName> - </configuration> - </plugin> - [...] - </plugins - [...] - </build> -[...] + [...] + <build> + [...] + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scm-plugin</artifactId> + <version>1.0</version> + <configuration> + <tagName>tag</tagName> + </configuration> + </plugin> + [...] + </plugins + [...] + </build> + [...] +-----------+ Command : Modified: maven/scm/trunk/maven-scm-plugin/src/site/apt/index.apt URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/site/apt/index.apt?view=diff&rev=556332&r1=556331&r2=556332 ============================================================================== --- maven/scm/trunk/maven-scm-plugin/src/site/apt/index.apt (original) +++ maven/scm/trunk/maven-scm-plugin/src/site/apt/index.apt Sat Jul 14 12:57:56 2007 @@ -1,5 +1,5 @@ ------ - Maven SCM Plugin + Introduction ------ Pete Marvin King ------ Modified: maven/scm/trunk/maven-scm-plugin/src/site/apt/usage.apt URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/site/apt/usage.apt?view=diff&rev=556332&r1=556331&r2=556332 ============================================================================== --- maven/scm/trunk/maven-scm-plugin/src/site/apt/usage.apt (original) +++ maven/scm/trunk/maven-scm-plugin/src/site/apt/usage.apt Sat Jul 14 12:57:56 2007 @@ -1,12 +1,12 @@ ------ - Maven SCM Plugin - basic usage + Usage ------ Pete Marvin King ------ 18 July 2006 ------ -Introduction +Usage The scm plugin maps a lot of commands to a variety of scm implementations. But there are only 2 frequently used commands: @@ -25,20 +25,20 @@ +---------+ [...] - <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.cvs</url> - </scm> + <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.cvs</url> + </scm> [...] +---------+ 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 : + The scm configuration url is composed of different information that defines the mapping: +------+ scm:svn:http://somerepository.com/svn_repo/trunk @@ -72,21 +72,21 @@ +-----------+ [...] - <build> - [...] - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-scm-plugin</artifactId> - <version>1.0-SNAPSHOT</version> - <configuration> - <connectionType>connection</connectionType> - </configuration> - </plugin> - [...] - </plugins - [...] - </build> + <build> + [...] + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scm-plugin</artifactId> + <version>1.0-SNAPSHOT</version> + <configuration> + <connectionType>connection</connectionType> + </configuration> + </plugin> + [...] + </plugins + [...] + </build> [...] +-----------+ @@ -94,21 +94,21 @@ +-----------+ [...] - <build> - [...] - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-scm-plugin</artifactId> - <version>1.0-SNAPSHOT</version> - <configuration> - <connectionType>developerConnection</connectionType> - </configuration> - </plugin> - [...] - </plugins - [...] - </build> + <build> + [...] + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scm-plugin</artifactId> + <version>1.0-SNAPSHOT</version> + <configuration> + <connectionType>developerConnection</connectionType> + </configuration> + </plugin> + [...] + </plugins + [...] + </build> [...] +-----------+ @@ -116,5 +116,4 @@ Related Links {{{http://docs.codehaus.org/display/SCM/SCM+Matrix}SCM Plugin Matrix}} - - + \ No newline at end of file Modified: maven/scm/trunk/maven-scm-plugin/src/site/site.xml URL: http://svn.apache.org/viewvc/maven/scm/trunk/maven-scm-plugin/src/site/site.xml?view=diff&rev=556332&r1=556331&r2=556332 ============================================================================== --- maven/scm/trunk/maven-scm-plugin/src/site/site.xml (original) +++ maven/scm/trunk/maven-scm-plugin/src/site/site.xml Sat Jul 14 12:57:56 2007 @@ -18,7 +18,7 @@ ~ under the License. --> -<project name="Maven"> +<project> <skin> <groupId>org.apache.maven.skins</groupId> <artifactId>maven-stylus-skin</artifactId> @@ -50,8 +50,8 @@ <!-- item name="FAQ" href="faq.html" / --> </menu> <menu name="Examples"> - <item name="Bootstrapping using a POM file" href="examples/bootstrapping-with-pom.html"/> - <item name="Other SCM commands" href="examples/scm-advance-features.html"/> + <item name="Bootstrapping a Project Using a POM" href="examples/bootstrapping-with-pom.html"/> + <item name="Other SCM Commands" href="examples/scm-advance-features.html"/> </menu> <menu name="Quick Links"> <item name="Maven SCM Home" href="http://maven.apache.org/scm/"/>