Menu
▾
▴
[Maven-plugins-cvs] cvs commit: maven-plugins/uberdist project.xml
|
From: Eric G. <ri...@us...> - 2005-03-03 03:36:34
|
rikgig 05/03/02 19:36:25
Modified: uberdist/xdocs faq.fml index.xml properties.xml tags.xml
uberdist project.xml
Log:
Corrected lots of documentation issues.
Revision Changes Path
1.2 +5 -5 maven-plugins/uberdist/xdocs/faq.fml
Index: faq.fml
===================================================================
RCS file: /cvsroot/maven-plugins/maven-plugins/uberdist/xdocs/faq.fml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- faq.fml 2 Mar 2005 17:46:46 -0000 1.1
+++ faq.fml 3 Mar 2005 03:36:25 -0000 1.2
@@ -14,11 +14,11 @@
<source>
<![CDATA[
<postGoal name="uber-dist:init">
- <udist:registerProject name="${pom.id}" description="My distribution"/>
- <maven:get plugin="maven-uberdist-plugin"
- property="maven.uber.dist.assembly.dir" var="dist.assembly.dir" />
- <maven:get plugin="maven-uberdist-plugin"
- property="maven.uber.dist.dir" var="distribution_dir" />
+ <udist:registerProject name="${pom.artifactId}" description="My distribution"/>
+ <maven:get plugin="maven-uberdist-plugin"
+ property="maven.uber.dist.assembly.dir" var="dist.assembly.dir" />
+ <maven:get plugin="maven-uberdist-plugin"
+ property="maven.uber.dist.dir" var="distribution_dir" />
</postGoal>]]>
</source><br/>
Using the ${pom.id} is a very good practice. This is the value that will be used as default when the tag will be available.
1.2 +8 -9 maven-plugins/uberdist/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /cvsroot/maven-plugins/maven-plugins/uberdist/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 2 Mar 2005 17:46:46 -0000 1.1
+++ index.xml 3 Mar 2005 03:36:25 -0000 1.2
@@ -15,14 +15,14 @@
Some software systems are made of many artifacts and may require an aggregation of many <br/>
"external" components or third parties to have a complete distribution.<br/>
In a production environment, deployment rules may be very strict and software teams may have<br/>
- to follow script prescribe procedures on how and where their system should be installed, especially<br/>
- on Unix environments where proper file rights attribution are crutial.<br/>
- This work environment being very specific in nature, the one fits all rule doesn't apply here and building<br/>
- the distribution becomes an complex task in itself.<br/>
+ to follow prescribe procedures on how and where their system should be installed, especially<br/>
+ on Unix environments where proper file rights attribution are crucial.<br/>
+ The one fits all rule doesn't apply here and building the distribution becomes an complex task in itself.<br/>
</p>
<p>
The goal of the UberDist plugin is to integrate the basic mechanism of having a custom goal called to<br/>
- build this specific complex distribution. But, it also automates some recurring tasks and most of all leverages<br/>
+ build this project specific complex distribution. In other words, use the full power of maven to build your distribution<br/>
+ using a project specific goal you write. But, it also automates some recurring tasks and most of all leverages<br/>
the enormous amout of available facilities provided by the Maven build environment to give better control<br/>
on the deployment file structure.
</p>
@@ -65,14 +65,13 @@
</p>
<p>
When one of the distribution building goal is called (either one of <a href="./goals.html#uber-dist:make">uber-dist:make</a>, <a href="./goals.html#uber-dist:build">build</a> or <a href="./goals.html#uber-dist:prepare-dist-filesystem">prepare-dist-filesystem</a>),
- the plugin will call its internal init goal ( uber-dist:init ). Util a custom tag is supplied, writing a postGaol to this one is the prefered way to register
- a distribution to be built with the plugin. Its very similar to the xdoc plugin in behavior. It allows building many seperate distribution from a same project.
+ the plugin will call its internal init goal ( uber-dist:init ), this is when you register your project with a postGoal. See <a href="./tags.html#uber-dist:registerProject">uber-dist:registerProject tag</a><br/>
+ See also FAQ: <a href="./faq.html#register-project">register-project</a>
</p>
<p>
Once your project is registered, UberDist prepares the necessary directories, based on its property values.<br/>
Now comes the time to copy all necessary files in the distribution assembly. UberDist will first call YOUR
- distribution goal. To do this, it uses the name your registered with (typically ${pom.artifactId} makes a perfect name)
- appended with ':prepare-dist-filesystem'.<br/>
+ distribution goal.<br/>
Ex.: For a a maven project with id: <strong>myproject</strong>, the goal <strong>myproject:prepare-dist-filesystem</strong> will be called.
</p>
<p>
1.2 +14 -17 maven-plugins/uberdist/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /cvsroot/maven-plugins/maven-plugins/uberdist/xdocs/properties.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- properties.xml 2 Mar 2005 17:46:46 -0000 1.1
+++ properties.xml 3 Mar 2005 03:36:25 -0000 1.2
@@ -17,8 +17,8 @@
<tr>
<td>maven.uber.dist.assembly.root</td>
<td>
- The directory under the project's target dir under which the files that builds
- up the distribution should be copied to. It is also called the distribution assembly dir.<br/>
+ The directory where the distribution is built (under the project's target).<br/>
+ It is also called the distribution assembly dir.<br/>
<i>maven.uber.dist.assembly.root=${maven.build.dir}/dist-assembly</i>
<br/>
</td>
@@ -27,10 +27,9 @@
<tr>
<td>maven.uber.dist.dir</td>
<td>
- The directory under the project's target dir
- where the plugin puts the final distribution: tarball or zip
- files based on the OS under which it is created.
- <br/>
+ The directory under the project's target dir <br/>
+ where the plugin puts the final distribution: tarball or zip<br/>
+ files based on the OS under which it is created.<br/>
<i>maven.uber.dist.dir=${maven.build.dir}/distributions</i>
<br/>
</td>
@@ -39,13 +38,10 @@
<tr>
<td>maven.uber.dist.proj.subdir</td>
<td>
- Specifies the sub-directory under the distribution assembly
- dir where the files for this project should be kept.
- This is necessary only if you are in a multiproject
- environment with seperate distributions.
- <br/>
- See the <a href="protocols.html">the list</a> of supported protocols.
- <br/>
+ Specifies the sub-directory under the distribution assembly<br/>
+ dir where the files for this project should be kept.<br/>
+ This is necessary only if you are in a multiproject<br/>
+ environment with seperate distributions.<br/>
</td>
<td>No</td>
</tr>
@@ -53,10 +49,11 @@
<tr>
<td><a name="maven.uber.dist.assembly.dir">maven.uber.dist.assembly.dir</a></td>
<td>
- This property holds the directory where the distribution assembly is.
- By default, it is made of the concatenation of root dir followed
- by project sub-dir if any.
- <i>maven.uber.dist.assembly.dir=${maven.uber.dist.assembly.root}/${maven.uber.dist.proj.subdir}</i>
+ This property holds the directory where the distribution assembly is.<br/>
+ By default, it is made of the concatenation of root dir followed <br/>
+ by project sub-dir if any.<br/>
+ <i>maven.uber.dist.assembly.dir=${maven.uber.dist.assembly.root}/<br/>
+ ${maven.uber.dist.proj.subdir}</i>
</td>
<td>No</td>
</tr>
1.2 +6 -8 maven-plugins/uberdist/xdocs/tags.xml
Index: tags.xml
===================================================================
RCS file: /cvsroot/maven-plugins/maven-plugins/uberdist/xdocs/tags.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- tags.xml 2 Mar 2005 17:46:46 -0000 1.1
+++ tags.xml 3 Mar 2005 03:36:25 -0000 1.2
@@ -24,7 +24,7 @@
<td>Copies launch scripts to a specified directory</td>
</tr>
<tr>
- <td><a href="#uber-dist:registerProject">artifact:deploy-snapshot</a></td>
+ <td><a href="#uber-dist:registerProject">uber-dist:registerProject</a></td>
<td>Add a project to the distribution list to be built.</td>
</tr>
<tr>
@@ -35,13 +35,11 @@
<subsection name="uber-dist:copyScripts">
<p>
- Copies launch scripts to a specified directory.
- <br/>
+ Copies launch scripts to a specified directory.<br/>
The files located in directory with matching pattern as described by
- property <a href="./properties.html#maven.uber.dist.launch.scripts">
- maven.uber.dist.launch.scripts</a> are copied<br/>
- using Ant filtering mechanism with default @artifact_id@ token replaced<br/>
- by the current's project artifact id.<br/>
+ property <a href="./properties.html#maven.uber.dist.launch.scripts">maven.uber.dist.launch.scripts</a>
+ are copied using Ant filtering mechanism with default @artifact_id@
+ token replaced by the current's project artifact id.<br/>
The default value for the file pattern is: <code>*.sh,*.cmd,*.bat</code>
</p>
<table>
@@ -70,7 +68,7 @@
</tr>
<tr>
<td>name</td>
- <td>The name of the distribution to build</td>
+ <td>The name of the distribution to build. </td>
<td>No</td>
</tr>
</table>
1.2 +5 -28 maven-plugins/uberdist/project.xml
Index: project.xml
===================================================================
RCS file: /cvsroot/maven-plugins/maven-plugins/uberdist/project.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- project.xml 2 Mar 2005 17:45:38 -0000 1.1
+++ project.xml 3 Mar 2005 03:36:25 -0000 1.2
@@ -37,21 +37,21 @@
<shortDescription>Distribution plugin for multiple projects</shortDescription>
<siteDirectory>
- /home/groups/m/ma/maven-plugins/htdocs/maven-transform-plugin/
+ /home/groups/m/ma/maven-plugins/htdocs/maven-uberdist-plugin/
</siteDirectory>
<distributionDirectory>
- /home/groups/m/ma/maven-plugins/htdocs/maven-transform-plugin/distributions/
+ /home/groups/m/ma/maven-plugins/htdocs/maven-uberdist-plugin/distributions/
</distributionDirectory>
<repository>
<connection>
- scm:cvs:pserver:ano...@cv...:/cvsroot/maven-plugins:maven-plugins/transform
+ scm:cvs:pserver:ano...@cv...:/cvsroot/maven-plugins:maven-plugins/uberdist
</connection>
<developerConnection>
- scm:cvs:ext:${maven.username}@cvs.sourceforge.net:/cvsroot/maven-plugins:maven-plugins/transform
+ scm:cvs:ext:${maven.username}@cvs.sourceforge.net:/cvsroot/maven-plugins:maven-plugins/uberdist
</developerConnection>
<url>
- http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/maven-plugins/maven-plugins/transform/
+ http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/maven-plugins/maven-plugins/uberdist/
</url>
</repository>
@@ -75,29 +75,6 @@
</versions>
<!-- build is in the parent -->
-<!--
- <build>
- <sourceDirectory>src/java</sourceDirectory>
- <unitTestSourceDirectory>test/java</unitTestSourceDirectory>
-
-
- <resources>
- <resource>
- <directory>${basedir}/src/plugin-resources</directory>
- <targetPath>plugin-resources</targetPath>
- </resource>
- <resource>
- <directory>${basedir}</directory>
- <includes>
- <include>plugin.jelly</include>
- <include>plugin.properties</include>
- <include>project.properties</include>
- <include>project.xml</include>
- </includes>
- </resource>
- </resources>
- </build>
--->
<reports>
<report>maven-changes-plugin</report>
<report>maven-linkcheck-plugin</report>
|
