Author: aheritier
Date: Thu Nov 22 14:48:29 2012
New Revision: 1412569
URL: http://svn.apache.org/viewvc?rev=1412569&view=rev
Log:
Add more docs about properties that may be used in outputFileNameMapping
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/component.mdo
maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo
maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/component.mdo
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/component.mdo?rev=1412569&r1=1412568&r2=1412569&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/component.mdo
(original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/component.mdo Thu
Nov 22 14:48:29 2012
@@ -484,7 +484,8 @@
<description>
Sets the mapping pattern for all dependencies included in this
assembly. Default is
${artifact.artifactId}-${artifact.version}${dashClassifier?}.${artifact.extension}.
- (Since 2.2-beta-2; 2.2-beta-1 uses
${artifactId}-${version}${dashClassifier?}.${extension})
+ (Since 2.2-beta-2; 2.2-beta-1 uses
${artifactId}-${version}${dashClassifier?}.${extension}).
+ See the plugin FAQ for more details about entries usable in the
outputFileNameMapping parameter.
</description>
</field>
<field>
@@ -990,6 +991,7 @@
Default is
${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}.
(Since 2.2-beta-2; 2.2-beta-1 uses
${artifactId}-${version}${dashClassifier?}.${extension}) NOTE: If the
dependencySet specifies unpack == true, outputFileNameMapping WILL
NOT BE USED; in these cases, use outputDirectory.
+ See the plugin FAQ for more details about entries usable in the
outputFileNameMapping parameter.
</description>
</field>
</fields>
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo?rev=1412569&r1=1412568&r2=1412569&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo
(original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/mdo/descriptor.mdo Thu
Nov 22 14:48:29 2012
@@ -603,7 +603,8 @@
<description>
Sets the mapping pattern for all dependencies included in this
assembly. (Since 2.2-beta-2; 2.2-beta-1 uses
${artifactId}-${version}${dashClassifier?}.${extension}
- as default value)
+ as default value).
+ See the plugin FAQ for more details about entries usable in the
outputFileNameMapping parameter.
</description>
</field>
<field>
@@ -1103,6 +1104,7 @@
(Since 2.2-beta-2; 2.2-beta-1 uses
${artifactId}-${version}${dashClassifier?}.${extension} as default value)
NOTE: If the dependencySet specifies unpack == true,
outputFileNameMapping WILL NOT BE USED; in these cases,
use outputDirectory.
+ See the plugin FAQ for more details about entries usable in the
outputFileNameMapping parameter.
</description>
</field>
</fields>
Modified: maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml?rev=1412569&r1=1412568&r2=1412569&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/site/fml/faq.fml Thu Nov 22
14:48:29 2012
@@ -181,5 +181,32 @@ under the License.
</pre>
</answer>
</faq>
+ <faq id="outputFileNameMapping">
+ <question>
+ Which properties can be used in the outputFileNameMapping parameter.
+ </question>
+ <answer>
+ <p>
+ You can use :
+ </p>
+ <ul>
+ <li>all system or maven properties available in your build with the
syntax <code>${myProperty}</code>.</li>
+ <li>all environment variables with <code>${env.XXX}</code> where
<code>XXX</code> is the environment variable.</li>
+ <li>the special <code>${dashClassifier?}</code> property (see
above).</li>
+ <li>all artifacts attributes (<a
href="http://maven.apache.org/ref/3.0.4/maven-artifact/apidocs/org/apache/maven/artifact/Artifact.html";>
from the Artifact class</a>) like :
+ <ul>
+ <li><code>${artifact.groupId}</code> : The artifact groupId.</li>
+ <li><code>${artifact.artifactId}</code> : The artifact
artifactId.</li>
+ <li><code>${artifact.version}</code> : The artifact
classifier.</li>
+ <li><code>${artifact.baseVersion}</code> : The artifact base
version (For a SNAPSHOT it will be always -SNAPSHOT and not its timestamp even
if you didn't built it yourself).</li>
+ <li><code>${artifact.classifier}</code> : The artifact
classifier.</li>
+ <li><code>${artifact.scope}</code> : The artifact scope.</li>
+ <li>...</li>
+ </ul>
+ You can use <code>${module.XXXXX}</code> when using it for your
project modules artifacts.
+ </li>
+ </ul>
+ </answer>
+ </faq>
</part>
</faqs>
