You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ant.apache.org by hi...@apache.org on 2010/10/27 23:15:05 UTC
svn commit: r1028101 - in /ant/ivy/ivyde/trunk/doc: cpc/jarmapping.html
toc.json
Author: hibou
Date: Wed Oct 27 21:15:03 2010
New Revision: 1028101
URL: http://svn.apache.org/viewvc?rev=1028101&view=rev
Log:
Add some doc about the jar mapping
Added:
ant/ivy/ivyde/trunk/doc/cpc/jarmapping.html
Modified:
ant/ivy/ivyde/trunk/doc/toc.json
Added: ant/ivy/ivyde/trunk/doc/cpc/jarmapping.html
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/cpc/jarmapping.html?rev=1028101&view=auto
==============================================================================
--- 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 @@
+<!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>
+ <script type="text/javascript">var xookiConfig = {level: 1};</script>
+ <script type="text/javascript" src="../xooki/xooki.js"></script>
+</head>
+<body>
+ <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 other.
+
+<h1>Finding jars types</h1>
+
+There are three types of jars handled by Eclipse:
+<ul>
+ <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>
+</ul>
+
+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:
+<ul>
+ <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>
+</ul>
+
+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:
+<ul>
+<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>
+</ul>
+
+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>
+</body>
+</html>
Modified: ant/ivy/ivyde/trunk/doc/toc.json
URL: http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/toc.json?rev=1028101&r1=1028100&r2=1028101&view=diff
==============================================================================
--- 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": [
+
+ ]
+ },
+ {
"id":"cpc/cleancache",
"title":"Clean the caches",
"children": [