ant-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hi...@apache.org
Subject svn commit: r1045140 - in /ant/ivy/core/trunk/doc: toc.json use/buildobr.html use/convertmanifest.html
Date Mon, 13 Dec 2010 14:38:58 GMT
Author: hibou
Date: Mon Dec 13 14:38:57 2010
New Revision: 1045140

URL: http://svn.apache.org/viewvc?rev=1045140&view=rev
Log:
Add documentation of the Ivy-OSGi tasks

Added:
    ant/ivy/core/trunk/doc/use/buildobr.html
    ant/ivy/core/trunk/doc/use/convertmanifest.html
Modified:
    ant/ivy/core/trunk/doc/toc.json

Modified: ant/ivy/core/trunk/doc/toc.json
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/toc.json?rev=1045140&r1=1045139&r2=1045140&view=diff
==============================================================================
--- ant/ivy/core/trunk/doc/toc.json (original)
+++ ant/ivy/core/trunk/doc/toc.json Mon Dec 13 14:38:57 2010
@@ -639,6 +639,13 @@
                             ]
                         },
                         {
+                          "id":"use/buildobr",
+                          "title":"buildobr",
+                          "children": [
+
+                            ]
+                        },
+                        {
                           "id":"use/buildnumber",
                           "title":"buildnumber",
                           "children": [
@@ -674,6 +681,13 @@
                             ]
                         },
                         {
+                          "id":"use/convertmanifest",
+                          "title":"convertmanifest",
+                          "children": [
+
+                            ]
+                        },
+                        {
                           "id":"use/convertpom",
                           "title":"convertpom",
                           "children": [

Added: ant/ivy/core/trunk/doc/use/buildobr.html
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/use/buildobr.html?rev=1045140&view=auto
==============================================================================
--- ant/ivy/core/trunk/doc/use/buildobr.html (added)
+++ ant/ivy/core/trunk/doc/use/buildobr.html Mon Dec 13 14:38:57 2010
@@ -0,0 +1,69 @@
+<!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 bunch of jar artifacts, generate
an OBR (OSGi Bundle Repository) descriptor. It could be then used by the <a href="../resolver/obr.html">obr
resolver</a>.
+
+<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 whicch the jars should
be gather recursively</td><td>No</td></tr>
+    <tr><td>basePath</td><td>The base path to which the location
of the jars should be made relative to</td><td>No. Should only be used together
with <tt>baseDir</tt></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}" basePath="${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.
+
+	</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>

Added: ant/ivy/core/trunk/doc/use/convertmanifest.html
URL: http://svn.apache.org/viewvc/ant/ivy/core/trunk/doc/use/convertmanifest.html?rev=1045140&view=auto
==============================================================================
--- ant/ivy/core/trunk/doc/use/convertmanifest.html (added)
+++ ant/ivy/core/trunk/doc/use/convertmanifest.html Mon Dec 13 14:38:57 2010
@@ -0,0 +1,49 @@
+<!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> Convert a MANIFEST.MF into an ivy.ml file
+
+<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>manifest</td><td>the location of the MANIFEST.MF to convert</td><td>Yes</td></tr>
+    <tr><td>ivyFile</td><td>the location of the ivy.xml file to generate</td><td>Yes</td></tr>
+</tbody>
+</table>
+
+<h1>Examples</h1>
+<code type="xml">
+    <ivy:convertmanifest manifest="META-INF/MANIFEST.MF" ivyFile="ivy.xml" />
+</code>
+Just converts a manifest into an ivy.xml file.
+
+	</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>



Mime
View raw message