| <?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:mirror</title> |
| </properties> |
| <body> |
| <section name="tycho-p2-extras:mirror"> |
| <p><strong>Full name</strong>:</p> |
| <p>org.eclipse.tycho.extras:tycho-p2-extras-plugin:1.5.1-SNAPSHOT:mirror</p> |
| <p><strong>Description</strong>:</p> |
| <div>Maven plugin front-end for |
| org.eclipse.equinox.p2.internal.repository.tools.MirrorApplication. |
| Intended as a replacement for the <a |
| href="http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2Fp2_repositorytasks.htm">p2.mirror |
| ant task</a>.</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="#append"><append></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Whether to append to an existing destination repository. Note that |
| appending an IU which already exists in the destination repository |
| will cause the mirror operation to fail.<br/><strong>Default value is</strong>: <code>true</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#compress"><compress></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Whether to compress the destination repository metadata files |
| (artifacts.xml, content.xml).<br/><strong>Default value is</strong>: <code>true</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#currentModuleAsSource"><currentModuleAsSource></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>1.1.0</code></td> |
| <td><p>Whether the current build p2 output should be added as source. |
| Ignored for non-Tycho packaging types. Ignored if |
| <code>targetPlatformAsSource</code> == false;</p><br/><strong>Default value is</strong>: <code>true</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#destination"><destination></a></code></td> |
| <td><code>File</code></td> |
| <td><code>-</code></td> |
| <td>The destination directory to mirror to.<br/><strong>Default value is</strong>: <code>${project.build.directory}/repository</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#filter"><filter></a></code></td> |
| <td><code>Map</code></td> |
| <td><code>-</code></td> |
| <td>Filter properties. In particular, a platform filter can be |
| specified by using keys <code>osgi.os, osgi.ws, osgi.arch</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#followOnlyFilteredRequirements"><followOnlyFilteredRequirements></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Follow only requirements which match the filter specified.<br/><strong>Default value is</strong>: <code>false</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#followStrictOnly"><followStrictOnly></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Set to true if only strict dependencies should be followed. A |
| strict dependency is defined by a version range only including |
| exactly one version (e.g. [1.0.0.v2009, 1.0.0.v2009]). In |
| particular, plugins/features included in a feature are normally |
| required via a strict dependency from the feature to the included |
| plugin/feature.<br/><strong>Default value is</strong>: <code>false</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#ignoreErrors"><ignoreErrors></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>1.1.0</code></td> |
| <td><p>If set to true, mirroring continues to run in the event of an |
| error during the mirroring process and will just log an info |
| message.</p><br/><strong>Default value is</strong>: <code>false</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#includeFeatures"><includeFeatures></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Whether or not to include features.<br/><strong>Default value is</strong>: <code>true</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#includeNonGreedy"><includeNonGreedy></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Whether or not to follow non-greedy requirements.<br/><strong>Default value is</strong>: <code>true</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#includeOptional"><includeOptional></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Whether or not to follow optional requirements.<br/><strong>Default value is</strong>: <code>true</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#includePacked"><includePacked></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Whether or not to include pack200 artifacts.<br/><strong>Default value is</strong>: <code>true</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#ius"><ius></a></code></td> |
| <td><code>List</code></td> |
| <td><code>-</code></td> |
| <td>(Optional) Which IUs to mirror. If omitted, all IUs available in |
| the source repositories will be mirrored. An IU must specify an id |
| and may specify a version. If version is omitted, the latest |
| available version will be queried. By default, IUs required by the |
| specified IUs will also be mirrored. See also |
| <code>followStrictOnly</code>, |
| <code>followOnlyFilteredRequirements</code> , |
| <code>includeOptional</code>, <code>includeNonGreedy</code>, |
| <code>includeFeatures</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#keepNonXzIndexFiles"><keepNonXzIndexFiles></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>0.25.0</code></td> |
| <td><p>If <code>xzCompress</code> is <code>true</code>, whether jar or |
| xml index files should be kept in addition to XZ-compressed index |
| files. This fallback provides backwards compatibility for pre-Mars |
| p2 clients which cannot read XZ-compressed index files.</p><br/><strong>Default value is</strong>: <code>true</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#latestVersionOnly"><latestVersionOnly></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Set to <code>true</code> to filter the resulting set of IUs to only |
| include the latest version of each Installable Unit only. By |
| default, all versions satisfying dependencies are included.<br/><strong>Default value is</strong>: <code>false</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#mirrorMetadataOnly"><mirrorMetadataOnly></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>-</code></td> |
| <td>Whether to mirror metadata only (no artifacts).<br/><strong>Default value is</strong>: <code>false</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#name"><name></a></code></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td>The target repository name.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#source"><source></a></code></td> |
| <td><code>List</code></td> |
| <td><code>-</code></td> |
| <td>Source repositori(es) to mirror from.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#targetPlatformAsSource"><targetPlatformAsSource></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>1.1.0</code></td> |
| <td><p>Whether to add the target-platform content as a source. Ignored |
| for non-Tycho packaging types.</p><br/><strong>Default value is</strong>: <code>false</code>.<br/></td> |
| </tr> |
| <tr> |
| <td><code><a href="#xzCompress"><xzCompress></a></code></td> |
| <td><code>boolean</code></td> |
| <td><code>0.25.0</code></td> |
| <td><p>Add XZ-compressed repository index files. XZ offers better |
| compression ratios esp. for highly redundant file content.</p><br/><strong>Default value is</strong>: <code>true</code>.<br/></td> |
| </tr> |
| </table> |
| </subsection> |
| <subsection name="Parameter Details"> |
| <h4><strong><a name="append"><append></a></strong></h4> |
| <div>Whether to append to an existing destination repository. Note that |
| appending an IU which already exists in the destination repository |
| will cause the mirror operation to fail.</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="compress"><compress></a></strong></h4> |
| <div>Whether to compress the destination repository metadata files |
| (artifacts.xml, content.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="currentModuleAsSource"><currentModuleAsSource></a></strong></h4> |
| <div><p>Whether the current build p2 output should be added as source. |
| Ignored for non-Tycho packaging types. Ignored if |
| <code>targetPlatformAsSource</code> == false;</p></div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Since</strong>: <code>1.1.0</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Default</strong>: <code>true</code></li> |
| </ul><hr/><h4><strong><a name="destination"><destination></a></strong></h4> |
| <div>The destination directory to mirror to.</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}/repository</code></li> |
| </ul><hr/><h4><strong><a name="filter"><filter></a></strong></h4> |
| <div>Filter properties. In particular, a platform filter can be |
| specified by using keys <code>osgi.os, osgi.ws, osgi.arch</code>.</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="followOnlyFilteredRequirements"><followOnlyFilteredRequirements></a></strong></h4> |
| <div>Follow only requirements which match the filter specified.</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="followStrictOnly"><followStrictOnly></a></strong></h4> |
| <div>Set to true if only strict dependencies should be followed. A |
| strict dependency is defined by a version range only including |
| exactly one version (e.g. [1.0.0.v2009, 1.0.0.v2009]). In |
| particular, plugins/features included in a feature are normally |
| required via a strict dependency from the feature to the included |
| plugin/feature.</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="ignoreErrors"><ignoreErrors></a></strong></h4> |
| <div><p>If set to true, mirroring continues to run in the event of an |
| error during the mirroring process and will just log an info |
| message.</p></div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Since</strong>: <code>1.1.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="includeFeatures"><includeFeatures></a></strong></h4> |
| <div>Whether or not to include features.</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="includeNonGreedy"><includeNonGreedy></a></strong></h4> |
| <div>Whether or not to follow non-greedy requirements.</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="includeOptional"><includeOptional></a></strong></h4> |
| <div>Whether or not to follow optional requirements.</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="includePacked"><includePacked></a></strong></h4> |
| <div>Whether or not to include pack200 artifacts.</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="ius"><ius></a></strong></h4> |
| <div>(Optional) Which IUs to mirror. If omitted, all IUs available in |
| the source repositories will be mirrored. An IU must specify an id |
| and may specify a version. If version is omitted, the latest |
| available version will be queried. By default, IUs required by the |
| specified IUs will also be mirrored. See also |
| <code>followStrictOnly</code>, |
| <code>followOnlyFilteredRequirements</code> , |
| <code>includeOptional</code>, <code>includeNonGreedy</code>, |
| <code>includeFeatures</code>.</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="keepNonXzIndexFiles"><keepNonXzIndexFiles></a></strong></h4> |
| <div><p>If <code>xzCompress</code> is <code>true</code>, whether jar or |
| xml index files should be kept in addition to XZ-compressed index |
| files. This fallback provides backwards compatibility for pre-Mars |
| p2 clients which cannot read XZ-compressed index files.</p></div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Since</strong>: <code>0.25.0</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Default</strong>: <code>true</code></li> |
| </ul><hr/><h4><strong><a name="latestVersionOnly"><latestVersionOnly></a></strong></h4> |
| <div>Set to <code>true</code> to filter the resulting set of IUs to only |
| include the latest version of each Installable Unit only. By |
| default, all versions satisfying dependencies are included.</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="mirrorMetadataOnly"><mirrorMetadataOnly></a></strong></h4> |
| <div>Whether to mirror metadata only (no artifacts).</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="name"><name></a></strong></h4> |
| <div>The target repository name.</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="source"><source></a></strong></h4> |
| <div>Source repositori(es) to mirror from.</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="targetPlatformAsSource"><targetPlatformAsSource></a></strong></h4> |
| <div><p>Whether to add the target-platform content as a source. Ignored |
| for non-Tycho packaging types.</p></div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Since</strong>: <code>1.1.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="xzCompress"><xzCompress></a></strong></h4> |
| <div><p>Add XZ-compressed repository index files. XZ offers better |
| compression ratios esp. for highly redundant file content.</p></div> |
| <ul> |
| <li><strong>Type</strong>: <code>boolean</code></li> |
| <li><strong>Since</strong>: <code>0.25.0</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Default</strong>: <code>true</code></li> |
| </ul> |
| </subsection> |
| </section> |
| </body> |
| </document> |
