| <?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>tycho-eclipserun:eclipse-run</title> |
| </properties> |
| <body> |
| <section name="tycho-eclipserun:eclipse-run"> |
| <p><strong>Full name</strong>:</p> |
| <p>org.eclipse.tycho.extras:tycho-eclipserun-plugin:1.5.1-SNAPSHOT:eclipse-run</p> |
| <p><strong>Description</strong>:</p> |
| <div>Launch an eclipse process with arbitrary commandline arguments. The |
| eclipse installation is defined by the dependencies to bundles |
| specified.</div> |
| <p><strong>Attributes</strong>:</p> |
| <ul> |
| <li>Requires a Maven project to be executed.</li> |
| </ul> |
| <subsection name="Required Parameters"> |
| <table border="0"> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Since</th> |
| <th>Description</th> |
| </tr> |
| <tr> |
| <td><code><a href="#repositories"><repositories></a></code></td> |
| <td><code>List</code></td> |
| <td><code>-</code></td> |
| <td>p2 repositories which will be used to resolve dependencies. |
| Example: |
| <pre> |
| <repositories> |
| <repository> |
| <id>juno</id> |
| <layout>p2</layout> |
| <url>http://download.eclipse.org/releases/juno</url> |
| </repository> |
| </repositories> |
| </pre><br/></td> |
| </tr> |
| </table> |
| </subsection> |
| <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="#addDefaultDependencies"><addDefaultDependencies></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Whether to add default dependencies to bundles |
| org.eclipse.equinox.launcher, org.eclipse.osgi and |
| org.eclipse.core.runtime.<br/><strong>Default value is</strong>: <code>true</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#appArgLine"><appArgLine></a></code></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td><strong>Deprecated.</strong> use <code>applicationsArgs</code> instead.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#applicationsArgs"><applicationsArgs></a></code></td> |
| <td><code>List</code></td> |
| <td><code>0.24.0</code></td> |
| <td>List of applications arguments set on the command line. Example: |
| <pre> |
| <applicationsArgs> |
| <args>-buildfile</args> |
| <args>build-test.xml</args> |
| </applicationsArgs> |
| </pre><br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#argLine"><argLine></a></code></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td><strong>Deprecated.</strong> use <code>jvmArgs</code> instead.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#dependencies"><dependencies></a></code></td> |
| <td><code>List</code></td> |
| <td><code>-</code></td> |
| <td>Dependencies which will be resolved transitively to make up the |
| eclipse runtime. Example: |
| <pre> |
| <dependencies> |
| <dependency> |
| <artifactId>org.eclipse.ant.core</artifactId> |
| <type>eclipse-plugin</type> |
| </dependency> |
| </dependencies> |
| </pre><br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#environmentVariables"><environmentVariables></a></code></td> |
| <td><code>Map</code></td> |
| <td><code>-</code></td> |
| <td>Additional environments to set for the forked JVM.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#executionEnvironment"><executionEnvironment></a></code></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td>Execution environment profile name used to resolve dependencies.<br/><strong>Default value is</strong>: <code>JavaSE-1.7</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#forkedProcessTimeoutInSeconds"><forkedProcessTimeoutInSeconds></a></code></td> |
| <td><code>int</code></td> |
| <td><code>-</code></td> |
| <td>Kill the forked process after a certain number of seconds. If set |
| to 0, wait forever for the process, never timing out.<br/><strong>User property is</strong>: <code>eclipserun.timeout</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#jvmArgs"><jvmArgs></a></code></td> |
| <td><code>List</code></td> |
| <td><code>0.25.0</code></td> |
| <td>List of JVM arguments set on the command line. Example: |
| <pre> |
| <jvmArgs> |
| <args>-Xdebug</args> |
| <args>-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=1044</args> |
| </jvmArgs> |
| </pre><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="#skip"><skip></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Whether to skip mojo execution.<br/><strong>Default value is</strong>: <code>false</code>.<br/><strong>User property is</strong>: <code>eclipserun.skip</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#work"><work></a></code></td> |
| <td><code>File</code></td> |
| <td><code>-</code></td> |
| <td>(no description)<br/><strong>Default value is</strong>: <code>${project.build.directory}/eclipserun-work</code>.<br/></td> |
| </tr> |
| </table> |
| </subsection> |
| <subsection name="Parameter Details"> |
| <h4><strong><a name="addDefaultDependencies"><addDefaultDependencies></a></strong></h4> |
| <div>Whether to add default dependencies to bundles |
| org.eclipse.equinox.launcher, org.eclipse.osgi and |
| org.eclipse.core.runtime.</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="appArgLine"><appArgLine></a></strong></h4> |
| <div><strong>Deprecated.</strong> use <code>applicationsArgs</code> instead.</div> |
| <div>Arbitrary applications arguments to set on the command line.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| </ul><hr/><h4><strong><a name="applicationsArgs"><applicationsArgs></a></strong></h4> |
| <div>List of applications arguments set on the command line. Example: |
| <pre> |
| <applicationsArgs> |
| <args>-buildfile</args> |
| <args>build-test.xml</args> |
| </applicationsArgs> |
| </pre></div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.util.List</code></li> |
| <li><strong>Since</strong>: <code>0.24.0</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| </ul><hr/><h4><strong><a name="argLine"><argLine></a></strong></h4> |
| <div><strong>Deprecated.</strong> use <code>jvmArgs</code> instead.</div> |
| <div>Arbitrary JVM options to set on the command line.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| </ul><hr/><h4><strong><a name="dependencies"><dependencies></a></strong></h4> |
| <div>Dependencies which will be resolved transitively to make up the |
| eclipse runtime. Example: |
| <pre> |
| <dependencies> |
| <dependency> |
| <artifactId>org.eclipse.ant.core</artifactId> |
| <type>eclipse-plugin</type> |
| </dependency> |
| </dependencies> |
| </pre></div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.util.List</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| </ul><hr/><h4><strong><a name="environmentVariables"><environmentVariables></a></strong></h4> |
| <div>Additional environments to set for the forked JVM.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.util.Map</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| </ul><hr/><h4><strong><a name="executionEnvironment"><executionEnvironment></a></strong></h4> |
| <div>Execution environment profile name used to resolve dependencies.</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="forkedProcessTimeoutInSeconds"><forkedProcessTimeoutInSeconds></a></strong></h4> |
| <div>Kill the forked process after a certain number of seconds. If set |
| to 0, wait forever for the process, never timing out.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>int</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>eclipserun.timeout</code></li> |
| </ul><hr/><h4><strong><a name="jvmArgs"><jvmArgs></a></strong></h4> |
| <div>List of JVM arguments set on the command line. Example: |
| <pre> |
| <jvmArgs> |
| <args>-Xdebug</args> |
| <args>-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=1044</args> |
| </jvmArgs> |
| </pre></div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.util.List</code></li> |
| <li><strong>Since</strong>: <code>0.25.0</code></li> |
| <li><strong>Required</strong>: <code>No</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="repositories"><repositories></a></strong></h4> |
| <div>p2 repositories which will be used to resolve dependencies. |
| Example: |
| <pre> |
| <repositories> |
| <repository> |
| <id>juno</id> |
| <layout>p2</layout> |
| <url>http://download.eclipse.org/releases/juno</url> |
| </repository> |
| </repositories> |
| </pre></div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.util.List</code></li> |
| <li><strong>Required</strong>: <code>Yes</code></li> |
| </ul><hr/><h4><strong><a name="skip"><skip></a></strong></h4> |
| <div>Whether to skip mojo execution.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>eclipserun.skip</code></li> |
| <li><strong>Default</strong>: <code>false</code></li> |
| </ul><hr/><h4><strong><a name="work"><work></a></strong></h4> |
| <div>(no description)</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.io.File</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Default</strong>: <code>${project.build.directory}/eclipserun-work</code></li> |
| </ul> |
| </subsection> |
| </section> |
| </body> |
| </document> |