notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

r1380 - in trunk/main/central/src/docs: depot depot/tools depot/tools/processors depot/tools/templates metro

From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
To: notify-dpml AT lists.ibiblio.org
Subject: r1380 - in trunk/main/central/src/docs: depot depot/tools depot/tools/processors depot/tools/templates metro
Date: Wed, 19 Apr 2006 06:35:49 +0200

Author: mcconnell
Date: 2006-04-19 06:35:12 +0200 (Wed, 19 Apr 2006)
New Revision: 1380

Added:
trunk/main/central/src/docs/depot/tools/processors/
Removed:
trunk/main/central/src/docs/depot/tools/listeners/
Modified:
trunk/main/central/src/docs/depot/navigation.xml
trunk/main/central/src/docs/depot/tools/index.xml
trunk/main/central/src/docs/depot/tools/navigation.xml
trunk/main/central/src/docs/depot/tools/processors/index.xml
trunk/main/central/src/docs/depot/tools/processors/jar.xml
trunk/main/central/src/docs/depot/tools/processors/module.xml
trunk/main/central/src/docs/depot/tools/processors/plugin.xml
trunk/main/central/src/docs/depot/tools/templates/index.xml
trunk/main/central/src/docs/metro/navigation.xml
Log:
doc updates

Modified: trunk/main/central/src/docs/depot/navigation.xml
===================================================================
--- trunk/main/central/src/docs/depot/navigation.xml 2006-04-18 18:09:02
UTC (rev 1379)
+++ trunk/main/central/src/docs/depot/navigation.xml 2006-04-19 04:35:12
UTC (rev 1380)
@@ -27,8 +27,8 @@
<menu>
<item name="Overview" href="concepts/index.html"/>
<item name="Library Directive" href="library/index.html"/>
- <item name="Builder" href="tools/index.html"/>
- <item name="Ant" href="tasks/index.html"/>
+ <item name="Ant Builder" href="tools/index.html"/>
+ <item name="Ant Tasks" href="tasks/index.html"/>
<item name="CLI" href="cli/index.html"/>
</menu>

Modified: trunk/main/central/src/docs/depot/tools/index.xml
===================================================================
--- trunk/main/central/src/docs/depot/tools/index.xml 2006-04-18 18:09:02
UTC (rev 1379)
+++ trunk/main/central/src/docs/depot/tools/index.xml 2006-04-19 04:35:12
UTC (rev 1380)
@@ -9,19 +9,70 @@

<body>

- <section name="Builder Plugin">
-
+ <section name="Ant Builder Plugin">
+
<p>
- The Depot Library <a href="../cli/index.html">CLI handler</a> will
- resolve a builder plugin using the property
<tt>project.builder.uri</tt>.
- The Depot-on-Ant-Builder Plugin is an example of a build system based
on the
- Apache Ant product. The plugin class
<tt>net.dpml.tools.impl.StandardBuilder</tt>
- handles the establishment and configuration of a Ant Project using
information
- from a <a href="../library/projects.html">project</a> definition. The
plugin
- creates a local <a href="context.html">Context</a> object which
provides
- convinient access to project related information such as classpaths,
file
- locations, and project related properties.
+ The Depot <tt><a href="../cli/index.html">build</a></tt> tool loads a
+ plugin to handle project build requests using the property
<tt>project.builder.uri</tt>.
+ The default builder plugin
(<tt>net.dpml.tools.impl.StandardBuilder</tt>) is an
+ application that dynamically establishes and populates an Ant project
based on
+ information obtained from a <a
href="../library/projects.html">project</a>
+ definition within the common library. The plugin creates a local
+ <a href="context.html">Context</a> object which provides convinient
access to
+ project related information such as classpaths, file locations, and
project
+ related properties.
</p>
+
+ <p>
+ During Ant project initialization the following actions are undertaken:
+ </p>
+
+ <table>
+ <tr>
+ <td>basedir</td>
+ <td>
+ The Ant project basedir is assigned the value of the Depot project
basedir.
+ </td>
+ </tr>
+ <tr>
+ <td>template</td>
+ <td>
+ A build template is assigned from which formal build phased are
established
+ The default template declares initialization, preparation, build,
packaging,
+ validation and installation targets (which in turn trigger
additional build
+ functionality via processors declared within the builder
configuration).
+ </td>
+ </tr>
+ <tr>
+ <td>properties</td>
+ <td>
+ Properties associated (or inherited by) the Depot project defintion
+ are mapped to properties in a new Ant project.
+ </td>
+ </tr>
+ <tr>
+ <td>filters</td>
+ <td>
+ Filters declared in the current project are mapped to global
filters in
+ the underlying ant project.
+ </td>
+ </tr>
+ <tr>
+ <td>paths</td>
+ <td>
+ Compilation and test phase paths are constructed based on the
dependencies
+ declared in the Depot project defintion.
+ </td>
+ </tr>
+ <tr>
+ <td>listeners</td>
+ <td>
+ Build-listeners registered in the builder configuration are
loaded, sorted
+ with respect to listener dependencies, and attached to the Ant
project.
+ </td>
+ </tr>
+ </table>
+

<p>
From a technical perspective the project definition provides sufficent
information

Modified: trunk/main/central/src/docs/depot/tools/navigation.xml
===================================================================
--- trunk/main/central/src/docs/depot/tools/navigation.xml 2006-04-18
18:09:02 UTC (rev 1379)
+++ trunk/main/central/src/docs/depot/tools/navigation.xml 2006-04-19
04:35:12 UTC (rev 1380)
@@ -27,7 +27,7 @@
<menu>
<item name="Context" href="context.html"/>
<item name="Templates" href="templates/index.html"/>
- <item name="Listeners" href="listeners/index.html"/>
+ <item name="Processors" href="processors/index.html"/>
</menu>

</body>

Copied: trunk/main/central/src/docs/depot/tools/processors (from rev 1378,
trunk/main/central/src/docs/depot/tools/listeners)

Modified: trunk/main/central/src/docs/depot/tools/processors/index.xml
===================================================================
--- trunk/main/central/src/docs/depot/tools/listeners/index.xml 2006-04-17
01:12:05 UTC (rev 1378)
+++ trunk/main/central/src/docs/depot/tools/processors/index.xml
2006-04-19 04:35:12 UTC (rev 1380)
@@ -9,27 +9,24 @@

<body>

- <section name="Listeners">
+ <section name="Processors">

<p>
During project initialization the product definition is consulted to
determin the resource types that the project produces. Using the
- builder configuration, listeners are selected, sorted, and assigned to
+ builder configuration, processors are selected, sorted, and assigned
to
current ant project to handle type production.
</p>

<subsection name="Technical Note">

<p>
- The APIs relating to listener declaration should be considered as
+ The APIs relating to processor declaration should be considered as
non-final. In effect there is the need for model improvements
- to support the declaration of listeners that don't produce a specific
+ to support the declaration of processors that don't produce a
specific
type but instead are involved in the contribution to type production.
For example - a listener dealing with rmic compilation does not
itself
produce an build artifact but could contribute to a jar process.
- Secondly, there may be benefits in defining a more specific listener
- interface that deals with build phases as opposed to the more
generic
- Ant BuildListener.
</p>

</subsection>

Modified: trunk/main/central/src/docs/depot/tools/processors/jar.xml
===================================================================
--- trunk/main/central/src/docs/depot/tools/listeners/jar.xml 2006-04-17
01:12:05 UTC (rev 1378)
+++ trunk/main/central/src/docs/depot/tools/processors/jar.xml 2006-04-19
04:35:12 UTC (rev 1380)
@@ -11,7 +11,7 @@
<section name="Jar Processor">

<p>
- The jar processor is a build listener than handles the production of
+ The jar processor is a build processor than handles the production of
jar file.
</p>

Modified: trunk/main/central/src/docs/depot/tools/processors/module.xml
===================================================================
--- trunk/main/central/src/docs/depot/tools/listeners/module.xml
2006-04-17 01:12:05 UTC (rev 1378)
+++ trunk/main/central/src/docs/depot/tools/processors/module.xml
2006-04-19 04:35:12 UTC (rev 1380)
@@ -10,7 +10,7 @@
<section name="Module Processor">

<p>
- The module processor is a build listener than handles the production of
+ The module processor handles the production of
a module descriptor suitable for publication and reference by external
projects.
</p>
@@ -25,7 +25,7 @@
<td>
Creates a module descriptor during which all project defintions
are encoded as resource defintions. The generated file is an
- XML document that contains the encoded form of the
+ XML document that contains an XML description of the
<tt>net.dpml.library.info.ModuleDirective</tt> class.
</td>
</tr>

Modified: trunk/main/central/src/docs/depot/tools/processors/plugin.xml
===================================================================
--- trunk/main/central/src/docs/depot/tools/listeners/plugin.xml
2006-04-17 01:12:05 UTC (rev 1378)
+++ trunk/main/central/src/docs/depot/tools/processors/plugin.xml
2006-04-19 04:35:12 UTC (rev 1380)
@@ -10,8 +10,7 @@
<section name="Plugin Processor">

<p>
- The plugin processor is a build listener than handles the production of
- a Transit plugin descriptor.
+ The plugin processor handles the production of a Transit part
descriptor.
</p>

<table>
@@ -24,7 +23,7 @@
<td>
Create a plugin descriptor using runtime dependencies declared
on
the current project definition. The produced plugin is created
- under the <tt>${basedir}/target/deliverables/plugins</tt>
directory.
+ under the <tt>${basedir}/target/deliverables/parts</tt>
directory.
</td>
</tr>
</table>

Modified: trunk/main/central/src/docs/depot/tools/templates/index.xml
===================================================================
--- trunk/main/central/src/docs/depot/tools/templates/index.xml 2006-04-18
18:09:02 UTC (rev 1379)
+++ trunk/main/central/src/docs/depot/tools/templates/index.xml 2006-04-19
04:35:12 UTC (rev 1380)
@@ -98,7 +98,7 @@
<tr>
<td>install</td>
<td>test</td>
- <td>Validates that the build has produced the artifacts
declatred under the
+ <td>Validates that the build has produced the artifacts declared
under the
project defintion and copies these to the local cache.</td>
</tr>
<tr>

Modified: trunk/main/central/src/docs/metro/navigation.xml
===================================================================
--- trunk/main/central/src/docs/metro/navigation.xml 2006-04-18 18:09:02
UTC (rev 1379)
+++ trunk/main/central/src/docs/metro/navigation.xml 2006-04-19 04:35:12
UTC (rev 1380)
@@ -28,7 +28,7 @@
<item name="Overview" href="concepts/index.html"/>
<item name="Directives" href="directives/index.html"/>
<item name="Runtime" href="runtime/index.html"/>
- <item name="Ant" href="tasks/index.html"/>
+ <item name="Ant Tasks" href="tasks/index.html"/>
<item name="CLI" href="cli/index.html"/>
</menu>

r1380 - in trunk/main/central/src/docs: depot depot/tools depot/tools/processors depot/tools/templates metro, mcconnell at BerliOS, 04/19/2006