You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ar...@apache.org on 2006/07/12 11:23:43 UTC
svn commit: r421201 - in /maven/plugins/trunk/maven-rar-plugin: ./ src/site/
src/site/apt/ src/site/apt/examples/
Author: aramirez
Date: Wed Jul 12 02:23:42 2006
New Revision: 421201
URL: http://svn.apache.org/viewvc?rev=421201&view=rev
Log:
PR: MRAR-12
updated docs accdg to the plugin doc standard
Added:
maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/
maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/exclude-project-jar.apt
maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/include-extra-files.apt
maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/manifest.apt
maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/ra-custom-location.apt
maven/plugins/trunk/maven-rar-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-rar-plugin/src/site/apt/usage.apt
Modified:
maven/plugins/trunk/maven-rar-plugin/pom.xml
maven/plugins/trunk/maven-rar-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-rar-plugin/pom.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/pom.xml?rev=421201&r1=421200&r2=421201&view=diff
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-rar-plugin/pom.xml Wed Jul 12 02:23:42 2006
@@ -2,13 +2,17 @@
<parent>
<artifactId>maven-plugins</artifactId>
<groupId>org.apache.maven.plugins</groupId>
- <version>1</version>
+ <version>2-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>maven-rar-plugin</artifactId>
<packaging>maven-plugin</packaging>
<name>Maven Rar plugin</name>
<version>2.2-SNAPSHOT</version>
+ <inceptionYear>2004</inceptionYear>
+ <prerequisites>
+ <maven>2.0</maven>
+ </prerequisites>
<dependencies>
<dependency>
<groupId>org.apache.maven</groupId>
Added: maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/exclude-project-jar.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/exclude-project-jar.apt?rev=421201&view=auto
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/exclude-project-jar.apt (added)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/exclude-project-jar.apt Wed Jul 12 02:23:42 2006
@@ -0,0 +1,36 @@
+ ------
+ Maven 2 RAR Plugin - Exclude the project jar
+ ------
+ Stephane Nicoll
+ Allan Ramirez
+ ------
+ July 2006
+ ------
+
+Exclude the project jar in the RAR
+
+ By default, the generated JAR file is included in the RAR file. This behavior
+ is controlled by the <<includeJar>> property. For instance, to exclude the generated
+ JAR file from the RAR, set the <<includeJar>> property to <<false>>.
+
++---+
+[...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-rar-plugin</artifactId>
+ <configuration>
+ <includeJar>false</includeJar>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+[...]
++----+
+
+ Then execute the plugin by invoking the <<<rar:rar>>> goal.
+
++----+
+mvn rar:rar
++----+
Added: maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/include-extra-files.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/include-extra-files.apt?rev=421201&view=auto
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/include-extra-files.apt (added)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/include-extra-files.apt Wed Jul 12 02:23:42 2006
@@ -0,0 +1,54 @@
+ ------
+ Maven RAR Plugin - Including extra files in the RAR
+ ------
+ Allan Ramirez
+ ------
+ July 2006
+ ------
+
+Include extra files in the RAR
+
+ Extra files may also be included in the generated archive(rar). By default,
+ all files placed inside the <<<src/main/rar>>> will be included.
+
++---+
+project
+|--pom.xml
+|--src
+ `--main
+ |--rar
+ | `-- <!-- put the extra files here -->
+ |--java
+ [...]
++---+
+
+ Then execute the plugin by invoking the <<<rar:rar>>> goal.
+
++---+
+mvn rar:rar
++---+
+
+ To be able to change the location of the directory, configure the
+ <<<rarSourceDirectory>>> property and set a path for it.
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-rar-plugin</artifactId>
+ <configuration>
+ <rarSourceDirectory>some-path</rarSourceDirectory>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++----+
+
+
+
+
Added: maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/manifest.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/manifest.apt?rev=421201&view=auto
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/manifest.apt (added)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/manifest.apt Wed Jul 12 02:23:42 2006
@@ -0,0 +1,32 @@
+ ------
+ Maven 2 RAR Plugin - Adding manifest in the RAR
+ ------
+ Allan Ramirez
+ ------
+ July 2006
+ ------
+
+Adding Manifest File
+
+ By default, The RAR plugin retrieves the manifest file to use in this
+ location <<<${basedir}/src/main/rar/META-INF/MANIFEST.MF>>>. To be able to
+ change the location, configure the <<manifestFile>> property and set the
+ value to the new location.
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-rar-plugin</artifactId>
+ <configuration>
+ <manifestFile>src/resources/META-INF/MANIFEST.MF</manifestFile>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++----+
\ No newline at end of file
Added: maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/ra-custom-location.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/ra-custom-location.apt?rev=421201&view=auto
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/ra-custom-location.apt (added)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/apt/examples/ra-custom-location.apt Wed Jul 12 02:23:42 2006
@@ -0,0 +1,38 @@
+ ------
+ Maven 2 RAR Plugin - Custom location of the Resource Adapter Descriptor
+ ------
+ Stephane Nicoll
+ Allan Ramirez
+ ------
+ July 2006
+ ------
+
+Custom location of the Resource Adapter Descriptor
+
+ It is also possible to specify a custom location for the ra.xml file. For
+ instance to use the file located in <<<src/resources/ra.xml>>>, configure your
+ project as follows:
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-rar-plugin</artifactId>
+ <configuration>
+ <raXmlFile>src/resources/ra.xml</raXmlFile>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ [...]
+</project>
++----+
+
+ Then execute the plugin by invoking the <<<rar:rar>>> goal.
+
++----+
+mvn rar:rar
++----+
\ No newline at end of file
Added: maven/plugins/trunk/maven-rar-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/apt/index.apt?rev=421201&view=auto
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/apt/index.apt (added)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/apt/index.apt Wed Jul 12 02:23:42 2006
@@ -0,0 +1,31 @@
+ ------
+ Maven 2 RAR Plugin
+ ------
+ Allan Ramirez
+ ------
+ July 2006
+ ------
+
+Maven 2 RAR Plugin - Introduction
+
+ A resource adapter is a system-level software driver that a Java application
+ uses to connect to an enterprise information system (EIS). The RAR plugin
+ has the capability to store these resource adapters to an archive (Resource
+ Adapter Archive or RAR) which can be deployed to a J2EE server.
+
+* Goals Overview
+
+ The RAR plugin has only one goal:
+
+ * {{{rar-mojo.html}rar:rar}} used to package the Resource Adapter Archive
+ (RAR) files.
+
+ []
+
+* How to Use
+
+ Instructions on how to use the RAR plugin can be found {{{usage.html}here}}.
+
+* Examples
+
+ Sample use-cases for the plugin are available under the Examples menu.
\ No newline at end of file
Added: maven/plugins/trunk/maven-rar-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/apt/usage.apt?rev=421201&view=auto
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/apt/usage.apt (added)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/apt/usage.apt Wed Jul 12 02:23:42 2006
@@ -0,0 +1,52 @@
+ ------
+ Maven 2 RAR Plugin
+ ------
+ Allan Ramirez
+ ------
+ July 2006
+ ------
+
+Usage
+
+ The RAR plugin is binded to the <<<package>>> phase of the build lifecycle.
+ To be able to generate the RAR as part of the lifecycle, the plugin should
+ be declared at the \<build\> section of the pom.
+
++---+
+<project>
+ [...]
+ <build>
+ <plugins>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-rar-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>test</id>
+ <goals>
+ <goal>rar</goal>
+ </goals>
+ <configuration>
+ <!-- your configuration here -->
+ </configuration>
+ </execution>
+ </plugins>
+ </build>
+ [...]
+</project>
++---+
+
+ then invoke the <<<package>>> phase.
+
++---+
+mvn package
++---+
+
+ Another way to execute the plugin is to call the <<<rar:rar>>> goal.
+
++---+
+mvn rar:rar
++---+
+
+ By default, the generated archive(RAR) can be located at the project's target
+ directory.
+
Modified: maven/plugins/trunk/maven-rar-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-rar-plugin/src/site/site.xml?rev=421201&r1=421200&r2=421201&view=diff
==============================================================================
--- maven/plugins/trunk/maven-rar-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-rar-plugin/src/site/site.xml Wed Jul 12 02:23:42 2006
@@ -33,8 +33,15 @@
</links>
<menu name="Overview">
- <item name="Introduction" href="introduction.html"/>
- <item name="How to Use" href="howto.html"/>
+ <item name="Introduction" href="index.html"/>
+ <item name="Usage" href="usage.html"/>
+ <item name="FAQ" href="faq.html"/>
+ </menu>
+ <menu name="Examples">
+ <item name="Exclude the project jar from the rar" href="examples/exclude-project-jar.html"/>
+ <item name="Custom location of Resource Adapter Descriptor" href="examples/ra-custom-location.html" />
+ <item name="Include extra files in RAR" href="examples/include-extra-files.html" />
+ <item name="Adding Manifest File" href="examples/manifest.html" />
</menu>
${reports}
</body>