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 11:34:23 UTC
svn commit: rev 21532 - in avalon/trunk/central/site/src/xdocs/central/tools/magic: tasks/common tasks/production templates
Author: mcconnell
Date: Mon Jun 21 02:34:23 2004
New Revision: 21532
Added:
avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/init.xml
avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/
avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/index.xml
avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/navigation.xml
avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/reactor.xml
avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/standard.xml
Modified:
avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/clean.xml
avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/home.xml
avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/prepare.xml
avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/navigation.xml
Log:
more docs
Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/clean.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/clean.xml (original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/clean.xml Mon Jun 21 02:34:23 2004
@@ -15,13 +15,13 @@
<x:clean/>
]]></source>
- <p><i>Typical output of the clean task:</i></p>
+ <p><i>Example output of the clean task:</i></p>
-<source><![CDATA[
+<pre>
clean:
[x:clean] removing target directory
[delete] Deleting directory F:\dev\avalon\planet\tutorials\hello\target
-]]></source>
+</pre>
</section>
</body>
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 Mon Jun 21 02:34:23 2004
@@ -35,6 +35,10 @@
<x:home/>
]]></source>
+<pre>
+ [x:home] Building system definition.
+</pre>
+
<subsection name="Property Loading">
<p>
@@ -123,8 +127,25 @@
]]></source>
<p>
- If the index attribute is not declared and ${project.home}
- is undefined, a build failure will occur.
+ A recommended approach is to define ${project.system}
+ and ${project.name} under a build.properties file and
+ use a template build file that includes home establishment
+ and magic related targets as shown below.
+ </p>
+
+<source><![CDATA[
+<project name="avalon-tutorial-hello"
+ default="install" basedir="."
+ xmlns:x="antlib:org.apache.avalon.tools">
+
+ <property file="build.properties"/>
+ <import file="${project.system}/build/standard.xml"/>
+
+</project>
+]]></source>
+
+ <p>
+ If ${project.system} is unresolvable a build failure will occur.
</p>
</subsection>
Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/prepare.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/prepare.xml (original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/prepare.xml Mon Jun 21 02:34:23 2004
@@ -22,24 +22,85 @@
<x:prepare/>
]]></source>
- <p><i>Outline of the directory structure inputs and outputs
- assumed by the prepare task (input directories can be modified
- by project properties).</i></p>
+<pre>
+prepare:
+[x:prepare] creating target directory
+ [mkdir] Created dir: F:\dev\avalon\planet\tutorials\hello\target
+ [mkdir] Created dir: F:\dev\avalon\planet\tutorials\hello\target\build\main
+ [copy] Copying 1 file to F:\dev\avalon\planet\tutorials\hello\target\build\main
+ [mkdir] Created dir: F:\dev\avalon\planet\tutorials\hello\target\build\etc
+ [copy] Copying 2 files to F:\dev\avalon\planet\tutorials\hello\target\build\etc
+ [mkdir] Created dir: F:\dev\avalon\planet\tutorials\hello\target\deliverables
+ [copy] Copying 1 file to F:\dev\avalon\planet\tutorials\hello\target\deliverables
+</pre>
+
+ <p><i>Directory structure inputs.</i></p>
+<source>
+${basedir}
+ /${project.src}
+ /${project.src.main} -- the main java sources copied to target/build/main
+ /${project.src.test} -- unit test sources copied to target/build/test
+ /${project.src.conf} -- configuration data copied to target/build/conf
+ /${project.etc}
+ /main -- resource to be copied to target/build/main
+ /test -- resource to be copied to target/build/test
+ /conf -- resource to be copied to target/build/conf
+ /deliverables -- copied to target/deliverables
+
+</source>
+
+ <p><i>Fixed output directory structure.</i></p>
<source>
${basedir}
- /etc
- /main ---- resource to be copied to target/build/main
- /test ---- resource to be copied to target/build/test
- /src
- /main ---- the main java sources
- /test ---- unit test sources
-
- /target ---- created by prepare
- /build --- build src directory
- /main -- filter sources with etc/main
- /test -- filter sources with etc/test
- /etc -- other etc filtered content
+ /target -- created by prepare
+ /build -- filtered content from ${project.src}
+ /main -- filter content
+ /test -- filter sources with etc/test
+ /conf -- filtered configuration data
+ /etc -- filtered content from ${project.etc}
+ /deliverables -- output artifacts initially populated with
+ the content from /target/etc/deliverables
+ if present
</source>
+
+
+ <subsection name="Properties">
+
+ <p>
+ The following properties may be used to customize the
+ input paths for source content.
+ </p>
+
+ <table>
+ <tr><th>Property</th><th>Description</th></tr>
+ <tr>
+ <td>${project.src}</td>
+ <td>The name of the directory containing the project sources.
+ The default value is "src".</td>
+ </tr>
+ <tr>
+ <td>${project.src.main}</td>
+ <td>The name of the sub-directory with ${project.src} containing
+ the java source hierachy. Default value is "main".</td>
+ </tr>
+ <tr>
+ <td>${project.src.test}</td>
+ <td>The name of the sub-directory with ${project.src} containing
+ the java unit test source hierachy. Default value is "test".</td>
+ </tr>
+ <tr>
+ <td>${project.src.conf}</td>
+ <td>The name of the sub-directory with ${project.src} containing
+ the configuration data. Default value is "conf".</td>
+ </tr>
+ <tr>
+ <td>${project.etc}</td>
+ <td>The name of the directory containing supplimentary resources.
+ The default value is "etc".</td>
+ </tr>
+ </table>
+
+ </subsection>
</section>
</body>
Added: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/init.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/init.xml Mon Jun 21 02:34:23 2004
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+
+ <properties>
+ <author email="dev@avalon.apache.org">Avalon Documentation Team</author>
+ <title>Avalon Central</title>
+ </properties>
+
+ <body>
+ <section name="Init Task">
+ <p>
+ </p>
+<source><![CDATA[
+ <x:init/>
+]]></source>
+ </section>
+ </body>
+
+</document>
+
Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/navigation.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/navigation.xml (original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/navigation.xml Mon Jun 21 02:34:23 2004
@@ -19,10 +19,11 @@
<project>
- <title>Apache Avalon Central</title>
+ <title>Avalon Central</title>
<body>
<menu>
+ <item name="Init" href="init.html"/>
<item name="Javac" href="javac.html"/>
<item name="Jar" href="jar.html"/>
<item name="Bar" href="bar.html"/>
Added: avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/index.xml Mon Jun 21 02:34:23 2004
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+
+ <properties>
+ <author email="dev@avalon.apache.org">Avalon Documentation Team</author>
+ <title>Avalon Central</title>
+ </properties>
+
+ <body>
+
+ <section name="Magic Templates">
+
+ </section>
+
+ </body>
+
+</document>
+
Added: avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/navigation.xml Mon Jun 21 02:34:23 2004
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ Copyright 2004 Apache Software Foundation
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied.
+
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<project>
+
+ <title>Apache Avalon Central</title>
+
+ <body>
+ <menu>
+ <item name="Standard" href="standard.html"/>
+ <item name="Reactor" href="reactor.html"/>
+ </menu>
+ </body>
+
+</project>
Added: avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/reactor.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/reactor.xml Mon Jun 21 02:34:23 2004
@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+
+ <properties>
+ <author email="dev@avalon.apache.org">Avalon Documentation Team</author>
+ <title>Avalon Central</title>
+ </properties>
+
+ <body>
+
+ <section name="Reactor Template">
+<source><![CDATA[
+<?xml version="1.0" encoding="UTF-8" ?>
+<project name="reactor" xmlns:x="antlib:org.apache.avalon.tools">
+
+ <x:home/>
+
+ <target name="init">
+ <x:reactor target="init"/>
+ </target>
+
+ <target name="clean">
+ <x:reactor target="clean"/>
+ </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>
+
+</project>]]></source>
+ </section>
+
+ </body>
+
+</document>
+
Added: avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/standard.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/templates/standard.xml Mon Jun 21 02:34:23 2004
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+
+ <properties>
+ <author email="dev@avalon.apache.org">Avalon Documentation Team</author>
+ <title>Avalon Central</title>
+ </properties>
+
+ <body>
+
+ <section name="Standard Project Template">
+
+<source><![CDATA[
+<?xml version="1.0" encoding="UTF-8" ?>
+<project name="standard" xmlns:x="antlib:org.apache.avalon.tools">
+
+ <x:home/>
+
+ <target name="info">
+ <x:info/>
+ </target>
+
+ <target name="init" depends="info">
+ <x:init/>
+ </target>
+
+ <target name="clean" depends="info">
+ <x:clean/>
+ </target>
+
+ <target name="prepare" depends="init">
+ <x:prepare/>
+ </target>
+
+ <target name="build" depends="prepare">
+ <x:javac/>
+ </target>
+
+ <target name="package" depends="build">
+ <x:jar/>
+ </target>
+
+ <target name="test" depends="package">
+ <x:junit/>
+ </target>
+
+ <target name="install" depends="test">
+ <x:install/>
+ </target>
+
+ <target name="javadoc" depends="prepare">
+ <x:javadoc/>
+ </target>
+
+ <target name="xdoc" depends="prepare">
+ <x:xdoc theme="modern"/>
+ </target>
+
+ <target name="site" depends="javadoc,xdoc"/>
+
+ <target name="dist" depends="install,site"/>
+
+</project>]]></source>
+
+ </section>
+
+ </body>
+
+</document>
+
---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org