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/20 19:13:28 UTC

svn commit: rev 21511 - in avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks: . common

Author: mcconnell
Date: Sun Jun 20 10:13:27 2004
New Revision: 21511

Modified:
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/home.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/navigation.xml
Log:
add home task documentation

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/home.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/home.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/home.xml	Sun Jun 20 10:13:27 2004
@@ -6,10 +6,113 @@
     <title>Avalon Central</title>
   </properties> 
 
-  <body>
-    <section name="Home Task">
+  <body>
+
+    <section name="Home Task">
+
       <p>
-      </p>
+      The home task is responsible for the initialization of 
+      the magic environment.  This includes:
+      </p>
+
+      <ul>
+        <li>loading of ${basedir}/user.properties</li>
+        <li>loading of ${basedir}/build.properties</li>
+        <li>loading of ${project.system}/index.properties</li>
+        <li>setup of an artifact repository</li>
+        <li>setup of an doc repository</li>
+        <li>initialization of the project model</li>
+      </ul>
+
+      <subsection name="Property Loading">
+
+      <p>
+      The home task will automatically load properties into the 
+      current project.
+      </p>
+
+      <ul>
+        <li>loading of ${basedir}/user.properties</li>
+        <li>loading of ${basedir}/build.properties</li>
+      </ul>
+
+      <p>
+      If a home has not been loaded then home initialization will 
+      occur relative to ${project.system}.  The default value of 
+      ${project.system} is ${project.home}.  The ${project.system}
+      defines the location of system level properties controlling
+      cache and proxy setup. System properties are defined under the 
+      property file ${project.system}/index.properties.  
+      </p>
+
+      </subsection>
+      <subsection name="Repository Initialization">
+
+      <p>
+      Repositories for build deliverables and documentation are 
+      establish. The default location for the build deliverable
+      repository is defined by the property ${project.main.cache}. 
+      If the value of this property is a relative path it will be
+      resolved relative to ${project.system). If undefined, the 
+      initialization procedure will attempt to locate the environment
+      variable AVALON_HOME and if defined, the AVALON_HOME/repository
+      path will be used.  If AVALON_HOME is undefined, 
+      ${project.system}/.cache will be used.
+      </p>
+
+      <p>
+      The documentation repository currently defaults to 
+      ${project.system}/.docs.
+      </p>
+
+      </subsection>
+      <subsection name="Model Loading">
+
+      <p>
+      The home task loads an index file if not already loaded.
+      If not declared explicity, the index file is located using 
+      ${project.home}/index.xml. A static immutable datastructure 
+      will be created and made available to magic aware tasks.
+      </p>
+
+      </subsection>
+      <subsection name="Usage">
+
+      <p>
+      The following example demonstrates the initialization of 
+      a home using an explicit index file.
+      </p>
+
+<source><![CDATA[
+  <x:home index="../../released-packages.xml"/>
+]]></source>
+
+      <p>
+      The following example demonstrates the initialization of 
+      a home using a default ${project.home}/index.xml.
+      </p>
+
+<source><![CDATA[
+  <property name="project.home" value="../.."/>
+
+  <x:home/>
+]]></source>
+
+      <p>
+      If the index attribute is not declared and ${project.home} 
+      is undefined, a build failure will occur.  
+      </p>
+
+      </subsection>
+      <subsection name="Notes">
+
+      <p>
+      IMPORTANT NOTE : once initialized, a home may not be redefined.
+      Subsequent home references within composite build files will not
+      change an existing home definition.
+      </p>
+
+      </subsection>
     </section>
   </body>
 

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/navigation.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/navigation.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/navigation.xml	Sun Jun 20 10:13:27 2004
@@ -23,9 +23,9 @@
 
  <body>
     <menu>
-      <item name="Common Tasks" href="common/index.html"/>
-      <item name="Production Tasks" href="production/index.html"/>
-      <item name="Publication Tasks" href="publication/index.html"/>
+      <item name="Common" href="common/index.html"/>
+      <item name="Production" href="production/index.html"/>
+      <item name="Publication" href="publication/index.html"/>
     </menu>
  </body>
 

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