Google Git
Sign in
eclipse / gerrit / www.eclipse.org / tycho / 91fbc5f53939df1d277d00ac3b22fa22d2660987 / . / sitedocs-extras / tycho-eclipserun-plugin / target / generated-site / xdoc / eclipse-run-mojo.xml
blob: 5ba899d5dcb846675aa64b4fb871bbf8f9bb9138 [file] [log] [blame]
<?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">&lt;repositories&gt;</a></code></td>
<td><code>List</code></td>
<td><code>-</code></td>
<td>p2 repositories which will be used to resolve dependencies.
Example:
<pre>
&lt;repositories&gt;
&lt;repository&gt;
&lt;id&gt;juno&lt;/id&gt;
&lt;layout&gt;p2&lt;/layout&gt;
&lt;url&gt;http://download.eclipse.org/releases/juno&lt;/url&gt;
&lt;/repository&gt;
&lt;/repositories&gt;
</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">&lt;addDefaultDependencies&gt;</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">&lt;appArgLine&gt;</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">&lt;applicationsArgs&gt;</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>
&lt;applicationsArgs&gt;
&lt;args&gt;-buildfile&lt;/args&gt;
&lt;args&gt;build-test.xml&lt;/args&gt;
&lt;/applicationsArgs&gt;
</pre><br/></td>
</tr>
<tr>
<td><code><a href="#argLine">&lt;argLine&gt;</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">&lt;dependencies&gt;</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>
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;artifactId&gt;org.eclipse.ant.core&lt;/artifactId&gt;
&lt;type&gt;eclipse-plugin&lt;/type&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
</pre><br/></td>
</tr>
<tr>
<td><code><a href="#environmentVariables">&lt;environmentVariables&gt;</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">&lt;executionEnvironment&gt;</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">&lt;forkedProcessTimeoutInSeconds&gt;</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">&lt;jvmArgs&gt;</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>
&lt;jvmArgs&gt;
&lt;args&gt;-Xdebug&lt;/args&gt;
&lt;args&gt;-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=1044&lt;/args&gt;
&lt;/jvmArgs&gt;
</pre><br/></td>
</tr>
<tr>
<td><code><a href="#project">&lt;project&gt;</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">&lt;skip&gt;</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">&lt;work&gt;</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">&lt;addDefaultDependencies&gt;</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">&lt;appArgLine&gt;</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">&lt;applicationsArgs&gt;</a></strong></h4>
<div>List of applications arguments set on the command line. Example:
<pre>
&lt;applicationsArgs&gt;
&lt;args&gt;-buildfile&lt;/args&gt;
&lt;args&gt;build-test.xml&lt;/args&gt;
&lt;/applicationsArgs&gt;
</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">&lt;argLine&gt;</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">&lt;dependencies&gt;</a></strong></h4>
<div>Dependencies which will be resolved transitively to make up the
eclipse runtime. Example:
<pre>
&lt;dependencies&gt;
&lt;dependency&gt;
&lt;artifactId&gt;org.eclipse.ant.core&lt;/artifactId&gt;
&lt;type&gt;eclipse-plugin&lt;/type&gt;
&lt;/dependency&gt;
&lt;/dependencies&gt;
</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">&lt;environmentVariables&gt;</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">&lt;executionEnvironment&gt;</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">&lt;forkedProcessTimeoutInSeconds&gt;</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">&lt;jvmArgs&gt;</a></strong></h4>
<div>List of JVM arguments set on the command line. Example:
<pre>
&lt;jvmArgs&gt;
&lt;args&gt;-Xdebug&lt;/args&gt;
&lt;args&gt;-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=1044&lt;/args&gt;
&lt;/jvmArgs&gt;
</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">&lt;project&gt;</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">&lt;repositories&gt;</a></strong></h4>
<div>p2 repositories which will be used to resolve dependencies.
Example:
<pre>
&lt;repositories&gt;
&lt;repository&gt;
&lt;id&gt;juno&lt;/id&gt;
&lt;layout&gt;p2&lt;/layout&gt;
&lt;url&gt;http://download.eclipse.org/releases/juno&lt;/url&gt;
&lt;/repository&gt;
&lt;/repositories&gt;
</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">&lt;skip&gt;</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">&lt;work&gt;</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>