| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia at May 29, 2013 |
| | Rendered using Apache Maven Fluido Skin 1.3.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20130529" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title> |
| tycho-packaging:package-plugin</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| |
| |
| <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script> |
| |
| |
| </head> |
| <body class="topBarDisabled"> |
| |
| |
| |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <div id="bannerLeft"> |
| <h2>Tycho OSGi Packaging Plugin (Incubation)</h2> |
| </div> |
| </div> |
| <div class="pull-right"> </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| |
| |
| <li id="publishDate">Last Published: 2013-05-29</li> |
| <li class="divider">|</li> <li id="projectVersion">Version: 0.18.0</li> |
| |
| |
| |
| |
| |
| <li class="pull-right"> <a href="http://wiki.eclipse.org/Development_Resources/HOWTO/Incubation_Phase#.281.29_What_Is_Incubation.3F" class="externalLink" title="This content is PRELIMINARY API and still subject to change"> |
| This content is PRELIMINARY API and still subject to change</a> |
| </li> |
| |
| </ul> |
| </div> |
| |
| |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span3"> |
| <div class="well sidebar-nav"> |
| |
| |
| <ul class="nav nav-list"> |
| <li class="nav-header">Tycho</li> |
| |
| <li> |
| |
| <a href="../index.html" title="Introduction"> |
| <i class="none"></i> |
| Introduction</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-compiler-plugin/plugin-info.html" title="Compiler Plugin"> |
| <i class="none"></i> |
| Compiler Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-packaging-plugin/plugin-info.html" title="Packaging Plugin"> |
| <i class="none"></i> |
| Packaging Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-surefire/tycho-surefire-plugin/plugin-info.html" title="Surefire Plugin"> |
| <i class="none"></i> |
| Surefire Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-p2/tycho-p2-publisher-plugin/plugin-info.html" title="p2 Publisher Plugin"> |
| <i class="none"></i> |
| p2 Publisher Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-p2/tycho-p2-repository-plugin/plugin-info.html" title="p2 Repository Plugin"> |
| <i class="none"></i> |
| p2 Repository Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-p2/tycho-p2-director-plugin/plugin-info.html" title="p2 Director Plugin"> |
| <i class="none"></i> |
| p2 Director Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-source-plugin/plugin-info.html" title="Source Plugin"> |
| <i class="none"></i> |
| Source Plugin</a> |
| </li> |
| |
| <li> |
| |
| <a href="../tycho-release/tycho-versions-plugin/plugin-info.html" title="Versions Plugin"> |
| <i class="none"></i> |
| Versions Plugin</a> |
| </li> |
| </ul> |
| |
| |
| |
| <hr class="divider" /> |
| |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> |
| </a> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div id="bodyColumn" class="span9" > |
| |
|
|
|
|
| <div class="section"><h2>tycho-packaging:package-plugin<a name="tycho-packaging:package-plugin"></a></h2>
|
| <p><b>Full name</b>:</p>
|
| <p>org.eclipse.tycho:tycho-packaging-plugin:0.18.0:package-plugin</p>
|
| <p><b>Description</b>:</p>
|
| <div>Creates a jar-based plugin and attaches it as an artifact</div>
|
| <p><b>Attributes</b>:</p>
|
| <ul>
|
| <li>Requires a Maven project to be executed.</li>
|
| </ul>
|
| <div class="section"><h3>Required Parameters<a name="Required_Parameters"></a></h3>
|
| <table class="table table-striped" border="0">
|
| <tr class="a">
|
| <th>Name</th>
|
| <th>Type</th>
|
| <th>Since</th>
|
| <th>Description</th>
|
| </tr>
|
| <tr class="b">
|
| <td><b><a href="#buildDirectory">buildDirectory</a></b></td>
|
| <td><tt>File</tt></td>
|
| <td><tt>-</tt></td>
|
| <td>(no description)<br /></td>
|
| </tr>
|
| <tr class="a">
|
| <td><b><a href="#finalName">finalName</a></b></td>
|
| <td><tt>String</tt></td>
|
| <td><tt>-</tt></td>
|
| <td>Name of the generated JAR.<br /></td>
|
| </tr>
|
| </table>
|
| </div>
|
| <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
|
| <table class="table table-striped" border="0">
|
| <tr class="a">
|
| <th>Name</th>
|
| <th>Type</th>
|
| <th>Since</th>
|
| <th>Description</th>
|
| </tr>
|
| <tr class="b">
|
| <td><b><a href="#additionalFileSets">additionalFileSets</a></b></td>
|
| <td><tt>DefaultFileSet[]</tt></td>
|
| <td><tt>-</tt></td>
|
| <td>Additional files to be included in the bundle jar. This can be used
|
| when <tt>bin.includes</tt> in build.properties is not flexible
|
| enough , e.g. for generated files.<br />
|
| Example:<br />
|
|
|
| <div><pre>
|
| <additionalFileSets>
|
| <fileSet>
|
| <directory>${project.build.directory}/mytool-gen/</directory>
|
| <includes>
|
| <include>**/*</include>
|
| </includes>
|
| </fileSet>
|
| </additionalFileSets>
|
| </pre></div><br /></td>
|
| </tr>
|
| <tr class="a">
|
| <td><b><a href="#archive">archive</a></b></td>
|
| <td><tt>MavenArchiveConfiguration</tt></td>
|
| <td><tt>-</tt></td>
|
| <td>The maven archiver to use.<br /></td>
|
| </tr>
|
| <tr class="b">
|
| <td><b><a href="#qualifier">qualifier</a></b></td>
|
| <td><tt>String</tt></td>
|
| <td><tt>-</tt></td>
|
| <td>Build qualifier. Recommended way to set this parameter is using
|
| build-qualifier goal.<br /></td>
|
| </tr>
|
| <tr class="a">
|
| <td><b><a href="#sourceReferences">sourceReferences</a></b></td>
|
| <td><tt>SourceReferences</tt></td>
|
| <td><tt>-</tt></td>
|
| <td>Whether to generate an <a class="externalLink" href="http://wiki.eclipse.org/PDE/UI/SourceReferences">Eclipse-SourceReferences</a>
|
| MANIFEST header. When using this parameter, property
|
| ${tycho.scmUrl} must be set and be a valid <a class="externalLink" href="http://maven.apache.org/scm/scm-url-format.html">maven SCM
|
| URL</a>. Example configuration:
|
| <div><pre>
|
| <sourceReferences>
|
| <generate>true</generate>
|
| </sourceReferences>
|
| </pre></div>
|
|
|
| Note that a <tt>SourceReferencesProvider</tt> component must be
|
| registered for the SCM type being used. You may also override the
|
| generated value by configuring:
|
| <div><pre>
|
| <sourceReferences>
|
| <generate>true</generate>
|
| <customValue>scm:myscm:customSourceReferenceValue</customValue>
|
| </sourceReferences>
|
| </pre></div><br /></td>
|
| </tr>
|
| <tr class="b">
|
| <td><b><a href="#strictBinIncludes">strictBinIncludes</a></b></td>
|
| <td><tt>boolean</tt></td>
|
| <td><tt>-</tt></td>
|
| <td>If set to <tt>true</tt> (the default), missing build.properties
|
| bin.includes will cause build failure. If set to
|
| <tt>false</tt>, missing build.properties bin.includes will be
|
| reported as warnings but the build will not fail.<br /><b>Default value is</b>: <tt>true</tt>.</td>
|
| </tr>
|
| <tr class="a">
|
| <td><b><a href="#useDefaultExcludes">useDefaultExcludes</a></b></td>
|
| <td><tt>boolean</tt></td>
|
| <td><tt>-</tt></td>
|
| <td>(no description)<br /><b>Default value is</b>: <tt>true</tt>.</td>
|
| </tr>
|
| </table>
|
| </div>
|
| <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
|
| <p><b><a name="additionalFileSets">additionalFileSets</a>:</b></p>
|
| <div>Additional files to be included in the bundle jar. This can be used
|
| when <tt>bin.includes</tt> in build.properties is not flexible
|
| enough , e.g. for generated files.<br />
|
| Example:<br />
|
|
|
| <div><pre>
|
| <additionalFileSets>
|
| <fileSet>
|
| <directory>${project.build.directory}/mytool-gen/</directory>
|
| <includes>
|
| <include>**/*</include>
|
| </includes>
|
| </fileSet>
|
| </additionalFileSets>
|
| </pre></div></div>
|
| <ul>
|
| <li><b>Type</b>: <tt>org.codehaus.plexus.archiver.util.DefaultFileSet[]</tt></li>
|
| <li><b>Required</b>: <tt>No</tt></li>
|
| </ul><hr /><p><b><a name="archive">archive</a>:</b></p>
|
| <div>The maven archiver to use.</div>
|
| <ul>
|
| <li><b>Type</b>: <tt>org.apache.maven.archiver.MavenArchiveConfiguration</tt></li>
|
| <li><b>Required</b>: <tt>No</tt></li>
|
| </ul><hr /><p><b><a name="buildDirectory">buildDirectory</a>:</b></p>
|
| <div>(no description)</div>
|
| <ul>
|
| <li><b>Type</b>: <tt>java.io.File</tt></li>
|
| <li><b>Required</b>: <tt>Yes</tt></li>
|
| <li><b>Expression</b>: <tt>${project.build.directory}</tt></li>
|
| </ul><hr /><p><b><a name="finalName">finalName</a>:</b></p>
|
| <div>Name of the generated JAR.</div>
|
| <ul>
|
| <li><b>Type</b>: <tt>java.lang.String</tt></li>
|
| <li><b>Required</b>: <tt>Yes</tt></li>
|
| <li><b>Expression</b>: <tt>${project.build.finalName}</tt></li>
|
| </ul><hr /><p><b><a name="qualifier">qualifier</a>:</b></p>
|
| <div>Build qualifier. Recommended way to set this parameter is using
|
| build-qualifier goal.</div>
|
| <ul>
|
| <li><b>Type</b>: <tt>java.lang.String</tt></li>
|
| <li><b>Required</b>: <tt>No</tt></li>
|
| <li><b>Expression</b>: <tt>${buildQualifier}</tt></li>
|
| </ul><hr /><p><b><a name="sourceReferences">sourceReferences</a>:</b></p>
|
| <div>Whether to generate an <a class="externalLink" href="http://wiki.eclipse.org/PDE/UI/SourceReferences">Eclipse-SourceReferences</a>
|
| MANIFEST header. When using this parameter, property
|
| ${tycho.scmUrl} must be set and be a valid <a class="externalLink" href="http://maven.apache.org/scm/scm-url-format.html">maven SCM
|
| URL</a>. Example configuration:
|
| <div><pre>
|
| <sourceReferences>
|
| <generate>true</generate>
|
| </sourceReferences>
|
| </pre></div>
|
|
|
| Note that a <tt>SourceReferencesProvider</tt> component must be
|
| registered for the SCM type being used. You may also override the
|
| generated value by configuring:
|
| <div><pre>
|
| <sourceReferences>
|
| <generate>true</generate>
|
| <customValue>scm:myscm:customSourceReferenceValue</customValue>
|
| </sourceReferences>
|
| </pre></div></div>
|
| <ul>
|
| <li><b>Type</b>: <tt>org.eclipse.tycho.packaging.SourceReferences</tt></li>
|
| <li><b>Required</b>: <tt>No</tt></li>
|
| </ul><hr /><p><b><a name="strictBinIncludes">strictBinIncludes</a>:</b></p>
|
| <div>If set to <tt>true</tt> (the default), missing build.properties
|
| bin.includes will cause build failure. If set to
|
| <tt>false</tt>, missing build.properties bin.includes will be
|
| reported as warnings but the build will not fail.</div>
|
| <ul>
|
| <li><b>Type</b>: <tt>boolean</tt></li>
|
| <li><b>Required</b>: <tt>No</tt></li>
|
| <li><b>Default</b>: <tt>true</tt></li>
|
| </ul><hr /><p><b><a name="useDefaultExcludes">useDefaultExcludes</a>:</b></p>
|
| <div>(no description)</div>
|
| <ul>
|
| <li><b>Type</b>: <tt>boolean</tt></li>
|
| <li><b>Required</b>: <tt>No</tt></li>
|
| <li><b>Default</b>: <tt>true</tt></li>
|
| </ul>
|
| </div>
|
| </div>
|
|
|
| |
| </div> |
| </div> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container-fluid"> |
| <div class="row span12">Copyright © 2008-2013 |
| <a href="http://www.eclipse.org/">Eclipse Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| |
| |
| |
| </div> |
| </footer> |
| </body> |
| </html> |