You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by mc...@apache.org on 2004/06/21 15:09:31 UTC

svn commit: rev 21538 - in avalon/trunk/central/site/src/xdocs/central/tools/magic: . tasks/production templates

Author: mcconnell
Date: Mon Jun 21 06:09:31 2004
New Revision: 21538

Modified:
   avalon/trunk/central/site/src/xdocs/central/tools/magic/index.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/bar.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/install.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/javac.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/junit.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/index.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/reactor.xml
Log:
more docs

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/index.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/index.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/index.xml	Mon Jun 21 06:09:31 2004
@@ -11,14 +11,14 @@
 
       <p class="caption">
         <i>"any sufficiently advanced technology is 
-        indistinguishable from magic"<br/>
-        Sir Arthur C Clarke.</i>
+        indistinguishable from magic"</i><br/>
+        Sir Arthur C Clarke.
       </p>
 
       <p>
       Avalon Magic is a build system based on Apache
       <a href="http://ant.apache.org">Ant</a>.  It provides 
-      a <a href="model.index.html">project model</a> abstraction 
+      a <a href="model/index.html">project model</a> abstraction 
       layer enabling centralized version and dependency management, 
       build task automation, and dynamic plugin management.
       </p>

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/bar.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/bar.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/bar.xml	Mon Jun 21 06:09:31 2004
@@ -16,7 +16,7 @@
       </p>
       <p>
       The bar file content is created using ${basedir}/target/deliverables
-      as the input data.
+      as the input data.  An md5 file is automatically generated.
       </p>
 <source><![CDATA[
 <x:bar/>

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/install.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/install.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/install.xml	Mon Jun 21 06:09:31 2004
@@ -9,10 +9,16 @@
   <body>
     <section name="Install Task">
       <p>
+      The install task copies the content of ${basedir}/target/deliverables
+      into the working repository cache.
       </p>
 <source><![CDATA[
-    <x:install/>
+<x:install/>
 ]]></source>
+
+<pre>[x:install] installing deliverables
+     [copy] Copying 4 files to F:\.avalon\repository\avalon\tools</pre>
+
     </section>
   </body>
 

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/javac.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/javac.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/javac.xml	Mon Jun 21 06:09:31 2004
@@ -14,6 +14,12 @@
       in build/main excluding java sources and package.html files 
       are copied to the classes directory along with all files
       from the target/build/etc/main directory.
+      </p>
+      <p>
+      The classpath used for compilation will be constructed 
+      automatically based on build dependencies (and dependent 
+      project transitive dependencies) derived from the project
+      model.
       </p>
 <source><![CDATA[
 <x:javac/>

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/junit.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/junit.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/junit.xml	Mon Jun 21 06:09:31 2004
@@ -9,10 +9,37 @@
   <body>
     <section name="JUnit Task">
       <p>
-      </p>
-<source><![CDATA[
-    <x:junit/>
+      The junit task handles unit test compilation, execution and reporting.  The 
+      classpaths used for compilation is derived automatically from the project model
+      using the TEST dependents.  The deliverable jar assoiated with the project is 
+      added to the test compilation path to create the final test execution classpath. 
+      </p>
+
+<source><![CDATA[<x:junit/>
 ]]></source>
+<pre>test:
+    [mkdir] Created dir: F:\dev\avalon\runtime\activation\impl\target\test\classes
+    [javac] Compiling 4 source files to F:\dev\avalon\runtime\activation\impl\target\test\classes
+    [mkdir] Created dir: F:\dev\avalon\runtime\activation\impl\target\test\temp
+     [copy] Copying 6 files to F:\dev\avalon\runtime\activation\impl\target\test\temp
+    [mkdir] Created dir: F:\dev\avalon\runtime\activation\impl\target\test\reports
+    [junit] Running org.apache.avalon.activation.impl.test.CodeSecurityDisabledTestCase
+    [junit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 5.422 sec
+
+    [junit] Running org.apache.avalon.activation.impl.test.CodeSecurityEnabledTestCase
+    [junit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 15.469 sec
+
+    [junit] Running org.apache.avalon.activation.impl.test.PlaygroundTestCase
+    [junit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 27.156 sec</pre>
+
+    <subsection name="Properties">
+      
+      <p>
+      IN PREPARATION
+      </p>
+
+    </subsection>
+
     </section>
   </body>
 

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/index.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/index.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/index.xml	Mon Jun 21 06:09:31 2004
@@ -10,6 +10,25 @@
 
     <section name="Magic Templates">
 
+      <p>
+      Templates provide the mechanism for the sequencing of magic tasks. A 
+      template is a classic ant build file containing a set of common 
+      build procedures that can be overriden or extended within a particular 
+      project.
+      </p>
+      <p>
+      A typical project build file will import the <a href="standard.html">
+      standard</a> build file as shown below.
+      </p>
+
+<source><![CDATA[
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<project name="avalon-repository-api" default="install" basedir=".">
+  <property file="build.properties"/>
+  <import file="${project.home}/build/standard.xml"/>
+</project>]]></source>
+
     </section>
 
   </body>

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/reactor.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/reactor.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/reactor.xml	Mon Jun 21 06:09:31 2004
@@ -24,32 +24,26 @@
   </target>
 
   <target name="prepare">
-    <x:home/>
     <x:reactor target="prepare"/>
   </target>
 
   <target name="build">
-    <x:home/>
     <x:reactor target="build"/>
   </target>
 
   <target name="package">
-    <x:home/>
     <x:reactor target="package"/>
   </target>
 
   <target name="test">
-    <x:home/>
     <x:reactor target="test"/>
   </target>
 
   <target name="install">
-    <x:home/>
     <x:reactor target="install"/>
   </target>
 
   <target name="default">
-    <x:home/>
     <x:reactor/>
   </target>
 

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org