ant-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r1028101 - in /ant/ivy/ivyde/trunk/doc: cpc/jarmapping.html toc.json
Date Wed, 27 Oct 2010 21:15:05 GMT
Author: hibou
Date: Wed Oct 27 21:15:03 2010
New Revision: 1028101

Add some doc about the jar mapping


Added: ant/ivy/ivyde/trunk/doc/cpc/jarmapping.html
--- ant/ivy/ivyde/trunk/doc/cpc/jarmapping.html (added)
+++ ant/ivy/ivyde/trunk/doc/cpc/jarmapping.html Wed Oct 27 21:15:03 2010
@@ -0,0 +1,64 @@
+   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
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.    
+	<script type="text/javascript">var xookiConfig = {level: 1};</script>	
+	<script type="text/javascript" src="../xooki/xooki.js"></script>
+	<textarea id="xooki-source">IvyDE will resolve the dependencies and artifacts you
are requiring. Then with the pool of resolved artifacts, it has to decide which is a binary
jar, which contains sources, and which contains javadocs. And also how to bind one on each
+<h1>Finding jars types</h1>
+There are three types of jars handled by Eclipse:
+    <li>the binary jars: they will be added to the classpath in oder to compile and
run; they contain the .class files.</li>
+    <li>the source jars/zip: they will be bound to the binary one to browse dependency
sources; they are basically a zip of .java files</li>
+    <li>the javadoc jars/zip: they will be bound to the binary one to browse the API
documentation of the dependencies of your project; they are a zip of .html files respectin
a layout produced by javadoc.</li>
+To find the binary jars, IvyDE is relying on the "Accepted types" preference field you can
find in the <a href="create.html">container configuration panel</a>, or in the
<a href="../preferences.html#classpath">global one</a>. If the artifact has a
type listed here, it is then added to the classpath.
+For the sources, it is relying on the "Sources types".
+For the javadocs, it is relying on the "Javadocs types".
+<h1>Binding the jars</h1>
+The second step is to bind a source artifact with a binary one. IvyDE has the folowing algorithm:
+    <li>first if a binary jar has the same artifact name than a source one, there are
bound together.</li>
+    <li>if none matched, then IvyDE search for sources which have one of the suffix
specified in "Sources suffixes".</li>
+For instance, searching for the sources of mylib.jar (type=jar), with the default value of
"Sources suffixes" ("-source,-sources,-src"), IvyDE will look to bind it to the first one
existing of:
+<li>mylib.jar (type=source)</li>
+<li>mylib-source.jar (type=source)</li>
+<li>mylib-sources.jar (type=source)</li>
+<li>mylib-src.jar (type=source)</li>
+Note that IvyDE don't care about the extension, it can be .zip too.
+Same apply for javadocs with respectively "Javadocs suffixes".</textarea>
+<script type="text/javascript">xooki.postProcess();</script>

Modified: ant/ivy/ivyde/trunk/doc/toc.json
--- ant/ivy/ivyde/trunk/doc/toc.json (original)
+++ ant/ivy/ivyde/trunk/doc/toc.json Wed Oct 27 21:15:03 2010
@@ -69,6 +69,13 @@
+                    "id":"cpc/jarmapping",
+                    "title":"Jar mapping",
+                    "children": [
+                      ]
+                  },
+                  {
                     "title":"Clean the caches",
                     "children": [

View raw message