Return-Path: 
 <scm-return-14768-apmail-geronimo-scm-archive=geronimo.apache.org@geronimo.apache.org>
Delivered-To: apmail-geronimo-scm-archive@www.apache.org
Received: (qmail 3365 invoked from network); 3 Sep 2006 10:35:02 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199)
  by minotaur.apache.org with SMTP; 3 Sep 2006 10:35:02 -0000
Received: (qmail 44548 invoked by uid 500); 3 Sep 2006 10:35:01 -0000
Delivered-To: apmail-geronimo-scm-archive@geronimo.apache.org
Received: (qmail 44522 invoked by uid 500); 3 Sep 2006 10:35:01 -0000
Mailing-List: contact scm-help@geronimo.apache.org; run by ezmlm
Precedence: bulk
list-help: <mailto:scm-help@geronimo.apache.org>
list-unsubscribe: <mailto:scm-unsubscribe@geronimo.apache.org>
List-Post: <mailto:scm@geronimo.apache.org>
Reply-To: dev@geronimo.apache.org
List-Id: <scm.geronimo.apache.org>
Delivered-To: mailing list scm@geronimo.apache.org
Received: (qmail 44511 invoked by uid 99); 3 Sep 2006 10:35:01 -0000
Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49)
    by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 03 Sep 2006 03:35:01 -0700
X-ASF-Spam-Status: No, hits=-9.4 required=10.0
	tests=ALL_TRUSTED,NO_REAL_NAME
X-Spam-Check-By: apache.org
Received-SPF: pass (asf.osuosl.org: local policy)
Received: from [140.211.166.113] (HELO eris.apache.org) (140.211.166.113)
    by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 03 Sep 2006 03:35:00 -0700
Received: by eris.apache.org (Postfix, from userid 65534)
	id 69DA71A981A; Sun,  3 Sep 2006 03:34:40 -0700 (PDT)
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r439756 - in
 /geronimo/server/trunk/maven-plugins/geronimo-maven-plugin: pom.xml
 src/site/apt/usage.apt
Date: Sun, 03 Sep 2006 10:34:39 -0000
To: scm@geronimo.apache.org
From: jdillon@apache.org
X-Mailer: svnmailer-1.0.8
Message-Id: <20060903103440.69DA71A981A@eris.apache.org>
X-Virus-Checked: Checked by ClamAV on apache.org
X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N

Author: jdillon
Date: Sun Sep  3 03:34:39 2006
New Revision: 439756

URL: http://svn.apache.org/viewvc?rev=439756&view=rev
Log:
Update site docs

Modified:
    geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/pom.xml
    geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage.apt

Modified: geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/pom.xml
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/pom.xml?rev=439756&r1=439755&r2=439756&view=diff
==============================================================================
--- geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/pom.xml (original)
+++ geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/pom.xml Sun Sep  3 03:34:39 2006
@@ -32,6 +32,10 @@
     <name>Geronimo Maven2 Plugins :: Geronimo</name>
     <packaging>maven-plugin</packaging>
     
+    <description>
+        Geronimo plugin for Maven 2; used to install, start and stop the server.
+    </description>
+    
     <build>
         <plugins>
             <plugin>

Modified: geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage.apt?rev=439756&r1=439755&r2=439756&view=diff
==============================================================================
--- geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage.apt (original)
+++ geronimo/server/trunk/maven-plugins/geronimo-maven-plugin/src/site/apt/usage.apt Sun Sep  3 03:34:39 2006
@@ -1,15 +1,168 @@
  ------
- TODO
+ Geronimo Plugin for Maven 2
  ------
  ???
  ------
  ???
 
-TODO
+Basic Usage
 
-* TODO
+* Assembly Artifact Configuration
+
+ Before the plugin can start or stop a server, it needs to know about the
+ assembly (or asemblies) which it will install.
+ 
+ This example shows one assembly, which will be used to install unless the
+ <<<assemblyArchive>>> parameter has been set.
+
++----------+
+<plugin>
+    <groupId>org.apache.geronimo.plugins</groupId>
+    <artifactId>geronimo-maven-plugin</artifactId>
+    
+    <configuration>
+        <assemblies>
+            <assembly>
+                <groupId>org.apache.geronimo.assemblies</groupId>
+                <artifactId>geronimo-jetty-j2ee</artifactId>
+                <version>${pom.version}</version>
+                <classifier>bin</classifier>
+                <type>zip</type>
+            </assembly>
+    </configuration>
+</plugin>
++----------+
+
+ Multipule assemblies may be specified.  Each must have a unique id, and either
+ <<<defaultAssemblyId>>> or <<<assemblyId>>> must be configured to inform the
+ plugin which assembly to use.
+ 
++----------+
+<plugin>
+    <groupId>org.apache.geronimo.plugins</groupId>
+    <artifactId>geronimo-maven-plugin</artifactId>
+    
+    <configuration>
+        <assemblies>
+            <assembly>
+                <id>jetty</id>
+                <groupId>org.apache.geronimo.assemblies</groupId>
+                <artifactId>geronimo-jetty-j2ee</artifactId>
+                <version>${pom.version}</version>
+                <classifier>bin</classifier>
+                <type>zip</type>
+            </assembly>
+            
+            <assembly>
+                <id>jetty-minimal</id>
+                <groupId>org.apache.geronimo.assemblies</groupId>
+                <artifactId>geronimo-jetty-minimal</artifactId>
+                <version>${pom.version}</version>
+                <classifier>bin</classifier>
+                <type>zip</type>
+            </assembly>
+            
+            <assembly>
+                <id>tomcat</id>
+                <groupId>org.apache.geronimo.assemblies</groupId>
+                <artifactId>geronimo-tomcat-j2ee</artifactId>
+                <version>${pom.version}</version>
+                <classifier>bin</classifier>
+                <type>zip</type>
+            </assembly>
+            
+            <assembly>
+                <id>tomcat-minimal</id>
+                <groupId>org.apache.geronimo.assemblies</groupId>
+                <artifactId>geronimo-tomcat-minimal</artifactId>
+                <version>${pom.version}</version>
+                <classifier>bin</classifier>
+                <type>zip</type>
+            </assembly>
+        </assemblies>
+        
+        <defaultAssemblyId>jetty</defaultAssemblyId>
+    </configuration>
+</plugin>
++----------+
+
+* Starting Geronimo Server
+
+ If you have configured an assembly (or assemblies with a default), then
+ simply:
+
++----------+
+mvn geronimo:start
++----------+
+
+ The assembly archive will be installed if it does not already exist, or if
+ the plugin detects that the current archive is newer than the last installation.
+
+ Some additional flags may be passed in to alter the startup behavor.  For example
+ to enable verbose mode:
+
++----------+
+mvn geronimo:start -Dverbose=true
++----------+
+
+* Stopping Geronimo Server
+
+ To stop the server, simply:
+
++----------+
+mvn geronimo:stop
++----------+
+
+ Additonal parameters may be passed in on the command-line:
+
++----------+
+mvn geronimo:stop -Dusername=system -Dpassword=manager -Dport=1099
++----------+
+
+* Selecting an Assembly
+
+ Once you have a set of assemblies configured with unique ids, you can specify
+ the id of the assembly you wish to use on the command-line:
+
++----------+
+mvn geronimo:start -DassemblyId=tomcat
++----------+
+
+ Currently you need to specify the assemblyId for <<<geronimo:stop>>> too.
 
 +----------+
-TODO
+mvn geronimo:stop -DassemblyId=tomcat
 +----------+
 
+* Start/Stop for Integration Testing
+
+ For inline integration testing, you can set the <<<background>>> parameter
+ on the <<<start>>> goal to start the server, wait for it to load and then
+ return control to Maven so that it can execute integration tests.
+
++----------+
+<plugin>
+    <groupId>org.apache.geronimo.plugins</groupId>
+    <artifactId>geronimo-maven-plugin</artifactId>
+    <executions>
+        <execution>
+            <id>start-server</id>
+            <phase>pre-integration-test</phase>
+            <goals>
+                <goal>start</goal>
+            </goals>
+            <configuration>
+                <background>true</background>
+            </configuration>
+        </execution>
+        
+        <execution>
+            <id>stop-server</id>
+            <phase>post-integration-test</phase>
+            <goals>
+                <goal>stop</goal>
+            </goals>
+        </execution>
+    </executions>
+</plugin>
++----------+