| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.9.2 from target/generated-site/xdoc/target-platform-configuration-mojo.xml at 2021-01-11 |
| | Rendered using Apache Maven Fluido Skin 1.9 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" /> |
| <title>Tycho Target Platform Configuration Plugin – target-platform-configuration:target-platform-configuration</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.9.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script src="./js/apache-maven-fluido-1.9.min.js"></script> |
| </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h2>Tycho Target Platform Configuration 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: 2021-01-11<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 2.2.0</li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav 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="../target-platform-configuration/plugin-info.html" title="Target Platform Configuration"><span class="none"></span>Target Platform Configuration</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="../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="" title="Properties"><span class="icon-chevron-down"></span>Properties</a> |
| <ul class="nav nav-list"> |
| <li><a href="../BuildProperties.html" title="Build Properties"><span class="none"></span>Build Properties</a></li> |
| <li><a href="../TychoProperties.html" title="Tycho Properties"><span class="none"></span>Tycho Properties</a></li> |
| </ul></li> |
| <li class="nav-header">Tycho Extras</li> |
| <li><a href="../tycho-extras/index.html" title="Introduction"><span class="none"></span>Introduction</a></li> |
| <li><a href="../tycho-extras/tycho-p2-extras-plugin/plugin-info.html" title="P2 Extras Plugin"><span class="none"></span>P2 Extras Plugin</a></li> |
| <li><a href="../tycho-extras/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-extras/tycho-eclipserun-plugin/plugin-info.html" title="Eclipserun Plugin"><span class="none"></span>Eclipserun Plugin</a></li> |
| <li><a href="../tycho-extras/tycho-document-bundle-plugin/plugin-info.html" title="Document Bundle Plugin"><span class="none"></span>Document Bundle Plugin</a></li> |
| <li><a href="../tycho-extras/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-extras/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-extras/tycho-pack200/tycho-pack200a-plugin/plugin-info.html" title="Normalization Plugin"><span class="none"></span>Normalization Plugin</a></li> |
| <li><a href="../tycho-extras/tycho-pack200/tycho-pack200b-plugin/plugin-info.html" title="Pack Plugin"><span class="none"></span>Pack Plugin</a></li> |
| </ul></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <hr /> |
| <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> |
| </header> |
| <main id="bodyColumn" class="span10" > |
| |
| |
| <section> |
| <h2><a name="target-platform-configuration:target-platform-configuration"></a>target-platform-configuration:target-platform-configuration</h2> |
| |
| <p><b>Full name</b>:</p> |
| |
| <p>org.eclipse.tycho:target-platform-configuration:2.2.0:target-platform-configuration</p> |
| |
| <p><b>Description</b>:</p> |
| |
| <div>Configures the target-platform to use in order to resolve |
| dependencies. <br /> |
| ⚠️ This mojo is actually not executable, and is only meant to host |
| configuration</div> |
| |
| <p><b>Attributes</b>:</p> |
| |
| <ul> |
| |
| <li>Requires a Maven project to be executed.</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><code><a href="#allowConflictingDependencies"><allowConflictingDependencies></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>(no description)<br /><b>Default value is</b>: <code>false</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><code><a href="#breeHeaderSelectionPolicy"><breeHeaderSelectionPolicy></a></code></td> |
| |
| <td><code>TargetPlatformConfiguration$BREEHeaderSelectionPolicy</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>(no description)<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><code><a href="#dependency-resolution"><dependency-resolution></a></code></td> |
| |
| <td><code>Object</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>(no description)<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><code><a href="#environments"><environments></a></code></td> |
| |
| <td><code>TargetEnvironment[]</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Target environments (os/ws/arch) to consider.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><code><a href="#executionEnvironment"><executionEnvironment></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Force an execution environment for dependency resolution. If unset, |
| the first <code>targetJRE</code> available in <code>target</code> |
| is used. |
| |
| <p>Set to <code>none</code> to force the resolution to happen |
| <b>without</b> any execution environment, typically when the module |
| is supposed to use system packages coming from some dependencies |
| (eg shipping a JRE inside products with Eclipse JustJ).</p><br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><code><a href="#executionEnvironmentDefault"><executionEnvironmentDefault></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>(no description)<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><code><a href="#filters"><filters></a></code></td> |
| |
| <td><code>List</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>(no description)<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><code><a href="#includePackedArtifacts"><includePackedArtifacts></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>(no description)<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><code><a href="#pomDependencies"><pomDependencies></a></code></td> |
| |
| <td><code>TargetPlatformConfiguration$PomDependencies</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>Defines which strategy to apply to Maven dependencies. |
| |
| <p>If <code>consider</code> or <code>wrapAsBundle</code>, the |
| effect is:</p> |
| |
| <ul> |
| |
| <li>First, Maven resolves the GAV dependencies according to the |
| normal Maven rules. This results in a list of artifacts consisting |
| of the specified artifacts and their transitive Maven |
| dependencies.</li> |
| |
| <li>Tycho then checks each of these artifacts, and if the artifact |
| is an OSGi bundle, it is added to the target platform. Other |
| artifacts are ignored in case of <code>consider</code>, or get some |
| OSGi metadata generated and an OSGi bundle created from them.</li> |
| |
| <li>OSGi bundles which become part of the target platform in this |
| way are then available to resolve the project's OSGi |
| dependencies.</li> |
| </ul> |
| <br /> |
| <br /> |
| |
| |
| <p>Tycho always attempts to resolve transitive dependencies, so if |
| you need a POM dependency in the target platform of one module, you |
| will also need it in all downstream modules. Therefore the POM |
| dependencies (and the pomDependencies=consider configuration) |
| typically need to be added in the parent POM.</p><br /><b>Default value is</b>: <code>ignore</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><code><a href="#resolveWithExecutionEnvironmentConstraints"><resolveWithExecutionEnvironmentConstraints></a></code></td> |
| |
| <td><code>boolean</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>(no description)<br /><b>Default value is</b>: <code>true</code>.<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><code><a href="#resolver"><resolver></a></code></td> |
| |
| <td><code>String</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>(no description)<br /><b>Default value is</b>: <code>p2</code>.<br /></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><code><a href="#target"><target></a></code></td> |
| |
| <td><code>GAV[]</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>List of .target artifacts to use for dependency resolution.<br /> |
| ⚠️ Children element <b>must</b> use <code><artifact></code> |
| as tag name<br /></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><code><a href="#targetDefinitionIncludeSource"><targetDefinitionIncludeSource></a></code></td> |
| |
| <td><code>IncludeSourceMode</code></td> |
| |
| <td><code>-</code></td> |
| |
| <td>(no description)<br /></td> |
| </tr> |
| </table> |
| </section> |
| <section> |
| <h3><a name="Parameter_Details"></a>Parameter Details</h3> |
| <section> |
| <h4><a name="a.3CallowConflictingDependencies.3E"></a><b><a name="allowConflictingDependencies"><allowConflictingDependencies></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>false</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CbreeHeaderSelectionPolicy.3E"></a><b><a name="breeHeaderSelectionPolicy"><breeHeaderSelectionPolicy></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>org.eclipse.tycho.core.TargetPlatformConfiguration$BREEHeaderSelectionPolicy</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cdependency-resolution.3E"></a><b><a name="dependency-resolution"><dependency-resolution></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.Object</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cenvironments.3E"></a><b><a name="environments"><environments></a></b></h4> |
| |
| <div>Target environments (os/ws/arch) to consider.</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>org.eclipse.tycho.core.shared.TargetEnvironment[]</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CexecutionEnvironment.3E"></a><b><a name="executionEnvironment"><executionEnvironment></a></b></h4> |
| |
| <div>Force an execution environment for dependency resolution. If unset, |
| the first <code>targetJRE</code> available in <code>target</code> |
| is used. |
| |
| <p>Set to <code>none</code> to force the resolution to happen |
| <b>without</b> any execution environment, typically when the module |
| is supposed to use system packages coming from some dependencies |
| (eg shipping a JRE inside products with Eclipse JustJ).</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CexecutionEnvironmentDefault.3E"></a><b><a name="executionEnvironmentDefault"><executionEnvironmentDefault></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cfilters.3E"></a><b><a name="filters"><filters></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.util.List</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CincludePackedArtifacts.3E"></a><b><a name="includePackedArtifacts"><includePackedArtifacts></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CpomDependencies.3E"></a><b><a name="pomDependencies"><pomDependencies></a></b></h4> |
| |
| <div>Defines which strategy to apply to Maven dependencies. |
| |
| <p>If <code>consider</code> or <code>wrapAsBundle</code>, the |
| effect is:</p> |
| |
| <ul> |
| |
| <li>First, Maven resolves the GAV dependencies according to the |
| normal Maven rules. This results in a list of artifacts consisting |
| of the specified artifacts and their transitive Maven |
| dependencies.</li> |
| |
| <li>Tycho then checks each of these artifacts, and if the artifact |
| is an OSGi bundle, it is added to the target platform. Other |
| artifacts are ignored in case of <code>consider</code>, or get some |
| OSGi metadata generated and an OSGi bundle created from them.</li> |
| |
| <li>OSGi bundles which become part of the target platform in this |
| way are then available to resolve the project's OSGi |
| dependencies.</li> |
| </ul> |
| <br /> |
| <br /> |
| |
| |
| <p>Tycho always attempts to resolve transitive dependencies, so if |
| you need a POM dependency in the target platform of one module, you |
| will also need it in all downstream modules. Therefore the POM |
| dependencies (and the pomDependencies=consider configuration) |
| typically need to be added in the parent POM.</p></div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>org.eclipse.tycho.core.TargetPlatformConfiguration$PomDependencies</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>ignore</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CresolveWithExecutionEnvironmentConstraints.3E"></a><b><a name="resolveWithExecutionEnvironmentConstraints"><resolveWithExecutionEnvironmentConstraints></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>boolean</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>true</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Cresolver.3E"></a><b><a name="resolver"><resolver></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>java.lang.String</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| |
| <li><b>Default</b>: <code>p2</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3Ctarget.3E"></a><b><a name="target"><target></a></b></h4> |
| |
| <div>List of .target artifacts to use for dependency resolution.<br /> |
| ⚠️ Children element <b>must</b> use <code><artifact></code> |
| as tag name</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>org.eclipse.tycho.p2.repository.GAV[]</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul><hr /></section><section> |
| <h4><a name="a.3CtargetDefinitionIncludeSource.3E"></a><b><a name="targetDefinitionIncludeSource"><targetDefinitionIncludeSource></a></b></h4> |
| |
| <div>(no description)</div> |
| |
| <ul> |
| |
| <li><b>Type</b>: <code>org.eclipse.tycho.core.resolver.shared.IncludeSourceMode</code></li> |
| |
| <li><b>Required</b>: <code>No</code></li> |
| </ul> |
| </section></section> |
| </section> |
| |
| |
| </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| <p>© 2008–2021 |
| <a href="http://www.eclipse.org/">Eclipse Foundation</a> |
| </p> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
