You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by br...@apache.org on 2004/04/12 21:24:42 UTC
svn commit: rev 9974 - xml/forrest/trunk/src/documentation/content/xdocs
Author: brondsem
Date: Mon Apr 12 12:24:41 2004
New Revision: 9974
Modified:
xml/forrest/trunk/src/documentation/content/xdocs/forrestbot.xml
Log:
added: getsrc.svn; misc properties
Modified: xml/forrest/trunk/src/documentation/content/xdocs/forrestbot.xml
==============================================================================
--- xml/forrest/trunk/src/documentation/content/xdocs/forrestbot.xml (original)
+++ xml/forrest/trunk/src/documentation/content/xdocs/forrestbot.xml Mon Apr 12 12:24:41 2004
@@ -24,8 +24,9 @@
<body>
<warning>This documentation applies to the forrestbot in CVS, not the
forrestbot included with Forrest 0.5.1 or any previous release.
- Documentation for that forrestbot is <link href="site:forrestbot-old">here</link>.
- This page is incomplete and may have errors.</warning>
+ Documentation for that forrestbot is <link
+ href="site:forrestbot-old">here</link>. This page is incomplete and may have
+ errors.</warning>
<section>
<title>Using Forrestbot</title>
@@ -42,26 +43,26 @@
<p>A sample buildfile:</p>
- <source><project name="myproject">
- <property name="notify.email.host" value="smtp.myhost.com"/>
- <property name="notify.email.to" value="me@domain.com"/>
- <property name="notify.administrator" value="Your Name &lt;me@domain.com>"/>
- <property name="getsrc.cvs.user" value="anoncvs"/>
- <property name="getsrc.cvs.password" value="anoncvs"/>
- <property name="getsrc.cvs.root" value="/home/cvspublic"/>
- <property name="getsrc.cvs.host" value="cvs.myhost.com"/>
- <property name="getsrc.cvs.module" value="myproject"/>
-
- <target name="notify" depends="notify.local, notify.email"/>
- <import file="${env.FORREST_HOME}/../../../scratchpad/forrestbot2/core/forrestbot.xml"/>
-</project>
+ <source><project name="mysampleproject">
+ <property name="notify.email.host" value="smtp.myhost.com"/>
+ <property name="notify.email.to" value="me@domain.com"/>
+ <property name="notify.administrator" value="Your Name &lt;me@domain.com>"/>
+ <property name="getsrc.cvs.user" value="anoncvs"/>
+ <property name="getsrc.cvs.password" value="anoncvs"/>
+ <property name="getsrc.cvs.root" value="/home/cvspublic"/>
+ <property name="getsrc.cvs.host" value="cvs.myhost.com"/>
+ <property name="getsrc.cvs.module" value="myproject"/>
+
+ <target name="notify" depends="notify.local, notify.email"/>
+ <import file="${env.FORREST_HOME}/../../../scratchpad/forrestbot2/core/forrestbot.xml"/>
+</project>
</source>
<p>First, set properties needed by the workstages you are going to use.
Here, we set properties that will be used by notify.email and getsrc.cvs.
Next, specify what implementations will be used by each workstage. By
- default, 'local' will be used.</p>
+ default, 'local' will be used.</p>
<table>
<tr>
@@ -73,43 +74,82 @@
<tr>
<td>getsrc</td>
- <td><ul><li><link href="#getsrc.local">local</link></li><li><link
- href="#getsrc.cvs">cvs</link></li></ul></td>
+ <td><ul>
+ <li><link href="#getsrc.local">local</link></li>
+
+ <li><link href="#getsrc.cvs">cvs</link></li>
+
+ <li><link href="#getsrc.svn">svn</link></li>
+ </ul></td>
</tr>
<tr>
<td>build</td>
- <td><ul><li><link href="#build.forrest">forrest</link></li></ul></td>
+ <td><ul>
+ <li><link href="#build.forrest">forrest</link></li>
+ </ul></td>
</tr>
<tr>
<td>deploy</td>
- <td><ul><li><link href="#getsrc.local">local</link></li></ul></td>
+ <td><ul>
+ <li><link href="#getsrc.local">local</link></li>
+ </ul></td>
</tr>
<tr>
<td><link href="#notify">notify</link></td>
- <td><ul><li><link href="#notify.local">local</link></li><li><link
- href="#notify.email">email</link></li></ul></td>
+ <td><ul>
+ <li><link href="#notify.local">local</link></li>
+
+ <li><link href="#notify.email">email</link></li>
+ </ul></td>
</tr>
</table>
<p>If you want to do more advanced processing for your project, you can
- override the 'main' target, which by default is <code><target
- name="main" depends="getsrc, build, deploy, notify"/></code>,
- create your own implementation of a workstage, or use any other ant tasks
- to do additional work.</p>
+ override the 'main' target, which by default is <code><target
+ name="main" depends="getsrc, build, deploy, notify"/></code>, create
+ your own implementation of a workstage, or use any other ant tasks to do
+ additional work.</p>
<section>
- <title>Workstages</title>
+ <title>Workstage Properties</title>
<p>Each workstage implementation is configurable with properties. The
following tables describe each property and whether or not you are
required to set it in your buildfile.</p>
+ <section>
+ <title>Misc Properties</title>
+
+ <table>
+ <tr>
+ <th>Property</th>
+
+ <th>Description</th>
+
+ <th>Default Value</th>
+
+ <th>Required?</th>
+ </tr>
+
+ <tr>
+ <td>ant.project.name (you specify this by <project
+ name="____"> in your buildfile)</td>
+
+ <td>This must be unique for each project.</td>
+
+ <td></td>
+
+ <td>Yes</td>
+ </tr>
+ </table>
+ </section>
+
<section id="getsrc.local">
<title>getsrc.local</title>
@@ -127,7 +167,7 @@
<tr>
<td>getsrc.local.root-dir</td>
- <td>Absolute path to the project's root directory on the local
+ <td>Absolute path to the project's root directory on the local
computer</td>
<td></td>
@@ -214,6 +254,43 @@
</table>
</section>
+ <section id="getsrc.svn">
+ <title>getsrc.svn</title>
+
+ <table>
+ <tr>
+ <th>Property</th>
+
+ <th>Description</th>
+
+ <th>Default Value</th>
+
+ <th>Required?</th>
+ </tr>
+
+ <tr>
+ <td>getsrc.svn.url</td>
+
+ <td>full repository URL for project (this directory must contain
+ forrest.properties) </td>
+
+ <td></td>
+
+ <td>Yes</td>
+ </tr>
+
+ <tr>
+ <td>getsrc.svn.revision</td>
+
+ <td>Revision number to fetch</td>
+
+ <td>HEAD</td>
+
+ <td>No</td>
+ </tr>
+ </table>
+ </section>
+
<section id="build.forrest">
<title>build.forrest</title>
@@ -382,12 +459,18 @@
<section>
<title>Forrestbot design</title>
- <p>Forrest and forrestbot use ant buildfiles extensively. Ant 1.6's
- import task is used to import multiple buildfiles into a single build. The
+ <p>Forrest and forrestbot use ant buildfiles extensively. Ant 1.6's import
+ task is used to import multiple buildfiles into a single build. The
following is the flow of control when running forrestbot:</p>
<ul>
- <li>Your buildfile<ul><li>forrestbot.xml<ul><li>workstage buildfiles</li><li>forrest.build.xml</li></ul></li></ul></li>
+ <li>Your buildfile<ul>
+ <li>forrestbot.xml<ul>
+ <li>workstage buildfiles</li>
+
+ <li>forrest.build.xml</li>
+ </ul></li>
+ </ul></li>
</ul>
<p>The workstage buildfiles set up the properties and files so that the