geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From djen...@apache.org
Subject svn commit: r573884 - in /geronimo/server/trunk/maven-plugins/car-maven-plugin: ./ src/main/java/org/apache/geronimo/mavenplugins/car/ src/site/ src/site/fml/
Date Sat, 08 Sep 2007 17:37:57 GMT
Author: djencks
Date: Sat Sep  8 10:37:55 2007
New Revision: 573884

URL: http://svn.apache.org/viewvc?rev=573884&view=rev
Log:
Fix up the car-maven-plugin documentation a little bit

Added:
    geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/fml/
    geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/fml/faq.fml
Modified:
    geronimo/server/trunk/maven-plugins/car-maven-plugin/pom.xml
    geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/AbstractCarMojo.java
    geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/CreatePluginListMojo.java
    geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PackageMojo.java
    geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PlanProcessorMojo.java
    geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PluginMetadataGeneratorMojo.java
    geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/UpdatePluginListMojo.java
    geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/ValidateConfigurationMojo.java
    geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/site.xml

Modified: geronimo/server/trunk/maven-plugins/car-maven-plugin/pom.xml
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/car-maven-plugin/pom.xml?rev=573884&r1=573883&r2=573884&view=diff
==============================================================================
--- geronimo/server/trunk/maven-plugins/car-maven-plugin/pom.xml (original)
+++ geronimo/server/trunk/maven-plugins/car-maven-plugin/pom.xml Sat Sep  8 10:37:55 2007
@@ -34,7 +34,15 @@
     <artifactId>car-maven-plugin</artifactId>
     <name>Geronimo Maven2 Plugins :: CAR</name>
     <packaging>maven-plugin</packaging>
+
+    <description>The car-maven-plugin handles all aspects of "predeploying" a module
into a Geronimo car file and installing car files into a Geronimo server.
+    As part of this it processes plan files to include the module Id and dependencies, and
generates geronimo-plugin.xml metadata files and
+    manages a geronimo-plugins.xml catalog in the local maven repository.</description>
     
+    <prerequisites>
+        <maven>2.0.5</maven>
+    </prerequisites>
+
     <dependencies>
         <dependency>
             <groupId>javax.xml.bind</groupId>

Modified: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/AbstractCarMojo.java
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/AbstractCarMojo.java?rev=573884&r1=573883&r2=573884&view=diff
==============================================================================
--- geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/AbstractCarMojo.java
(original)
+++ geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/AbstractCarMojo.java
Sat Sep  8 10:37:55 2007
@@ -79,6 +79,8 @@
     protected MavenProjectHelper projectHelper;
     
     /**
+     * dependency resolution for the maven repository
+     *
      * @component
      */
     protected DependencyHelper dependencyHelper = null;

Modified: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/CreatePluginListMojo.java
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/CreatePluginListMojo.java?rev=573884&r1=573883&r2=573884&view=diff
==============================================================================
--- geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/CreatePluginListMojo.java
(original)
+++ geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/CreatePluginListMojo.java
Sat Sep  8 10:37:55 2007
@@ -45,6 +45,11 @@
 import org.xml.sax.SAXException;
 
 /**
+ * Creates or replaces a geronimo-plugins.xml catalog of geronimo plugins in the local maven
repository.  Although geronimo-plugins.xml is
+ * maintained automatically when you build geronimo plugins locally, this is useful if you
have downloaded plugins from elsewhere or
+ * corrupted the geronimo-plugins.xml file.  This must be run explcitly using the command
line
+ * mvn org.apache.geronimo.plugins:car-maven-plugin:create-pluginlist
+ *
  * @version $Rev$ $Date$
  * @goal create-pluginlist
  */

Modified: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PackageMojo.java
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PackageMojo.java?rev=573884&r1=573883&r2=573884&view=diff
==============================================================================
--- geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PackageMojo.java
(original)
+++ geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PackageMojo.java
Sat Sep  8 10:37:55 2007
@@ -232,9 +232,12 @@
     private boolean bootstrap = false;
 
     /**
+     * Location of resources directory for additional content to include in the car.
+     *
      * @parameter expression="${project.build.directory}/resources"
      */
     private File resourcesDir;
+
     /**
      * Holds a local repo lookup instance so that we can use the current project to resolve.
      * This is required since the Kernel used to deploy is cached.

Modified: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PlanProcessorMojo.java
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PlanProcessorMojo.java?rev=573884&r1=573883&r2=573884&view=diff
==============================================================================
--- geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PlanProcessorMojo.java
(original)
+++ geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PlanProcessorMojo.java
Sat Sep  8 10:37:55 2007
@@ -47,7 +47,7 @@
 //
 
 /**
- * Add dependencies to a plan and process with velocity
+ * Add module id and dependencies to a plan and process with velocity
  *
  * @version $Rev$ $Date$
  * @goal prepare-plan
@@ -59,35 +59,49 @@
     private static final QName ENVIRONMENT_QNAME = new QName("http://geronimo.apache.org/xml/ns/deployment-1.2",
"environment");
 
     /**
+     * Location of unproccesed plan, normally missing moduleId and dependencies.
+     *
      * @parameter expression="${basedir}/src/main/plan"
      * @required
      */
     protected File sourceDir = null;
 
     /**
+     * Directory to put the processed plan in.
+     *
      * @parameter expression="${project.build.directory}/resources/META-INF"
      * @required
      */
     protected File targetDir = null;
 
     /**
+     * Name of the unprocessed source and processed target plan file.
+     *
      * @parameter default-value="plan.xml"
      * @required
      */
     protected String planFileName = null;
 
     /**
+     * XXX
+     *
      * @parameter expression="${project.build.directory}/resources/META-INF/plan.xml"
      * @required
      */
     protected File targetFile = null;
 
     /**
+     * Dependencies explicitly listed in the car-maven-plugin configuration
+     *
      * @parameter
      */
     private List<Dependency> dependencies = Collections.emptyList();
 
     /**
+     * Configuration of use of maven dependencies.  If missing or if value element is false,
use the explicit list in the car-maven-plugin configuration.
+     * If present and true, use the maven dependencies in the current pom file of scope null,
runtime, or compile.  In addition, the version of the maven
+     * dependency can be included or not depending on the includeVersion element.
+     *
      * @parameter
      */
     private UseMavenDependencies useMavenDependencies;

Modified: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PluginMetadataGeneratorMojo.java
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PluginMetadataGeneratorMojo.java?rev=573884&r1=573883&r2=573884&view=diff
==============================================================================
--- geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PluginMetadataGeneratorMojo.java
(original)
+++ geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/PluginMetadataGeneratorMojo.java
Sat Sep  8 10:37:55 2007
@@ -36,7 +36,7 @@
 import org.codehaus.plexus.configuration.PlexusConfiguration;
 
 /**
- * Add dependencies to a plan and process with velocity
+ * Generate a geronimo-plugin.xml file based on configuration in the pom and car-maven-plugin
configuration.
  *
  * @version $Rev$ $Date$
  * @goal prepare-metadata
@@ -46,62 +46,70 @@
 
 
     /**
+     * Directory for generated plugin metadata file.
+     *
      * @parameter expression="${project.build.directory}/resources/META-INF"
      * @required
      */
     protected File targetDir = null;
 
     /**
+     * Name of generated plugin metadata file.
+     *
      * @parameter default-value="geronimo-plugin.xml"
      * @required
      */
     protected String pluginMetadataFileName = null;
 
     /**
+     * Full path of generated plugin metadata file.
+     *
      * @parameter expression="${project.build.directory}/resources/META-INF/geronimo-plugin.xml"
      * @required
      */
     protected File targetFile = null;
 
     /**
+     * Whether licenses (copied from maven licence elements) are OSI approved.
+     *
      * @parameter default-value="false"
      */
     private boolean osiApproved;
 
     /**
-     * @parameter
-     */
-    private List<String> geronimoVersions = Collections.emptyList();
-
-    /**
-     * @parameter
-     */
-    private List<String> jvmVersions = Collections.emptyList();
-
-    /**
+     * Category of the geronimo plugin.
+     *
      * @parameter
      */
     private String category;
 
     /**
+     * Dependencies explicitly listed in the car-maven-plugin configuration
+     *
      * @parameter
      */
     private List<Dependency> dependencies = Collections.emptyList();
 
     /**
+     * Configuration of use of maven dependencies.  If missing or if value element is false,
use the explicit list in the car-maven-plugin configuration.
+     * If present and true, use the maven dependencies in the current pom file of scope null,
runtime, or compile.  In addition, the version of the maven
+     * dependency can be included or not depending on the includeVersion element.
+     *
      * @parameter
      */
     private UseMavenDependencies useMavenDependencies;
 
     /**
-     * shared configuration from parent that we merge since maven is incompetent at it.
+     * Shared configuration from parent that we merge since maven is incompetent at it. 
This is a plugin-artifactType element without moduleId or dependencies.
+     * Do not attempt to include more than one of these in the parent poms since maven will
not merge them correctly.
      *
      * @parameter
      */
     private PlexusConfiguration commonInstance;
 
     /**
-     * configuration for this instance itself
+     * Configuration for this instance itself.  This is a plugin-artifactType element without
moduleId or dependencies. Do not include more than one of these in the parent poms
+     * since maven will not merge them correctly.
      *
      * @parameter
      */

Modified: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/UpdatePluginListMojo.java
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/UpdatePluginListMojo.java?rev=573884&r1=573883&r2=573884&view=diff
==============================================================================
--- geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/UpdatePluginListMojo.java
(original)
+++ geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/UpdatePluginListMojo.java
Sat Sep  8 10:37:55 2007
@@ -36,12 +36,16 @@
 import org.apache.geronimo.system.plugin.model.PluginArtifactType;
 
 /**
+ * Maintain the geronimo-plugins.xml catalog in the local maven repository by merging in
the geronimo-plugin.xml from the current project.
+ *
  * @version $Rev$ $Date$
  * @goal update-pluginlist
  */
 public class UpdatePluginListMojo extends AbstractCarMojo {
 
     /**
+     * Location of the (just generated) plugin metadata file to merge into the geronimo-plugins.xml
catalog in the local maven repository.
+     *
      * @parameter expression="${project.build.directory}/resources/META-INF/geronimo-plugin.xml"
      * @required
      */

Modified: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/ValidateConfigurationMojo.java
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/ValidateConfigurationMojo.java?rev=573884&r1=573883&r2=573884&view=diff
==============================================================================
--- geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/ValidateConfigurationMojo.java
(original)
+++ geronimo/server/trunk/maven-plugins/car-maven-plugin/src/main/java/org/apache/geronimo/mavenplugins/car/ValidateConfigurationMojo.java
Sat Sep  8 10:37:55 2007
@@ -26,6 +26,8 @@
 
 
 /**
+ * Check that all dependencies mentioned explicitly in the car-maven-plugin configuration
are present as maven dependencies.
+ *
  * @goal validate-configuration
 
  * @version $Rev$ $Date$
@@ -33,6 +35,8 @@
 public class ValidateConfigurationMojo extends AbstractCarMojo {
 
     /**
+     * Dependencies explicitly listed in the car-maven-plugin configuration
+     *
      * @parameter
      */
     private List<Dependency> dependencies = Collections.emptyList();

Added: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/fml/faq.fml?rev=573884&view=auto
==============================================================================
--- geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/fml/faq.fml (added)
+++ geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/fml/faq.fml Sat Sep  8 10:37:55
2007
@@ -0,0 +1,50 @@
+<?xml version="1.0"?>
+<!--
+    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.
+-->
+
+<!-- $Rev: $ $Date: $ -->
+
+<faqs id="FAQ" title="Frequently Asked Questions">
+    <part id="General">
+        <faq id="Where do I put the source plan">
+            <question>Where do I put the source plan?</question>
+            <answer>
+                <p>
+                    Put the source plan in
+                    <i>${basedir}/src/main/plan/</i>
+                    directory.
+                </p>
+            </answer>
+        </faq>
+        <faq id="How do I configure whether to use the maven dependencies">
+            <question>How do I configure whether to use the maven dependencies?</question>
+            <answer>
+                <p>
+                    By default the dependencies included in the car-maven-plugin configuration
are used. This allows you to precisely specify
+                    exactly which dependencies are included, their version, and the importType.
If you do not need this level of control you
+                    may wish to use the maven dependencies instead. To do this include an
element
+                    <useMavenDependencies>
+                        <value>true</value>
+                        <includeVersion>true</includeVersion>
+                    </useMavenDependencies>
+                </p>
+            </answer>
+        </faq>
+    </part>
+</faqs>

Modified: geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/site.xml?rev=573884&r1=573883&r2=573884&view=diff
==============================================================================
--- geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/site.xml (original)
+++ geronimo/server/trunk/maven-plugins/car-maven-plugin/src/site/site.xml Sat Sep  8 10:37:55
2007
@@ -32,6 +32,7 @@
             <item name="Overview" href="index.html"/>
             <item name="Usage" href="usage.html"/>
             <item name="Configuration" href="plugin-info.html"/>
+            <item name="FAQ" href="faq.html"/>
         </menu>
         
         ${reports}



Mime
View raw message