mirror of https://github.com/apache/ant-ivy
92 lines
4.7 KiB
HTML
92 lines
4.7 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<!--
|
|
Licensed to the Apache Software Foundation (ASF) under one
|
|
or more contributor license agreements. See the NOTICE file
|
|
distributed with this work for additional information
|
|
regarding copyright ownership. The ASF licenses this file
|
|
to you under the Apache License, Version 2.0 (the
|
|
"License"); you may not use this file except in compliance
|
|
with the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing,
|
|
software distributed under the License is distributed on an
|
|
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
KIND, either express or implied. See the License for the
|
|
specific language governing permissions and limitations
|
|
under the License.
|
|
-->
|
|
<html>
|
|
<head>
|
|
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
|
|
<script type="text/javascript">var xookiConfig = {level: 1};</script>
|
|
<script type="text/javascript" src="../xooki/xooki.js"></script>
|
|
</head>
|
|
<body>
|
|
<textarea id="xooki-source">
|
|
<span class="since">since 2.3</span> From a set of jar artifacts, this task generates an OBR (OSGi Bundle Repository) descriptor. It could be then used by the <a href="../resolver/obr.html">obr resolver</a>.
|
|
|
|
The set of jars which will be described by the OBR can be defined in 4 exclusive ways:
|
|
<ul>
|
|
<li>via an Ivy resolver: every jar listed by the resolver will be taken into account</li>
|
|
<li>by defining a root directory: every jar found recursively in that folder will be taken into account</li>
|
|
<li>via the name of an Ivy cache: every artifact contained in the cache will be taken into account</li>
|
|
<li><span class="since">since 2.4</span> via a resolve: this task is a [[ant:postresolvetask post resolve task]] (with all the behaviour and attributes common to all post resolve tasks), thus ever artifact which has been resolved will be taken into account; it is especially useful for building a <a href="../osgi/target-platform.html">target platform</a></li>
|
|
</ul>
|
|
|
|
NB: among every listed files or artifacts, only the actually OSGi bundles will be described by the OBR descriptor; the other files are ignored.
|
|
|
|
<h1>Attributes</h1>
|
|
|
|
<span class="since">since 2.4</span> This is a [[ant:postresolvetask post resolve task]], with all the behaviour and attributes common to all post resolve tasks.
|
|
|
|
<table class="ant">
|
|
<thead>
|
|
<tr><th class="ant-att">Attribute</th><th class="ant-desc">Description</th><th class="ant-req">Required</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr><td>out</td><td>the location of the descriptor file to generate</td><td>Yes</td></tr>
|
|
<tr><td>resolverName</td><td>the name of the resolver from which the jars should be to gathered</td><td>No</td></tr>
|
|
<tr><td>cacheName</td><td>the name of the cache from which the jars should be to gathered</td><td>No</td></tr>
|
|
<tr><td>baseDir</td><td>the folder into which the jars should be gather recursively</td><td>No</td></tr>
|
|
<tr><td>sourceType</td><td>if used as a post resolve task, 'sourceType' define the type of artifacts which should be considered as source artifacts (defaults to 'source,sources,src')</td><td>No</td></tr>
|
|
<tr><td>encoding</td><td>The encoding of the resulting xml file</td><td>No. Defaults to <tt>UTF-8</tt></td></tr>
|
|
<tr><td>indent</td><td>Specify if the xml result file should be indented</td><td>No. Defaults to <tt>true</tt></td></tr>
|
|
<tr><td>quiet</td><td>Log as debug rather than warning the rejected jars as they are illformed</td><td>No. Defaults to <tt>false</tt></td></tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<h1>Examples</h1>
|
|
<code type="xml">
|
|
<ivy:buildobr baseDir="${eclipse.home}" out="${basedir}/target/repo-eclipse.xml" indent="true" />
|
|
</code>
|
|
Builds an indented OBR descriptor from an Eclipse install, with their path relative to the Eclipse install.
|
|
|
|
<hr/>
|
|
<code type="xml">
|
|
<ivy:configure file="ivysettings.xml" />
|
|
<ivy:buildobr resolverName="my-file-resolver" out="${basedir}/target/repo-eclipse.xml" />
|
|
</code>
|
|
Configure an Ivy settings and builds an OBR descriptor from jars resolved by the defined resolver.
|
|
|
|
<hr/>
|
|
<code type="xml">
|
|
<ivy:configure file="ivysettings.xml" />
|
|
<ivy:buildobr cacheName="my-cache" out="${basedir}/target/repo-eclipse.xml" />
|
|
</code>
|
|
Configure an Ivy settings and builds an OBR descriptor from jars contained in the defined cache.
|
|
|
|
<hr/>
|
|
<code type="xml">
|
|
<ivy:configure file="ivysettings.xml" />
|
|
<ivy:resolve file="ivy.xml" />
|
|
<ivy:buildobr out="${basedir}/target-platform-obr.xml" />
|
|
</code>
|
|
Launch a resolve and then build an obr.xml describing the resolved artifacts.
|
|
|
|
</textarea>
|
|
<script type="text/javascript">xooki.postProcess();</script>
|
|
</body>
|
|
</html>
|