| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | |
| <!-- Generated by Apache Maven Doxia at Oct 15, 2012 --> | |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> | |
| <head> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> | |
| <title> | |
| tycho-packaging:package-plugin</title> | |
| <style type="text/css" media="all"> | |
| @import url("./css/maven-base.css"); | |
| @import url("./css/maven-theme.css"); | |
| @import url("./css/site.css"); | |
| </style> | |
| <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> | |
| <meta name="Date-Revision-yyyymmdd" content="20121015" /> | |
| <meta http-equiv="Content-Language" content="en" /> | |
| </head> | |
| <body class="composite"> | |
| <div id="banner"> | |
| <div id="bannerLeft"> | |
| Tycho OSGi Packaging Plugin (Incubation) | |
| </div> | |
| <div class="clear"> | |
| <hr/> | |
| </div> | |
| </div> | |
| <div id="breadcrumbs"> | |
| <div class="xleft"> | |
| <span id="publishDate">Last Published: 2012-10-15</span> | |
| | <span id="projectVersion">Version: 0.16.0</span> | |
| </div> | |
| <div class="xright"> <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> | |
| </div> | |
| <div class="clear"> | |
| <hr/> | |
| </div> | |
| </div> | |
| <div id="leftColumn"> | |
| <div id="navcolumn"> | |
| <h5>Tycho</h5> | |
| <ul> | |
| <li class="none"> | |
| <a href="../index.html" title="Introduction">Introduction</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../tycho-compiler-plugin/plugin-info.html" title="Compiler Plugin">Compiler Plugin</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../tycho-packaging-plugin/plugin-info.html" title="Packaging Plugin">Packaging Plugin</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../tycho-source-plugin/plugin-info.html" title="Source Plugin">Source Plugin</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../tycho-surefire/tycho-surefire-plugin/plugin-info.html" title="Surefire Plugin">Surefire Plugin</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../tycho-release/tycho-versions-plugin/plugin-info.html" title="Versions Plugin">Versions Plugin</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../tycho-p2/tycho-p2-director-plugin/plugin-info.html" title="P2 Director Plugin">P2 Director Plugin</a> | |
| </li> | |
| <li class="none"> | |
| <a href="../tycho-p2/tycho-p2-repository-plugin/plugin-info.html" title="P2 Repository Plugin">P2 Repository Plugin</a> | |
| </li> | |
| </ul> | |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> | |
| <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> | |
| </a> | |
| </div> | |
| </div> | |
| <div id="bodyColumn"> | |
| <div id="contentBox"> | |
| <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.16.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="bodyTable" 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="bodyTable" 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="#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="a"> | |
| <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="b"> | |
| <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="a"> | |
| <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="b"> | |
| <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="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 class="clear"> | |
| <hr/> | |
| </div> | |
| <div id="footer"> | |
| <div class="xright"> | |
| Copyright © 2008-2012 | |
| <a href="http://www.eclipse.org/">Eclipse Foundation</a>. | |
| All Rights Reserved. | |
| </div> | |
| <div class="clear"> | |
| <hr/> | |
| </div> | |
| </div> | |
| </body> | |
| </html> |