Google Git
Sign in
eclipse / gerrit / www.eclipse.org / tycho / 91fbc5f53939df1d277d00ac3b22fa22d2660987 / . / sitedocs-extras / tycho-p2-extras-plugin / target / generated-site / xdoc / publish-features-and-bundles-mojo.xml
blob: 3255687106c6014dea54a29aa998811c58a0a60d [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-p2-extras:publish-features-and-bundles</title>
</properties>
<body>
<section name="tycho-p2-extras:publish-features-and-bundles">
<p><strong>Full name</strong>:</p>
<p>org.eclipse.tycho.extras:tycho-p2-extras-plugin:1.5.1-SNAPSHOT:publish-features-and-bundles</p>
<p><strong>Description</strong>:</p>
<div>This goal invokes the feature and bundle publisher on a folder.</div>
<p><strong>Attributes</strong>:</p>
<ul>
<li>Requires a Maven project to be executed.</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="#additionalArgs">&lt;additionalArgs&gt;</a></code></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>Optional line of additional arguments passed to the p2 application
launcher.<br/></td>
</tr>
<tr>
<td><code><a href="#append">&lt;append&gt;</a></code></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Optional flag to append artifacts to an existing repository<br/><strong>Default value is</strong>: <code>false</code>.<br/></td>
</tr>
<tr>
<td><code><a href="#artifactRepositoryLocation">&lt;artifactRepositoryLocation&gt;</a></code></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>Location of the artifact repository to write. Note: The
AssembleRepositoryMojo of tycho-p2-repository-plugin will only work
with the predefined default ${project.build.directory}/repository.<br/><strong>Default value is</strong>: <code>${project.build.directory}/repository</code>.<br/></td>
</tr>
<tr>
<td><code><a href="#compress">&lt;compress&gt;</a></code></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Create compressed jars rather than plain xml<br/><strong>Default value is</strong>: <code>true</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>Default value is</strong>: <code>0</code>.<br/><strong>User property is</strong>: <code>p2.timeout</code>.<br/></td>
</tr>
<tr>
<td><code><a href="#metadataRepositoryLocation">&lt;metadataRepositoryLocation&gt;</a></code></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>Location of the metadata repository to write. The
AssembleRepositoryMojo of tycho-p2-repository-plugin will only work
with the predefined default ${project.build.directory}/repository.<br/><strong>Default value is</strong>: <code>${project.build.directory}/repository</code>.<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="#publishArtifacts">&lt;publishArtifacts&gt;</a></code></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Publish artifacts to repository<br/><strong>Default value is</strong>: <code>true</code>.<br/></td>
</tr>
<tr>
<td><code><a href="#reusePack200Files">&lt;reusePack200Files&gt;</a></code></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Optional flag to include .pack.gz files<br/><strong>Default value is</strong>: <code>false</code>.<br/></td>
</tr>
<tr>
<td><code><a href="#sourceLocation">&lt;sourceLocation&gt;</a></code></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>Location with features and/or plugins directories on which the
features and bundles publisher shall be called.<br/><strong>Default value is</strong>: <code>${project.build.directory}/source</code>.<br/></td>
</tr>
</table>
</subsection>
<subsection name="Parameter Details">
<h4><strong><a name="additionalArgs">&lt;additionalArgs&gt;</a></strong></h4>
<div>Optional line of additional arguments passed to the p2 application
launcher.</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="append">&lt;append&gt;</a></strong></h4>
<div>Optional flag to append artifacts to an existing repository</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul><hr/><h4><strong><a name="artifactRepositoryLocation">&lt;artifactRepositoryLocation&gt;</a></strong></h4>
<div>Location of the artifact repository to write. Note: The
AssembleRepositoryMojo of tycho-p2-repository-plugin will only work
with the predefined default ${project.build.directory}/repository.</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>${project.build.directory}/repository</code></li>
</ul><hr/><h4><strong><a name="compress">&lt;compress&gt;</a></strong></h4>
<div>Create compressed jars rather than plain xml</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="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>p2.timeout</code></li>
<li><strong>Default</strong>: <code>0</code></li>
</ul><hr/><h4><strong><a name="metadataRepositoryLocation">&lt;metadataRepositoryLocation&gt;</a></strong></h4>
<div>Location of the metadata repository to write. The
AssembleRepositoryMojo of tycho-p2-repository-plugin will only work
with the predefined default ${project.build.directory}/repository.</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>${project.build.directory}/repository</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="publishArtifacts">&lt;publishArtifacts&gt;</a></strong></h4>
<div>Publish artifacts to repository</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="reusePack200Files">&lt;reusePack200Files&gt;</a></strong></h4>
<div>Optional flag to include .pack.gz files</div>
<ul>
<li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul><hr/><h4><strong><a name="sourceLocation">&lt;sourceLocation&gt;</a></strong></h4>
<div>Location with features and/or plugins directories on which the
features and bundles publisher shall be called.</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>${project.build.directory}/source</code></li>
</ul>
</subsection>
</section>
</body>
</document>