CVS: jcontainer/loom/plugins/maven-sar/xdocs goals.xml,1.1,1.2 index.xml,1.1,1.2 navigation.xml,1.1,1.2 properties.xml,1.4,1.5 tips.xml,1.1,1.2
Peter Donald <pdonald-yCVjj/[email protected]> Wed, 3 Dec 2003 04:45:21 -0600
| Newsgroups | gmane.comp.java.jcontainer.cvs |
|---|---|
| Message-ID | <[email protected]> |
Update of /cvsroot/jcontainer/jcontainer/loom/plugins/maven-sar/xdocs
In directory hogshead.codehaus.org:/tmp/cvs-serv21491/plugins/maven-sar/xdocs
Modified Files:
goals.xml index.xml navigation.xml properties.xml tips.xml
Log Message:
Styled codebase
Index: goals.xml
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/plugins/maven-sar/xdocs/goals.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- goals.xml 7 Oct 2003 10:24:16 -0000 1.1
+++ goals.xml 3 Dec 2003 10:44:48 -0000 1.2
@@ -1,48 +1,48 @@
<?xml version="1.0" encoding="UTF-8"?>
<document>
- <properties>
- <title>Maven Sar Plug-in Goals</title>
- <author email="mauro.talevi at aquilonia.org">Mauro Talevi</author>
- </properties>
- <body>
- <goals>
- <goal>
- <name>sar</name>
- <description>Build a sar file</description>
- </goal>
- <goal>
- <name>sar:init</name>
- <description>Initialize the file system and define tasks</description>
- </goal>
- <goal>
- <name>sar:install</name>
- <description>Install the sar in the local repository</description>
- </goal>
- <goal>
- <name>sar:metagenerate</name>
- <description>Metagenerate xinfo files</description>
- </goal>
- <goal>
- <name>sar:sar</name>
- <description>Build a sar file</description>
- </goal>
- <goal>
- <name>sar:install</name>
- <description>Install the sar in the local repository</description>
- </goal>
- <goal>
- <name>sar:install-snapshot</name>
- <description>Install snapshot of the sar in the local repository</description>
- </goal>
- <goal>
- <name>sar:deploy</name>
- <description>Deploy the sar to the remote repository</description>
- </goal>
- <goal>
- <name>sar:deploy-snapshot</name>
- <description>Deploy snapshot of the sar to the remote repository</description>
- </goal>
- </goals>
- </body>
+ <properties>
+ <title>Maven Sar Plug-in Goals</title>
+ <author email="mauro.talevi at aquilonia.org">Mauro Talevi</author>
+ </properties>
+ <body>
+ <goals>
+ <goal>
+ <name>sar</name>
+ <description>Build a sar file</description>
+ </goal>
+ <goal>
+ <name>sar:init</name>
+ <description>Initialize the file system and define tasks</description>
+ </goal>
+ <goal>
+ <name>sar:install</name>
+ <description>Install the sar in the local repository</description>
+ </goal>
+ <goal>
+ <name>sar:metagenerate</name>
+ <description>Metagenerate xinfo files</description>
+ </goal>
+ <goal>
+ <name>sar:sar</name>
+ <description>Build a sar file</description>
+ </goal>
+ <goal>
+ <name>sar:install</name>
+ <description>Install the sar in the local repository</description>
+ </goal>
+ <goal>
+ <name>sar:install-snapshot</name>
+ <description>Install snapshot of the sar in the local repository</description>
+ </goal>
+ <goal>
+ <name>sar:deploy</name>
+ <description>Deploy the sar to the remote repository</description>
+ </goal>
+ <goal>
+ <name>sar:deploy-snapshot</name>
+ <description>Deploy snapshot of the sar to the remote repository</description>
+ </goal>
+ </goals>
+ </body>
</document>
Index: index.xml
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/plugins/maven-sar/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- index.xml 7 Oct 2003 10:24:16 -0000 1.1
+++ index.xml 3 Dec 2003 10:44:48 -0000 1.2
@@ -1,17 +1,17 @@
<?xml version="1.0"?>
<document>
- <properties>
- <title>Maven Sar Plugin</title>
- <author email="mauro.talevi at aquilonia.org">Mauro Talevi</author>
- </properties>
+ <properties>
+ <title>Maven Sar Plugin</title>
+ <author email="mauro.talevi at aquilonia.org">Mauro Talevi</author>
+ </properties>
- <body>
- <section name="Maven Sar Plugin">
- <p>
+ <body>
+ <section name="Maven Sar Plugin">
+ <p>
This plug-in provides the ability to generate either a deployed app
or an app packaged as a Sar file.
- </p>
- </section>
- </body>
+ </p>
+ </section>
+ </body>
</document>
Index: navigation.xml
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/plugins/maven-sar/xdocs/navigation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- navigation.xml 7 Oct 2003 10:24:16 -0000 1.1
+++ navigation.xml 3 Dec 2003 10:44:48 -0000 1.2
@@ -1,16 +1,16 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Maven Sar Plugin">
- <title>Maven Sar Plugin</title>
+ <title>Maven Sar Plugin</title>
- <body>
- <links>
- <item name="Maven" href="http://maven.apache.org/"/>
- </links>
- <menu name="Overview">
- <item name="Goals" href="/goals.html" />
- <item name="Properties" href="/properties.html" />
- <item name="Tips" href="/tips.html"/>
- </menu>
- </body>
+ <body>
+ <links>
+ <item name="Maven" href="http://maven.apache.org/"/>
+ </links>
+ <menu name="Overview">
+ <item name="Goals" href="/goals.html"/>
+ <item name="Properties" href="/properties.html"/>
+ <item name="Tips" href="/tips.html"/>
+ </menu>
+ </body>
</project>
Index: properties.xml
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/plugins/maven-sar/xdocs/properties.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- properties.xml 29 Nov 2003 07:25:14 -0000 1.4
+++ properties.xml 3 Dec 2003 10:44:48 -0000 1.5
@@ -1,85 +1,105 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
- <properties>
- <title>Sar Properties</title>
- <author email="mauro.talevi at aquilonia.org">Mauro Talevi</author>
- </properties>
+ <properties>
+ <title>Sar Properties</title>
+ <author email="mauro.talevi at aquilonia.org">Mauro Talevi</author>
+ </properties>
- <body>
- <section name="Sar Settings">
- <table>
- <tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
- <tr>
- <td>maven.sar.src</td>
- <td>Yes</td>
- <td>Location of sar source in source tree.
- Defaults to <code>${maven.src.dir}</code>.
- </td>
- </tr>
- <tr>
- <td>maven.sar.assembly</td>
- <td>Yes</td>
- <td>Location of the <code>assembly.xml</code> file.
- Defaults to <code>${maven.sar.src}/conf/assembly.xml</code>.
- </td>
- </tr>
- <tr>
- <td>maven.sar.config</td>
- <td>Yes</td>
- <td>Location of the <code>config.xml</code> file.
- Defaults to <code>${maven.sar.src}/conf/config.xml</code>.
- </td>
- </tr>
- <tr>
- <td>maven.sar.environment</td>
- <td>Yes</td>
- <td>Location of the <code>environment.xml</code> file.
- Defaults to <code>${maven.sar.src}/conf/environment.xml</code>.
- </td>
- </tr>
- <tr>
- <td>maven.sar.logging</td>
- <td>Yes</td>
- <td>Location of the logging configuration file which can be specified
- in alternative to the <code>logs</code> element in <code>environment.xml</code>
+ <body>
+ <section name="Sar Settings">
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Optional?</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>maven.sar.src</td>
+ <td>Yes</td>
+ <td>Location of sar source in source tree.
+ Defaults to
+ <code>${maven.src.dir}</code>.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.sar.assembly</td>
+ <td>Yes</td>
+ <td>Location of the
+ <code>assembly.xml</code> file.
+ Defaults to
+ <code>${maven.sar.src}/conf/assembly.xml</code>.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.sar.config</td>
+ <td>Yes</td>
+ <td>Location of the
+ <code>config.xml</code> file.
+ Defaults to
+ <code>${maven.sar.src}/conf/config.xml</code>.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.sar.environment</td>
+ <td>Yes</td>
+ <td>Location of the
+ <code>environment.xml</code> file.
+ Defaults to
+ <code>${maven.sar.src}/conf/environment.xml</code>.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.sar.logging</td>
+ <td>Yes</td>
+ <td>Location of the logging configuration file which can be specified
+ in alternative to the
+ <code>logs</code> element in
+ <code>environment.xml</code>
(which takes precedence over the logging configuration).
The recognised valid logging file names are:
- <code>log4j.properties</code>, <code>log4j.xml</code>,
- <code>logging.properties</code>, <code>excalibur-logger.xml</code>.
+ <code>log4j.properties</code>,
+ <code>log4j.xml</code>,
+ <code>logging.properties</code>,
+ <code>excalibur-logger.xml</code>.
Has no default.
- </td>
- </tr>
- <tr>
- <td>maven.sar.build.dir</td>
- <td>Yes</td>
- <td>Directory where the sar will be generated.
- Defaults to <code>${maven.build.dir}</code>.
- </td>
- </tr>
- <tr>
- <td>maven.sar.lib.include</td>
- <td>Yes</td>
- <td>Build artifacts to include in sar.
- Defaults to <code>${pom.artifactId}*.jar</code>. Files are relative to <code>${maven.sar.build.dir}</code>.
- </td>
- </tr>
- <tr>
- <td>maven.sar.lib.exclude</td>
- <td>Yes</td>
- <td>Build artifacts to exclude in sar.
- Defaults to none. Files are relative to <code>${maven.sar.build.dir}</code>.
- </td>
- </tr>
- </table>
- </section>
- <section name="Including jars in the sar">
- <p>
- To include a dependency in the sar you need to set the <code>sar.bundle</code> property to
- <code>true</code>:
- </p>
+ </td>
+ </tr>
+ <tr>
+ <td>maven.sar.build.dir</td>
+ <td>Yes</td>
+ <td>Directory where the sar will be generated.
+ Defaults to
+ <code>${maven.build.dir}</code>.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.sar.lib.include</td>
+ <td>Yes</td>
+ <td>Build artifacts to include in sar.
+ Defaults to
+ <code>${pom.artifactId}*.jar</code>. Files are relative to
+ <code>${maven.sar.build.dir}</code>.
+ </td>
+ </tr>
+ <tr>
+ <td>maven.sar.lib.exclude</td>
+ <td>Yes</td>
+ <td>Build artifacts to exclude in sar.
+ Defaults to none. Files are relative to
+ <code>${maven.sar.build.dir}</code>.
+ </td>
+ </tr>
+ </table>
+ </section>
+ <section name="Including jars in the sar">
+ <p>
+ To include a dependency in the sar you need to set the
+ <code>sar.bundle</code> property to
+ <code>true</code>:
+ </p>
-<source><![CDATA[
+ <source><![CDATA[
<dependency>
<id>jarid</id>
<version>jarversion</version>
@@ -87,16 +107,18 @@
<sar.bundle>true</sar.bundle>
</properties>
</dependency>
-]]></source>
+ ]]></source>
- </section>
- <section name="Including resources in the app">
- <p>
- To include a resource in the app you need to set the corresponding <code>targetPath</code>
- to <code>SAR-INF</code>:
- </p>
+ </section>
+ <section name="Including resources in the app">
+ <p>
+ To include a resource in the app you need to set the corresponding
+ <code>targetPath</code>
+ to
+ <code>SAR-INF</code>:
+ </p>
-<source><![CDATA[
+ <source><![CDATA[
<build>
<resources>
<resource>
@@ -111,8 +133,8 @@
</resource>
</resources>
</build>
-]]></source>
+ ]]></source>
- </section>
- </body>
+ </section>
+ </body>
</document>
Index: tips.xml
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/plugins/maven-sar/xdocs/tips.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- tips.xml 7 Oct 2003 10:24:16 -0000 1.1
+++ tips.xml 3 Dec 2003 10:44:48 -0000 1.2
@@ -1,23 +1,24 @@
<?xml version="1.0"?>
<document>
- <properties>
- <title>Maven Sar Plugin Tips</title>
- <author email="mauro.talevi at aquilonia.org">Mauro Talevi</author>
- </properties>
+ <properties>
+ <title>Maven Sar Plugin Tips</title>
+ <author email="mauro.talevi at aquilonia.org">Mauro Talevi</author>
+ </properties>
- <body>
- <section name="Maven Sar Plugin Tips">
- <section name="Filtering xml files">
- <p>
+ <body>
+ <section name="Maven Sar Plugin Tips">
+ <section name="Filtering xml files">
+ <p>
If you need to copy the [assembly|config|environment].xml files in order to replace some
filter tokens or simply perform some custom modification to it,
- simply write a pre-goal to the <code>sar:sar</code> goal in which
+ simply write a pre-goal to the
+ <code>sar:sar</code> goal in which
you perform the manipulation. Then set the
- <code>maven.sar.[assembly|config|environment]</code> property to point to your modified
- <code>[assembly|config|environment].xml</code>.
- </p>
- </section>
- </section>
- </body>
+ <code>maven.sar.[assembly|config|environment]</code> property to point to your modified
+ <code>[assembly|config|environment].xml</code>.
+ </p>
+ </section>
+ </section>
+ </body>
</document>