| <?xml version="1.0" encoding="UTF-8"?> |
| <document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> |
| <properties> |
| <title>target-platform-validation:validate-target-platform</title> |
| </properties> |
| <body> |
| <section name="target-platform-validation:validate-target-platform"> |
| <p><strong>Full name</strong>:</p> |
| <p>org.eclipse.tycho.extras:target-platform-validation-plugin:1.5.1-SNAPSHOT:validate-target-platform</p> |
| <p><strong>Description</strong>:</p> |
| <div>Validates that specified target platforms (.target files) contents |
| can be resolved.</div> |
| <p><strong>Attributes</strong>:</p> |
| <ul> |
| <li>Requires a Maven project to be executed.</li> |
| <li>Binds by default to the <a href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <code>validate</code>.</li> |
| </ul> |
| <subsection name="Optional Parameters"> |
| <table border="0"> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Since</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td><code><a href="#checkDependencies"><checkDependencies></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>0.21.0</code></td> |
| <td>Check that, for each artifact from the target file, the |
| dependencies of the artifact are also contained in the target file. |
| Also check that there are no conflicting artifacts, i.e. artifact |
| which could not be installed together. When this check passes, none |
| of the artifacts should lead to dependency resolution problems when |
| used in a Tycho project.<br/><strong>Default value is</strong>: <code>false</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#checkProvisioning"><checkProvisioning></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>0.26.0</code></td> |
| <td>Check that the content of the target-platform can be installed |
| together in a same provisioning operation.<br/><strong>Default value is</strong>: <code>false</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#executionEnvironment"><executionEnvironment></a></code></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td>(no description)<br/><strong>Default value is</strong>: <code>JavaSE-1.7</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#failOnError"><failOnError></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>whether to fail build or just print a warning when a validation |
| fails<br/><strong>Default value is</strong>: <code>true</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#project"><project></a></code></td> |
| <td><code>MavenProject</code></td> |
| <td><code>-</code></td> |
| <td>(no description)<br/><strong>User property is</strong>: <code>project</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#targetFiles"><targetFiles></a></code></td> |
| <td><code>File[]</code></td> |
| <td><code>-</code></td> |
| <td>The .target files to validate. If not specified and the project |
| packaging is "eclipse-target-definition", the goal will validate |
| project's primary target file will be validated.<br/></td> |
| </tr> |
| </table> |
| </subsection> |
| <subsection name="Parameter Details"> |
| <h4><strong><a name="checkDependencies"><checkDependencies></a></strong></h4> |
| <div>Check that, for each artifact from the target file, the |
| dependencies of the artifact are also contained in the target file. |
| Also check that there are no conflicting artifacts, i.e. artifact |
| which could not be installed together. When this check passes, none |
| of the artifacts should lead to dependency resolution problems when |
| used in a Tycho project.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Since</strong>: <code>0.21.0</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Default</strong>: <code>false</code></li> |
| </ul><hr/><h4><strong><a name="checkProvisioning"><checkProvisioning></a></strong></h4> |
| <div>Check that the content of the target-platform can be installed |
| together in a same provisioning operation.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Since</strong>: <code>0.26.0</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Default</strong>: <code>false</code></li> |
| </ul><hr/><h4><strong><a name="executionEnvironment"><executionEnvironment></a></strong></h4> |
| <div>(no description)</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Default</strong>: <code>JavaSE-1.7</code></li> |
| </ul><hr/><h4><strong><a name="failOnError"><failOnError></a></strong></h4> |
| <div>whether to fail build or just print a warning when a validation |
| fails</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Default</strong>: <code>true</code></li> |
| </ul><hr/><h4><strong><a name="project"><project></a></strong></h4> |
| <div>(no description)</div> |
| <ul> |
| <li><strong>Type</strong>: <code>org.apache.maven.project.MavenProject</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>project</code></li> |
| </ul><hr/><h4><strong><a name="targetFiles"><targetFiles></a></strong></h4> |
| <div>The .target files to validate. If not specified and the project |
| packaging is "eclipse-target-definition", the goal will validate |
| project's primary target file will be validated.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.io.File[]</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| </ul> |
| </subsection> |
| </section> |
| </body> |
| </document> |
