| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.9.1 from target/generated-site/xdoc/source-feature-mojo.xml at 2020-01-13 |
| | Rendered using Apache Maven Fluido Skin 1.7 |
| --> |
| <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="20200113" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Tycho Source Feature Generation Plugin – tycho-source-feature:source-feature</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.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.7.min.js"></script> |
| </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h2>Tycho Source Feature Generation Plugin</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: 2020-01-13<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 1.6.0</li> |
| </ul> |
| </div> |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span2"> |
| <div class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Tycho</li> |
| <li><a href="../../index.html" title="Introduction"><span class="none"></span>Introduction</a></li> |
| <li><a href="../../tycho-compiler-plugin/plugin-info.html" title="Compiler Plugin"><span class="none"></span>Compiler Plugin</a></li> |
| <li><a href="../../tycho-packaging-plugin/plugin-info.html" title="Packaging Plugin"><span class="none"></span>Packaging Plugin</a></li> |
| <li><a href="../../BuildProperties.html" title="Build Properties"><span class="none"></span>Build Properties</a></li> |
| <li><a href="../../tycho-surefire-plugin/plugin-info.html" title="Surefire Plugin"><span class="none"></span>Surefire Plugin</a></li> |
| <li><a href="../../tycho-p2/tycho-p2-publisher-plugin/plugin-info.html" title="p2 Publisher Plugin"><span class="none"></span>p2 Publisher Plugin</a></li> |
| <li><a href="../../tycho-p2/tycho-p2-repository-plugin/plugin-info.html" title="p2 Repository Plugin"><span class="none"></span>p2 Repository Plugin</a></li> |
| <li><a href="../../tycho-p2/tycho-p2-director-plugin/plugin-info.html" title="p2 Director Plugin"><span class="none"></span>p2 Director Plugin</a></li> |
| <li><a href="../../tycho-source-plugin/plugin-info.html" title="Source Plugin"><span class="none"></span>Source Plugin</a></li> |
| <li><a href="../../tycho-release/tycho-versions-plugin/plugin-info.html" title="Versions Plugin"><span class="none"></span>Versions Plugin</a></li> |
| <li><a href="../../tycho-pomgenerator-plugin/plugin-info.html" title="POM Generator Plugin"><span class="none"></span>POM Generator Plugin</a></li> |
| <li><a href="../../TychoProperties.html" title="Tycho Properties"><span class="none"></span>Tycho Properties</a></li> |
| <li class="nav-header">Tycho Extras</li> |
| <li><a href="../index.html" title="Introduction"><span class="none"></span>Introduction</a></li> |
| <li><a href="../tycho-p2-extras-plugin/plugin-info.html" title="P2 Extras Plugin"><span class="none"></span>P2 Extras Plugin</a></li> |
| <li><a href="../target-platform-validation-plugin/plugin-info.html" title="Target Platform Validation Plugin"><span class="none"></span>Target Platform Validation Plugin</a></li> |
| <li><a href="../tycho-eclipserun-plugin/plugin-info.html" title="Eclipserun Plugin"><span class="none"></span>Eclipserun Plugin</a></li> |
| <li><a href="../tycho-document-bundle-plugin/plugin-info.html" title="Document Bundle Plugin"><span class="none"></span>Document Bundle Plugin</a></li> |
| <li><a href="../tycho-source-feature-plugin/plugin-info.html" title="Source Feature Generation Plugin"><span class="none"></span>Source Feature Generation Plugin</a></li> |
| <li><a href="../tycho-pack200/index.html" title="Pack200 Plugins"><span class="icon-chevron-down"></span>Pack200 Plugins</a> |
| <ul class="nav nav-list"> |
| <li><a href="../tycho-pack200/tycho-pack200a-plugin/plugin-info.html" title="Normalization Plugin"><span class="none"></span>Normalization Plugin</a></li> |
| <li><a href="../tycho-pack200/tycho-pack200b-plugin/plugin-info.html" title="Pack Plugin"><span class="none"></span>Pack Plugin</a></li> |
| </ul> |
| </li> |
| </ul> |
| <hr /> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <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="span10" > |
| |
| |
| <section> |
| <h2><a name="tycho-source-feature:source-feature"></a>tycho-source-feature:source-feature</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.eclipse.tycho.extras:tycho-source-feature-plugin:1.6.0:source-feature</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div>Generates a source feature for projects of packaging type |
| eclipse-feature. By default, the generated source |
| feature |
| |
| <ul> |
| |
| <li>Declares feature id |
| <originalFeatureId>.source</li> |
| |
| <li>Declares feature label "<originalFeatureLabel> |
| Developer Resources"</li> |
| |
| <li>If present, reuses feature provider, description, copyright and |
| license as well as respective URLs from |
| <originalFeature></li> |
| |
| <li>Includes all plugins included by <originalFeature>, but |
| each with .source appended to each plugin id</li> |
| |
| <li>Includes all features included by <originalFeature>, but |
| each with .source appended to each feature id</li> |
| |
| <li>Includes the original feature. This ensures that binaries and |
| corresponding sources match.</li> |
| </ul> |
| Source feature generation can be customized by adding files under |
| path sourceTemplateFeature/. Files added here will be |
| added to the root of the source feature jar. Especially, if file |
| sourceTemplateFeature/feature.properties is found, |
| values in this file override values of respective keys in |
| <originalFeature>/feature.properties.</div> |
| |
| <p><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>Requires a Maven project to be executed.</li> |
| |
| <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: package.</li> |
| </ul> |
| <section> |
| <h3><a name="Optional_Parameters"></a>Optional Parameters</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><a href="#archive"><archive></a></td> |
| |
| <td>MavenArchiveConfiguration</td> |
| |
| <td>-</td> |
| |
| <td>(no description)<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#brandingPlugin"><brandingPlugin></a></td> |
| |
| <td>String</td> |
| |
| <td>-</td> |
| |
| <td>Use this to explicitly set the <a class="externalLink" href="http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.pde.doc.user%2Fguide%2Ftools%2Feditors%2Ffeature_editor%2Ffeature_editor.htm">branding |
| plugin attribute</a> of the generated source feature (overrides |
| reuseBrandingPlugin).<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#excludes"><excludes></a></td> |
| |
| <td>PlexusConfiguration</td> |
| |
| <td>-</td> |
| |
| <td>Bundles and features that do not have corresponding sources. |
| Example: |
| |
| <div> |
| <pre> |
| <excludes> |
| <plugin id="plugin.nosource"/> |
| <feature id="feature.nosource"/> |
| </excludes> |
| </pre></div><br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#finalName"><finalName></a></td> |
| |
| <td>String</td> |
| |
| <td>-</td> |
| |
| <td>The filename to be used for the generated archive file. For the |
| source-feature goal, "-sources-feature" is appended to this |
| filename.<br /><b>User property is</b>: project.build.finalName.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#includeBinaryFeature"><includeBinaryFeature></a></td> |
| |
| <td>boolean</td> |
| |
| <td>-</td> |
| |
| <td>Whether to add an include dependency from the source feature to the |
| corresponding binary feature. If true, this ensures |
| the version of the installed sources matches the binaries.<br /><b>Default value is</b>: true.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#labelSuffix"><labelSuffix></a></td> |
| |
| <td>String</td> |
| |
| <td>-</td> |
| |
| <td>Source feature label suffix. Unless explicitly provided in |
| sourceTemplateFeature/feature.properties, this suffix |
| will be appended to the original feature label to construct the |
| source feature label.<br /><b>Default value is</b>: Developer Resources.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#plugins"><plugins></a></td> |
| |
| <td>PlexusConfiguration</td> |
| |
| <td>-</td> |
| |
| <td>Additional plugins to include in the generated source feature. |
| Beware that these additional plugins are not considered during |
| build target platform calculation and ordering of reactor projects. |
| Use <extraRequirements> dependency resolver configuration to |
| guarantee proper reactor build order. |
| |
| <p><b>WARNING</b> This experimental parameter may be |
| removed from future source-feature mojo versions without prior |
| notice.</p><br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#reuseBrandingPlugin"><reuseBrandingPlugin></a></td> |
| |
| <td>boolean</td> |
| |
| <td>-</td> |
| |
| <td>Whether to reuse an explicit branding plugin from the binary |
| feature for the generated source feature.<br /><b>Default value is</b>: true.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a href="#skip"><skip></a></td> |
| |
| <td>boolean</td> |
| |
| <td>-</td> |
| |
| <td>Whether to skip source feature generation.<br /><b>Default value is</b>: false.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a href="#useDefaultExcludes"><useDefaultExcludes></a></td> |
| |
| <td>boolean</td> |
| |
| <td>-</td> |
| |
| <td>(no description)<br /><b>Default value is</b>: true.<br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| <section> |
| <h4><a name="a.3Carchive.3E"></a><b><a name="archive"><archive></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: org.apache.maven.archiver.MavenArchiveConfiguration</li> |
| |
| <li><b>Required</b>: No</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CbrandingPlugin.3E"></a><b><a name="brandingPlugin"><brandingPlugin></a></b></h4> |
| |
| <div>Use this to explicitly set the <a class="externalLink" href="http://help.eclipse.org/juno/index.jsp?topic=%2Forg.eclipse.pde.doc.user%2Fguide%2Ftools%2Feditors%2Ffeature_editor%2Ffeature_editor.htm">branding |
| plugin attribute</a> of the generated source feature (overrides |
| reuseBrandingPlugin).</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.lang.String</li> |
| |
| <li><b>Required</b>: No</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cexcludes.3E"></a><b><a name="excludes"><excludes></a></b></h4> |
| |
| <div>Bundles and features that do not have corresponding sources. |
| Example: |
| |
| <div> |
| <pre> |
| <excludes> |
| <plugin id="plugin.nosource"/> |
| <feature id="feature.nosource"/> |
| </excludes> |
| </pre></div></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: org.codehaus.plexus.configuration.PlexusConfiguration</li> |
| |
| <li><b>Required</b>: No</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CfinalName.3E"></a><b><a name="finalName"><finalName></a></b></h4> |
| |
| <div>The filename to be used for the generated archive file. For the |
| source-feature goal, "-sources-feature" is appended to this |
| filename.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.lang.String</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>User Property</b>: project.build.finalName</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CincludeBinaryFeature.3E"></a><b><a name="includeBinaryFeature"><includeBinaryFeature></a></b></h4> |
| |
| <div>Whether to add an include dependency from the source feature to the |
| corresponding binary feature. If true, this ensures |
| the version of the installed sources matches the binaries.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: boolean</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>Default</b>: true</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3ClabelSuffix.3E"></a><b><a name="labelSuffix"><labelSuffix></a></b></h4> |
| |
| <div>Source feature label suffix. Unless explicitly provided in |
| sourceTemplateFeature/feature.properties, this suffix |
| will be appended to the original feature label to construct the |
| source feature label.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: java.lang.String</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>Default</b>: Developer Resources</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cplugins.3E"></a><b><a name="plugins"><plugins></a></b></h4> |
| |
| <div>Additional plugins to include in the generated source feature. |
| Beware that these additional plugins are not considered during |
| build target platform calculation and ordering of reactor projects. |
| Use <extraRequirements> dependency resolver configuration to |
| guarantee proper reactor build order. |
| |
| <p><b>WARNING</b> This experimental parameter may be |
| removed from future source-feature mojo versions without prior |
| notice.</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: org.codehaus.plexus.configuration.PlexusConfiguration</li> |
| |
| <li><b>Required</b>: No</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CreuseBrandingPlugin.3E"></a><b><a name="reuseBrandingPlugin"><reuseBrandingPlugin></a></b></h4> |
| |
| <div>Whether to reuse an explicit branding plugin from the binary |
| feature for the generated source feature.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: boolean</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>Default</b>: true</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cskip.3E"></a><b><a name="skip"><skip></a></b></h4> |
| |
| <div>Whether to skip source feature generation.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: boolean</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>Default</b>: false</li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CuseDefaultExcludes.3E"></a><b><a name="useDefaultExcludes"><useDefaultExcludes></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: boolean</li> |
| |
| <li><b>Required</b>: No</li> |
| |
| <li><b>Default</b>: true</li> |
| </ul> |
| </section></section> |
| </section> |
| |
| |
| </div> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>Copyright ©2008–2020 |
| <a href="http://www.eclipse.org/">Eclipse Foundation</a>. |
| All rights reserved.</p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
