notify-dpml AT lists.ibiblio.org

Subject: DPML Notify

List archive

r1631 - trunk/central/site/src/docs/depot/tutorials

From: mcconnell at BerliOS <mcconnell AT mail.berlios.de>
To: notify-dpml AT lists.ibiblio.org
Subject: r1631 - trunk/central/site/src/docs/depot/tutorials
Date: Sat, 22 Jul 2006 10:58:02 +0200

Author: mcconnell
Date: 2006-07-22 10:58:01 +0200 (Sat, 22 Jul 2006)
New Revision: 1631

Modified:
trunk/central/site/src/docs/depot/tutorials/automation.xml
trunk/central/site/src/docs/depot/tutorials/complex.xml
trunk/central/site/src/docs/depot/tutorials/filters.xml
trunk/central/site/src/docs/depot/tutorials/imports.xml
trunk/central/site/src/docs/depot/tutorials/index.xml
trunk/central/site/src/docs/depot/tutorials/navigation.xml
trunk/central/site/src/docs/depot/tutorials/properties.xml
trunk/central/site/src/docs/depot/tutorials/symbolic.xml
trunk/central/site/src/docs/depot/tutorials/types.xml
trunk/central/site/src/docs/depot/tutorials/unit.xml
Log:
housekeeping

Modified: trunk/central/site/src/docs/depot/tutorials/automation.xml
===================================================================
--- trunk/central/site/src/docs/depot/tutorials/automation.xml 2006-07-22
08:22:35 UTC (rev 1630)
+++ trunk/central/site/src/docs/depot/tutorials/automation.xml 2006-07-22
08:58:01 UTC (rev 1631)
@@ -41,7 +41,7 @@
<subsection name="Building the project ..">

<pre>
-$ cd central\tutorials\tooling\simple\automation
+$ cd central\tutorials\tooling\automation
$ build

-------------------------------------------------------------------------
@@ -51,17 +51,17 @@
init:

prepare:
-[x:prepare] Created dir: D:\dpml\tutorials\tooling\simple\automation\target
-[x:prepare] Created dir:
D:\dpml\tutorials\tooling\simple\automation\target\build\main
-[x:prepare] Copying 1 file to
D:\dpml\central\tooling\simple\automation\target\build\main
+[x:prepare] Created dir: D:\dpml\tutorials\tooling\automation\target
+[x:prepare] Created dir:
D:\dpml\tutorials\tooling\automation\target\build\main
+[x:prepare] Copying 1 file to
D:\dpml\central\tooling\automation\target\build\main

build:
- [javac] Created dir:
D:\dpml\tutorials\tooling\simple\automation\target\classes\main
- [javac] Compiling 1 source file to
D:\dpml\tutorials\tooling\simple\automation\target\classes\main
+ [javac] Created dir:
D:\dpml\tutorials\tooling\automation\target\classes\main
+ [javac] Compiling 1 source file to
D:\dpml\tutorials\tooling\automation\target\classes\main

package:
- [jar] Created dir:
D:\dpml\tutorials\tooling\simple\automation\target\deliverables\jars
- [jar] Building jar:
D:\dpml\tutorials\tooling\simple\automation\target\deliverables\jars\demo-SNAPSHOT.jar
+ [jar] Created dir:
D:\dpml\tutorials\tooling\automation\target\deliverables\jars
+ [jar] Building jar:
D:\dpml\tutorials\tooling\automation\target\deliverables\jars\demo-SNAPSHOT.jar
[jar] Creating md5 checksum

test:

Modified: trunk/central/site/src/docs/depot/tutorials/complex.xml
===================================================================
--- trunk/central/site/src/docs/depot/tutorials/complex.xml 2006-07-22
08:22:35 UTC (rev 1630)
+++ trunk/central/site/src/docs/depot/tutorials/complex.xml 2006-07-22
08:58:01 UTC (rev 1631)
@@ -194,11 +194,15 @@
and how these dependencyt declarations impact build sequencing. In
practice
you will not generally need build-time dependency declarations -
instead it
is much more common to see runtime dependencies linking projects
together, and
- its within runtime depedencies that we can do things like automatic
classpath
- construction. The <a href="runtime.html">following tutorial</a>
focuses on
- runtime dependencies and demonstrates how an API defined in one
project can be
- automatically included in the classpath of a dependent project.
- 
+ its within runtime depedencies that we can do things like automatic
classloader
+ chain construction.
+ 
+
+ 
+ The <a href="modules.html">following tutorial</a> introduces the use
of modules
+ as a mechanisms through which we can improve resource name
management and
+ reduce the potential for naming conflicts.
+ 

</subsection>

Modified: trunk/central/site/src/docs/depot/tutorials/filters.xml
===================================================================
--- trunk/central/site/src/docs/depot/tutorials/filters.xml 2006-07-22
08:22:35 UTC (rev 1630)
+++ trunk/central/site/src/docs/depot/tutorials/filters.xml 2006-07-22
08:58:01 UTC (rev 1631)
@@ -89,7 +89,7 @@
<subsection name="Building the project ..">

<pre>
-$ cd tutorials\tooling\simple\filters
+$ cd tutorials\tooling\filters
$ build

-------------------------------------------------------------------------
@@ -101,10 +101,10 @@
clean:

build:
- [mkdir] Created dir: D:\dpml\tutorials\tooling\simple\filters\target
- [copy] Copying 1 file to D:\dpml\tutorials\tooling\simple\filters\target
+ [mkdir] Created dir: D:\dpml\tutorials\tooling\filters\target
+ [copy] Copying 1 file to D:\dpml\tutorials\tooling\filters\target
[echo]
- [echo] The message is Hello for mcconnell in New York.
+ [echo] The message is Hello from mcconnell in New York.

install:

@@ -129,8 +129,8 @@



- The <a href="../complex/index.html">next totorial</a> introduces the
subject
- of multi-project build sequencing.
+ The <a href="types.html">next totorial</a> introduces type
production
+ declarations in a project definition.


</subsection>

Modified: trunk/central/site/src/docs/depot/tutorials/imports.xml
===================================================================
--- trunk/central/site/src/docs/depot/tutorials/imports.xml 2006-07-22
08:22:35 UTC (rev 1630)
+++ trunk/central/site/src/docs/depot/tutorials/imports.xml 2006-07-22
08:58:01 UTC (rev 1631)
@@ -74,7 +74,7 @@


<pre>
-$ cd tutorials\tooling\simple\import
+$ cd tutorials\tooling\import
$ build -list -expand

Listing project: demo
@@ -82,7 +82,7 @@
project:demo#SNAPSHOT

version: SNAPSHOT
- basedir: D:\dpml\tutorials\tooling\simple\import
+ basedir: D:\dpml\tutorials\tooling\import
types: (1)
jar
test providers: (6)

Modified: trunk/central/site/src/docs/depot/tutorials/index.xml
===================================================================
--- trunk/central/site/src/docs/depot/tutorials/index.xml 2006-07-22
08:22:35 UTC (rev 1630)
+++ trunk/central/site/src/docs/depot/tutorials/index.xml 2006-07-22
08:58:01 UTC (rev 1631)
@@ -8,6 +8,132 @@

<body>

+ <section name="Setting up an Index">
+
+ 
+ The Depot build system centralizes information about projects in
+ an index file. This tutorial demonstrates the declaration of a single
+ project and serves as a starting point for the introduction of
+ properties and filters.
+ 
+
+ <subsection name="index.xml">
+
+ 
+ The following index file declares a single project named 'demo'.
+ The basedir of the project is the directory containing the project
+ build content and is the path that the Depot tool uses to locate
+ the project's build.xml file. Basedir values are resolved relative
to
+ the basedir of the enclosing entity - in this case the
<tt><index></tt>
+ is the enclosing entity so the basedir is resolved relative to the
+ directory containing the index file.
+ 
+
+<pre><![CDATA[
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<index xmlns="link:xsd:dpml/lang/dpml-module#1.0">
+
+ <project name="demo" basedir="."/>
+
+</index>
+]]></pre>
+
+ </subsection>
+
+ <subsection name="build.xml">
+
+ 
+ The following Ant build file simply logs a message to confirm
+ that it is building. It contains a couple of empty targets
+ (clean and install) which are added simply for consistency (but
+ will be used in subsequent tutorials).
+ 
+
+<pre><![CDATA[
+<project name="demo" default="install">
+
+ <target name="clean">
+ 
+ </target>
+
+ <target name="build">
+ <echo message="Executing the simple project build."/>
+ </target>
+
+ <target name="install" depends="build"/>
+
+</project>
+]]></pre>
+
+ </subsection>
+
+ <subsection name="Building the project ..">
+
+ 
+ Assuming that you have the build file and the index file in a
+ directory and Depot is installed - you should be able to start
+ the build proces using Depot's <tt>build</tt> command as shown
+ below:
+ 
+
+ <pre>
+$ cd tutorials\tooling\simple
+$ build
+
+-------------------------------------------------------------------------
+demo#SNAPSHOT
+-------------------------------------------------------------------------
+
+build:
+ [echo] Executing the simple project build.
+
+BUILD SUCCESSFUL
+Total time: 0 seconds
+
+$
+ </pre>
+
+ </subsection>
+
+ <subsection name="Summary">
+
+ 
+ When we invoked the build command as shown above - the build tool
+ located the index.xml file (by searching from the current directory
+ up the directory tree until the file was found) and located the
+ demo project by matching the current directory with directory
resolved
+ from the project <tt>basedir</tt> attribute. Once the project
defintion
+ is located Depot constructs an internal defintion containing
information
+ about the project name, group, version, properties, filters,
+ dependency information, and information about resources that will be
+ produced by the build process.
+ 
+
+ 
+ The following totorials cover a broad spectrum of Depot features and
+ capabilities.
+ 
+
+ <ul>
+ <li><a href="properties.html">Adding general properties.</a></li>
+ <li><a href="symbolic.html">Using symbolic references.</a></li>
+ <li><a href="filters.html">Declaring global filters.</a></li>
+ <li><a href="types.html">Examines the impact of type production
statements.</a></li>
+ <li><a href="automation.html">Build automation using the Depot
Antlib.</a></li>
+ <li><a href="alias.html">Alias creation and usage.</a></li>
+ <li><a href="unit.html">Automating unit-tests.</a></li>
+ <li><a href="imports.html">Using module imports.</a></li>
+ <li><a href="complex.html">Multiproject builds.</a></li>
+ <li><a href="modules.html">Working with modules.</a></li>
+ <li><a href="export.html">Exporting module defintions.</a></li>
+ <li><a href="versioned.html">Versioned Build.</a></li>
+ </ul>
+
+ </subsection>
+
+ </section>
+
+ 
+
</body>
</document>

Modified: trunk/central/site/src/docs/depot/tutorials/navigation.xml
===================================================================
--- trunk/central/site/src/docs/depot/tutorials/navigation.xml 2006-07-22
08:22:35 UTC (rev 1630)
+++ trunk/central/site/src/docs/depot/tutorials/navigation.xml 2006-07-22
08:58:01 UTC (rev 1631)
@@ -25,7 +25,7 @@
<body>

<menu>
- <item name="Getting Started" href="simple.html"/>
+ <item name="Getting Started" href="index.html"/>
<item name="General Properties" href="properties.html"/>
<item name="Symbolic References" href="symbolic.html"/>
<item name="Global Filters" href="filters.html"/>

Modified: trunk/central/site/src/docs/depot/tutorials/properties.xml
===================================================================
--- trunk/central/site/src/docs/depot/tutorials/properties.xml 2006-07-22
08:22:35 UTC (rev 1630)
+++ trunk/central/site/src/docs/depot/tutorials/properties.xml 2006-07-22
08:58:01 UTC (rev 1631)
@@ -68,7 +68,7 @@
<subsection name="Building the project ..">

<pre>
-$ cd tutorials\tooling\simple\properties
+$ cd tutorials\tooling\properties
$ build

-------------------------------------------------------------------------

Modified: trunk/central/site/src/docs/depot/tutorials/symbolic.xml
===================================================================
--- trunk/central/site/src/docs/depot/tutorials/symbolic.xml 2006-07-22
08:22:35 UTC (rev 1630)
+++ trunk/central/site/src/docs/depot/tutorials/symbolic.xml 2006-07-22
08:58:01 UTC (rev 1631)
@@ -44,7 +44,7 @@
<subsection name="Building the project ..">

<pre>
-$ cd tutorials\tooling\simple\properties
+$ cd tutorials\tooling\symbolic
$ build

-------------------------------------------------------------------------

Modified: trunk/central/site/src/docs/depot/tutorials/types.xml
===================================================================
--- trunk/central/site/src/docs/depot/tutorials/types.xml 2006-07-22
08:22:35 UTC (rev 1630)
+++ trunk/central/site/src/docs/depot/tutorials/types.xml 2006-07-22
08:58:01 UTC (rev 1631)
@@ -149,14 +149,14 @@
-------------------------------------------------------------------------

build:
- [mkdir] Created dir:
D:\dpml\tutorials\tooling\simple\types\target\build\main
- [copy] Copying 1 file to
D:\dpml\tutorials\tooling\simple\types\target\build\main
- [mkdir] Created dir:
D:\dpml\tutorials\tooling\simple\types\target\classes\main
- [javac] Compiling 1 source file to
D:\dpml\tutorials\tooling\simple\types\target\classes\main
+ [mkdir] Created dir: D:\dpml\tutorials\tooling\types\target\build\main
+ [copy] Copying 1 file to
D:\dpml\tutorials\tooling\types\target\build\main
+ [mkdir] Created dir: D:\dpml\tutorials\tooling\types\target\classes\main
+ [javac] Compiling 1 source file to
D:\dpml\tutorials\tooling\types\target\classes\main

package:
- [mkdir] Created dir:
D:\dpml\tutorials\tooling\simple\types\target\deliverables\jars
- [jar] Building jar:
D:\dpml\tutorials\tooling\simple\types\target\deliverables\jars\demo-SNAPSHOT.jar
+ [mkdir] Created dir:
D:\dpml\tutorials\tooling\types\target\deliverables\jars
+ [jar] Building jar:
D:\dpml\tutorials\tooling\types\target\deliverables\jars\demo-SNAPSHOT.jar

install:
[mkdir] Created dir: D:\system\dpml\data\cache\jars

Modified: trunk/central/site/src/docs/depot/tutorials/unit.xml
===================================================================
--- trunk/central/site/src/docs/depot/tutorials/unit.xml 2006-07-22
08:22:35 UTC (rev 1630)
+++ trunk/central/site/src/docs/depot/tutorials/unit.xml 2006-07-22
08:58:01 UTC (rev 1631)
@@ -64,7 +64,7 @@


<pre>
-$ cd tutorials\tooling\simple\testing
+$ cd tutorials\tooling\testing
$ build

-------------------------------------------------------------------------
@@ -74,26 +74,26 @@
init:

prepare:
-[x:prepare] Created dir: D:\dpml\tutorials\tooling\simple\testing\target
-[x:prepare] Created dir:
D:\dpml\tutorials\tooling\simple\testing\target\build\main
-[x:prepare] Copying 1 file to
D:\dpml\tutorials\tooling\simple\testing\target\build\main
-[x:prepare] Created dir:
D:\dpml\tutorials\tooling\simple\testing\target\build\test
-[x:prepare] Copying 1 file to
D:\dpml\tutorials\tooling\simple\testing\target\build\test
-[x:prepare] Created dir: D:\dpml\tutorials\tooling\simple\testing\target\test
+[x:prepare] Created dir: D:\dpml\tutorials\tooling\testing\target
+[x:prepare] Created dir: D:\dpml\tutorials\tooling\testing\target\build\main
+[x:prepare] Copying 1 file to
D:\dpml\tutorials\tooling\testing\target\build\main
+[x:prepare] Created dir: D:\dpml\tutorials\tooling\testing\target\build\test
+[x:prepare] Copying 1 file to
D:\dpml\tutorials\tooling\testing\target\build\test
+[x:prepare] Created dir: D:\dpml\tutorials\tooling\testing\target\test

build:
- [javac] Created dir:
D:\dpml\tutorials\tooling\simple\testing\target\classes\main
- [javac] Compiling 1 source file to
D:\dpml\tutorials\tooling\simple\testing\target\classes\main
- [javac] Created dir:
D:\dpml\tutorials\tooling\simple\testing\target\classes\test
- [javac] Compiling 1 source file to
D:\dpml\tutorials\tooling\simple\testing\target\classes\test
+ [javac] Created dir:
D:\dpml\tutorials\tooling\testing\target\classes\main
+ [javac] Compiling 1 source file to
D:\dpml\tutorials\tooling\testing\target\classes\main
+ [javac] Created dir:
D:\dpml\tutorials\tooling\testing\target\classes\test
+ [javac] Compiling 1 source file to
D:\dpml\tutorials\tooling\testing\target\classes\test

package:
- [jar] Created dir:
D:\dpml\tutorials\tooling\simple\testing\target\deliverables\jars
- [jar] Building jar:
D:\dpml\tutorials\tooling\simple\testing\target\deliverables\jars\demo-SNAPSHOT.jar
+ [jar] Created dir:
D:\dpml\tutorials\tooling\testing\target\deliverables\jars
+ [jar] Building jar:
D:\dpml\tutorials\tooling\testing\target\deliverables\jars\demo-SNAPSHOT.jar
[jar] Creating md5 checksum

test:
- [junit] Created dir:
D:\dpml\tutorials\tooling\simple\testing\target\reports\test
+ [junit] Created dir:
D:\dpml\tutorials\tooling\testing\target\reports\test
[junit] Executing forked test.
[junit] Running org.acme.test.DemoTestCase
[junit] 22/07/2006 16:24:14 org.acme.test.DemoTestCase testTheClock
@@ -105,7 +105,6 @@

BUILD SUCCESSFUL
Total time: 4 seconds</pre>
-

</subsection>

r1631 - trunk/central/site/src/docs/depot/tutorials, mcconnell at BerliOS, 07/22/2006