blob: c4703a17c5399b5ae9186754b9893a3911de0ef5 [file] [log] [blame]
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.9.1 from target/generated-site/xdoc/archive-products-mojo.xml at 2020-04-06
| Rendered using Apache Maven Fluido Skin 1.8
-->
<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.1" />
<title>Tycho p2 Director Plugin &#x2013; tycho-p2-director:archive-products</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.8.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.8.min.js"></script>
</head>
<body class="topBarDisabled">
<div class="container-fluid">
<header>
<div id="banner">
<div class="pull-left"><div id="bannerLeft"><h2>Tycho p2 Director 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: 2020-04-06<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.7.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="../../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="tycho-p2-director:archive-products"></a>tycho-p2-director:archive-products</h2>
<p><b>Full name</b>:</p>
<p>org.eclipse.tycho:tycho-p2-director-plugin:1.7.0:archive-products</p>
<p><b>Description</b>:</p>
<div>
<p>Creates archives with the product installations.</p></div>
<p><b>Attributes</b>:</p>
<ul>
<li>Requires a Maven project to be executed.</li>
<li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: package.</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><a href="#forkedProcessTimeoutInSeconds">&lt;forkedProcessTimeoutInSeconds&gt;</a></td>
<td>int</td>
<td>-</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 /><b>Default value is</b>: 0.<br /><b>User property is</b>: p2.timeout.<br /></td>
</tr>
<tr class="a">
<td><a href="#formats">&lt;formats&gt;</a></td>
<td>Map</td>
<td>-</td>
<td>
<p>Maps os to format. By default a zip file will be created. For
example, the following configuration will create tar.gz product
archives for Linux</p>
<div>
<pre>
&lt;formats&gt;
&lt;linux&gt;tar.gz&lt;/linux&gt;
&lt;/formats&gt;
</pre></div>
Supported formats
<ul>
<li>zip</li>
<li>tar.gz</li>
</ul>
<br />
<br /><br /></td>
</tr>
<tr class="b">
<td><a href="#products">&lt;products&gt;</a></td>
<td>List</td>
<td>-</td>
<td>
<p>Selection of products to be installed and configuration per
product.</p>
<p>If the project contains more than one product file, you need to
choose for which ones you want to create distribution archives. If
you choose to install more than one product, you need to specify
the attachId (which becomes a part of the classifier) to
make the classifiers unique. Example:</p>
<div>
<pre>
&lt;plugin&gt;
&lt;groupId&gt;org.eclipse.tycho&lt;/groupId&gt;
&lt;artifactId&gt;tycho-p2-director-plugin&lt;/artifactId&gt;
&lt;version&gt;${tycho-version}&lt;/version&gt;
&lt;executions&gt;
&lt;execution&gt;
&lt;id&gt;create-distributions&lt;/id&gt;
&lt;goals&gt;
&lt;goal&gt;materialize-products&lt;/goal&gt;
&lt;goal&gt;archive-products&lt;/goal&gt;
&lt;/goals&gt;
&lt;/execution&gt;
&lt;/executions&gt;
&lt;configuration&gt;
&lt;products&gt;
&lt;product&gt;
&lt;!-- select product with ID product.id; the archives get the classifiers &quot;&lt;os&gt;.&lt;ws&gt;.&lt;arch&gt;&quot; --&gt;
&lt;id&gt;product.id&lt;/id&gt;
&lt;/product&gt;
&lt;product&gt;
&lt;!-- select product with ID other.product.id for the classifiers &quot;other-&lt;os&gt;.&lt;ws&gt;.&lt;arch&gt;&quot; --&gt;
&lt;id&gt;other.product.id&lt;/id&gt;
&lt;attachId&gt;other&lt;/attachId&gt;
&lt;/product&gt;
&lt;/products&gt;
&lt;/configuration&gt;
&lt;/plugin&gt;
</pre></div>
The following snippet shows the optional parameters which can be
specified per product:
<div>
<pre>
&lt;configuration&gt;
&lt;products&gt;
&lt;product&gt;
&lt;id&gt;product.id&lt;/id&gt;
&lt;!-- optional parameters --&gt;
&lt;rootFolder&gt;&lt;/rootFolder&gt;
&lt;rootFolders&gt;
&lt;macosx&gt;&lt;/macosx&gt;
&lt;linux&gt;&lt;/linux&gt;
&lt;freebsd&gt;&lt;/freebsd&gt;
&lt;win32&gt;&lt;/win32&gt;
&lt;/rootFolders&gt;
&lt;/product&gt;
...
&lt;/products&gt;
&lt;/configuration&gt;
</pre></div>
Details on the product-specific configuration parameters:
<ul>
<li>rootFolder - The path where the installed product
shall be stored in the archive, e.g. &quot;eclipse&quot;. By default, the
product is stored in the archive root.</li>
<li>rootFolders - OS-specific installation root folders,
overriding rootFolder. Allowed children are
&lt;macosx&gt;, &lt;win32&gt;,
&lt;linux&gt; and &lt;freebsd&gt; or any other OS
supported by p2. Since 0.18.0</li>
</ul><br /></td>
</tr>
</table>
</section>
<section>
<h3><a name="Parameter_Details"></a>Parameter Details</h3>
<section>
<h4><a name="a.3CforkedProcessTimeoutInSeconds.3E"></a><b><a name="forkedProcessTimeoutInSeconds">&lt;forkedProcessTimeoutInSeconds&gt;</a></b></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><b>Type</b>: int</li>
<li><b>Required</b>: No</li>
<li><b>User Property</b>: p2.timeout</li>
<li><b>Default</b>: 0</li>
</ul><hr /></section><section>
<h4><a name="a.3Cformats.3E"></a><b><a name="formats">&lt;formats&gt;</a></b></h4>
<div>
<p>Maps os to format. By default a zip file will be created. For
example, the following configuration will create tar.gz product
archives for Linux</p>
<div>
<pre>
&lt;formats&gt;
&lt;linux&gt;tar.gz&lt;/linux&gt;
&lt;/formats&gt;
</pre></div>
Supported formats
<ul>
<li>zip</li>
<li>tar.gz</li>
</ul>
<br />
<br /></div>
<ul>
<li><b>Type</b>: java.util.Map</li>
<li><b>Required</b>: No</li>
</ul><hr /></section><section>
<h4><a name="a.3Cproducts.3E"></a><b><a name="products">&lt;products&gt;</a></b></h4>
<div>
<p>Selection of products to be installed and configuration per
product.</p>
<p>If the project contains more than one product file, you need to
choose for which ones you want to create distribution archives. If
you choose to install more than one product, you need to specify
the attachId (which becomes a part of the classifier) to
make the classifiers unique. Example:</p>
<div>
<pre>
&lt;plugin&gt;
&lt;groupId&gt;org.eclipse.tycho&lt;/groupId&gt;
&lt;artifactId&gt;tycho-p2-director-plugin&lt;/artifactId&gt;
&lt;version&gt;${tycho-version}&lt;/version&gt;
&lt;executions&gt;
&lt;execution&gt;
&lt;id&gt;create-distributions&lt;/id&gt;
&lt;goals&gt;
&lt;goal&gt;materialize-products&lt;/goal&gt;
&lt;goal&gt;archive-products&lt;/goal&gt;
&lt;/goals&gt;
&lt;/execution&gt;
&lt;/executions&gt;
&lt;configuration&gt;
&lt;products&gt;
&lt;product&gt;
&lt;!-- select product with ID product.id; the archives get the classifiers &quot;&lt;os&gt;.&lt;ws&gt;.&lt;arch&gt;&quot; --&gt;
&lt;id&gt;product.id&lt;/id&gt;
&lt;/product&gt;
&lt;product&gt;
&lt;!-- select product with ID other.product.id for the classifiers &quot;other-&lt;os&gt;.&lt;ws&gt;.&lt;arch&gt;&quot; --&gt;
&lt;id&gt;other.product.id&lt;/id&gt;
&lt;attachId&gt;other&lt;/attachId&gt;
&lt;/product&gt;
&lt;/products&gt;
&lt;/configuration&gt;
&lt;/plugin&gt;
</pre></div>
The following snippet shows the optional parameters which can be
specified per product:
<div>
<pre>
&lt;configuration&gt;
&lt;products&gt;
&lt;product&gt;
&lt;id&gt;product.id&lt;/id&gt;
&lt;!-- optional parameters --&gt;
&lt;rootFolder&gt;&lt;/rootFolder&gt;
&lt;rootFolders&gt;
&lt;macosx&gt;&lt;/macosx&gt;
&lt;linux&gt;&lt;/linux&gt;
&lt;freebsd&gt;&lt;/freebsd&gt;
&lt;win32&gt;&lt;/win32&gt;
&lt;/rootFolders&gt;
&lt;/product&gt;
...
&lt;/products&gt;
&lt;/configuration&gt;
</pre></div>
Details on the product-specific configuration parameters:
<ul>
<li>rootFolder - The path where the installed product
shall be stored in the archive, e.g. &quot;eclipse&quot;. By default, the
product is stored in the archive root.</li>
<li>rootFolders - OS-specific installation root folders,
overriding rootFolder. Allowed children are
&lt;macosx&gt;, &lt;win32&gt;,
&lt;linux&gt; and &lt;freebsd&gt; or any other OS
supported by p2. Since 0.18.0</li>
</ul></div>
<ul>
<li><b>Type</b>: java.util.List</li>
<li><b>Required</b>: No</li>
</ul>
</section></section>
</section>
</main>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>Copyright &#169; 2008&#x2013;2020<a href="http://www.eclipse.org/">Eclipse Foundation</a>.
.</p>
</div>
</div>
</footer>
</body>
</html>