Author: hibou
Date: Sun Sep 27 11:28:43 2009
New Revision: 819285
URL: http://svn.apache.org/viewvc?rev=819285&view=rev
Log:
IVYDE-206 : Documentation for Reverse Dependency Explorer (thanks to Jon
Schneider)
Added:
ant/ivy/ivyde/trunk/doc/images/revexplorer_project.jpg (with props)
ant/ivy/ivyde/trunk/doc/images/revexplorer_sync.jpg (with props)
ant/ivy/ivyde/trunk/doc/images/revexplorer_view.jpg (with props)
Modified:
ant/ivy/ivyde/trunk/doc/index.html
ant/ivy/ivyde/trunk/doc/revdepexplorer.html
Added: ant/ivy/ivyde/trunk/doc/images/revexplorer_project.jpg
URL:
http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/revexplorer_project.jpg?rev=819285&view=auto
==============================================================================
Binary file - no diff available.
Propchange: ant/ivy/ivyde/trunk/doc/images/revexplorer_project.jpg
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Added: ant/ivy/ivyde/trunk/doc/images/revexplorer_sync.jpg
URL:
http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/revexplorer_sync.jpg?rev=819285&view=auto
==============================================================================
Binary file - no diff available.
Propchange: ant/ivy/ivyde/trunk/doc/images/revexplorer_sync.jpg
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Added: ant/ivy/ivyde/trunk/doc/images/revexplorer_view.jpg
URL:
http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/images/revexplorer_view.jpg?rev=819285&view=auto
==============================================================================
Binary file - no diff available.
Propchange: ant/ivy/ivyde/trunk/doc/images/revexplorer_view.jpg
------------------------------------------------------------------------------
svn:mime-type = image/jpeg
Modified: ant/ivy/ivyde/trunk/doc/index.html
URL:
http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/index.html?rev=819285&r1=819284&r2=819285&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/index.html (original)
+++ ant/ivy/ivyde/trunk/doc/index.html Sun Sep 27 11:28:43 2009
@@ -30,6 +30,7 @@
<li><a href="settingseditor.html">an Ivy settings files editor</a>: completion
for xml tag, attributes but also attributes' values.</li>
<li><a href="cp_container.html">a classpath container</a>: automatic
downloads, access "resolve" task from your IDE, and <a
href="cpc/workspace.html">resolve in Eclipse's workspace</a></li>
<li><a href="cp_container.html">an Ivy console</a>: presents every log from
Ivy, really helpful to debug a failing resolve</li>
+<li><a href="revdepexplorer.html">an Reverse Dependency Explorer</a>: help you
work with conflicting dependencies amongs several projects</li>
</ul>
And IvyDE can be also used with other plugins like <a
href="cpc/wtp.html">WTP</a> or <a href="ant.html">Ant</a>.
Modified: ant/ivy/ivyde/trunk/doc/revdepexplorer.html
URL:
http://svn.apache.org/viewvc/ant/ivy/ivyde/trunk/doc/revdepexplorer.html?rev=819285&r1=819284&r2=819285&view=diff
==============================================================================
--- ant/ivy/ivyde/trunk/doc/revdepexplorer.html (original)
+++ ant/ivy/ivyde/trunk/doc/revdepexplorer.html Sun Sep 27 11:28:43 2009
@@ -25,7 +25,32 @@
</head>
<body>
<textarea id="xooki-source">
-The reverse dependency explorer turns the dependency tree upside-down,
exploring the workspace by organization, module, and revision and providing a
mechanism to synchronize revisions across projects/classpath
containers.</textarea>
+<h1>Introduction</h1>
+
+When working with multiple projects in a workspace that represent the whole or
part of a larger application, you may want to simultaneously change the
revisions of dependencies in several ivy files to a single new revision all at
the same time (notwithstanding the eviction mechanism inherent to Ivy).
+
+At other times it is instructive just to see what dependencies are being
utilized by projects in the workspace by revision without having to dig into
each project and look at each individual module descriptor.
+
+The Reverse Dependency Explorer turns the dependency tree upside-down,
exploring the workspace by organization, module, and revision and providing a
mechanism to synchronize revisions across projects/classpath containers.
+
+Consider the following workspace, with three projects, all of which have an
ivy.xml file at their project root. Each of these ivy files has an associated
IvyDE managed classpath container.
+
+<center><img src="images/revexplorer_project.jpg"></center><br/>
+
+Right clicking on any (or all) of the projects and selecting Ivy -> Reverse
Dependency Explorer opens the view. The explorer displays a tree structure
with an item for each organization/module pair. The third column lists all of
the revisions of this pair for the selected projects. Expanding a tree item,
you can see the module revision that a given ivy classpath container depends on
(if at all). Note that the view only shows direct dependencies and no
transitive dependencies.
+
+<center><img src="images/revexplorer_view.jpg"></center><br/>
+
+Organization/module pairs that have conflicting revisions are highlighted in
red (junit in the above example). Note that in the above example, though the
revisions do not match, these two revision attributes may actually resolve to
the same artifact, depending on the what is available in the repository. The
view does not attempt to perform a resolve and match the resolved artifacts.
It simply compares the text of the attributes.
+
+<h1>Synchronizing revisions</h1>
+
+To synchronize revisions, click in column and row of the item you want to
change and type in the new revision. The item should be highlighted green to
indicate that it is tagged for synchronization. Click the synchronize button
as shown to make your changes.
+
+<center><img src="images/revexplorer_sync.jpg"></center><br/>
+
+
+</textarea>
<script type="text/javascript">xooki.postProcess();</script>
</body>
</html>
