You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-svn@forrest.apache.org by cr...@apache.org on 2007/04/10 06:44:05 UTC
svn commit: r527020 [20/20] - in /forrest/site: ./ docs_0_80/
docs_0_80/howto/ docs_0_80/howto/cvs-ssh/ docs_0_80/howto/multi/ dtdx/
plan/ pluginDocs/plugins_0_70/ pluginDocs/plugins_0_80/ procedures/
procedures/release/ skins/ tools/
Modified: forrest/site/tools/forrestbot.html
URL: http://svn.apache.org/viewvc/forrest/site/tools/forrestbot.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/tools/forrestbot.html (original)
+++ forrest/site/tools/forrestbot.html Mon Apr 9 21:44:00 2007
@@ -236,53 +236,61 @@
<a name="N1000D"></a><a name="Overview"></a>
<h2 class="underlined_10">Overview</h2>
<div class="section">
-<p>Forrestbot lets you automate building and deploying websites. The
- whole process gets the source docs, builds the site, then deploys it
- where you want it to go. Forrestbot can also notify you afterwards, and
- it keeps a log of the build process. To accomplish these tasks,
- Forrestbot uses four "workstages" (getsrc, build, deploy, notify). Each
- workstage has various implementations (e.g., getsrc has getsrc.cvs or
- getsrc.svn or getsrc.local implementations), which have various
- properties that may be set, depending upon the implementations
- chosen.</p>
+<p>
+ Forrestbot lets you automate building and deploying websites. The whole
+ process gets the source docs, builds the site, then deploys it where you
+ want it to go. Forrestbot can also notify you afterwards, and it keeps a
+ log of the build process. To accomplish these tasks, Forrestbot uses
+ four "workstages" (getsrc, build, deploy, notify). Each workstage has
+ various implementations (e.g., getsrc has getsrc.cvs or getsrc.svn or
+ getsrc.local implementations), which have various properties that may be
+ set, depending upon the implementations chosen.
+ </p>
</div>
-
<a name="N10017"></a><a name="Using+Forrestbot"></a>
<h2 class="underlined_10">Using Forrestbot</h2>
<div class="section">
-<p>You need to create a customized buildfile directing Forrestbot's work
- and then simply execute:</p>
+<p>
+ You need to create a customized buildfile directing Forrestbot's work
+ and then simply execute:
+ </p>
<pre class="code">forrest -f mybuildfile.xml</pre>
-<p>This project buildfile is simply an Ant buildfile with specific
- targets that control Forrestbot's operation. The next section explains
- how to create such a buildfile. For details on the syntax of Ant
- buildfiles and the operation of Ant itself consult the <a href="http://ant.apache.org/">Ant documentation</a>.</p>
+<p>
+ This project buildfile is simply an Ant buildfile with specific targets
+ that control Forrestbot's operation. The next section explains how to
+ create such a buildfile. For details on the syntax of Ant buildfiles and
+ the operation of Ant itself consult the <a href="http://ant.apache.org/">Ant
+ documentation</a>.
+ </p>
</div>
-
<a name="N1002C"></a><a name="Creating+a+Forrestbot+Project+Buildfile"></a>
<h2 class="underlined_10">Creating a Forrestbot Project Buildfile</h2>
<div class="section">
-<p>Within the new buildfile, you need to first set properties needed by
- the workstages you are going to use and then specify which
- implementations will be used by each workstage. Note that the properties
- need to be set at the global scope (as children of
- <span class="codefrag"><project></span>, i.e., outside of
- <span class="codefrag"><target></span> elements) in order for your settings to
- override the defaults in the Forrestbot implementation. Other than that,
- the property definitions can appear anywhere before the
- <span class="codefrag"><import></span> task.</p>
-<p>This sample buildfile can be used as a base from which to customize
- your own buildfile. The file starts with the project name and default
- target, then sets the specific properties we need to get the source,
- indicate the deployment location, and set up notification. It then
- specifies which implementations we will use and finishes up with
- importing the <span class="codefrag">forrestbot.xml</span> file. The 'main' target, which
- is specified as the default here, is a convenience target (defined in
- <span class="codefrag">forrestbot.xml</span>) that executes the four workstages (getsrc,
- build, deploy, notify) sequentially.</p>
+<p>
+ Within the new buildfile, you need to first set properties needed by the
+ workstages you are going to use and then specify which implementations
+ will be used by each workstage. Note that the properties need to be set
+ at the global scope (as children of <span class="codefrag"><project></span>, i.e.,
+ outside of <span class="codefrag"><target></span> elements) in order for your
+ settings to override the defaults in the Forrestbot implementation.
+ Other than that, the property definitions can appear anywhere before the
+ <span class="codefrag"><import></span> task.
+ </p>
+<p>
+ This sample buildfile can be used as a base from which to customize your
+ own buildfile. The file starts with the project name and default target,
+ then sets the specific properties we need to get the source, indicate
+ the deployment location, and set up notification. It then specifies
+ which implementations we will use and finishes up with importing the
+ <span class="codefrag">forrestbot.xml</span> file. The 'main' target, which is specified
+ as the default here, is a convenience target (defined in
+ <span class="codefrag">forrestbot.xml</span>) that executes the four workstages (getsrc,
+ build, deploy, notify) sequentially.
+ </p>
<pre class="code">
+
<project name="mysampleproject" default="main">
<property name="notify.email.host" value="smtp.myhost.com"/>
<property name="notify.email.to" value="me@domain.com"/>
@@ -311,55 +319,54 @@
<property environment="env"/>
<import file="${env.FORREST_HOME}/tools/forrestbot/core/forrestbot.xml"/>
</project>
-</pre>
+
+ </pre>
<a name="N1004B"></a><a name="Workstages"></a>
<h3 class="underlined_5">Workstages</h3>
-<p>It is only necessary to include specific target implementations in
- the buildfile if we want to override the default implementations. The
- following table shows the various workstages, which implementations
- may be used for each, and which one is the default.</p>
+<p>
+ It is only necessary to include specific target implementations in the
+ buildfile if we want to override the default implementations. The
+ following table shows the various workstages, which implementations
+ may be used for each, and which one is the default.
+ </p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Workstage</th>
-
<th colspan="1" rowspan="1">Implementations</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">getsrc</td>
-
<td colspan="1" rowspan="1">
+
<ul>
<li>
<a href="#getsrc.local">getsrc.local</a>
</li>
-
<li>
<a href="#getsrc.cvs">getsrc.cvs</a> (default)</li>
-
<li>
<a href="#getsrc.svn">getsrc.svn</a>
</li>
</ul>
+
</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">build</td>
-
<td colspan="1" rowspan="1">
+
<ul>
<li>
@@ -367,487 +374,416 @@
</li>
</ul>
+
</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy</td>
-
<td colspan="1" rowspan="1">
+
<ul>
<li>
<a href="#deploy.local">deploy.local</a>
(default)</li>
-
<li>
<a href="#deploy.scp">deploy.scp</a>
</li>
-
<li>
<a href="#deploy.cvs">deploy.cvs</a>
</li>
-
<li>
<a href="#deploy.svn">deploy.svn</a>
</li>
-
<li>
<a href="#deploy.ftp">deploy.ftp</a>
</li>
</ul>
+
</td>
</tr>
-
<tr>
-<td colspan="1" rowspan="1"><a href="#notify">notify</a></td>
-
+<td colspan="1" rowspan="1"><a href="#notify">notify</a>
+ </td>
<td colspan="1" rowspan="1">
+
<ul>
<li>
<a href="#notify.local">notify.local</a>
(default)</li>
-
<li>
<a href="#notify.email">notify.email</a>
</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 <span class="codefrag"><target
- name="main" depends="getsrc, build, deploy, notify"/></span>,
- create your own implementation of a workstage, or use any other ant
- tasks to do additional work. In order to create your own workstage
- implementation, define the workstage target in question in your
- <span class="codefrag">mybuildfile.xml</span> anywhere before the
- <span class="codefrag"><import></span> task. This will override the default
- implementation provided by Forrestbot.</p>
-<p>Also, you can choose a different target as the default by changing
- the <span class="codefrag">default</span> attribute of <span class="codefrag"><project></span>.
- For example, you will much more frequently do a 'build' without a
- 'deploy' during the development of your website, and only at the end
- do an actual 'deploy', so you might want to choose 'build' as your
- default target.</p>
-<a name="N100ED"></a><a name="checksums"></a>
+<p>
+ If you want to do more advanced processing for your project, you can
+ override the 'main' target, which by default is <span class="codefrag"><target
+ name="main" depends="getsrc, build, deploy, notify"/></span>,
+ create your own implementation of a workstage, or use any other ant
+ tasks to do additional work. In order to create your own workstage
+ implementation, define the workstage target in question in your
+ <span class="codefrag">mybuildfile.xml</span> anywhere before the
+ <span class="codefrag"><import></span> task. This will override the default
+ implementation provided by Forrestbot.
+ </p>
+<p>
+ Also, you can choose a different target as the default by changing the
+ <span class="codefrag">default</span> attribute of <span class="codefrag"><project></span>. For
+ example, you will much more frequently do a 'build' without a 'deploy'
+ during the development of your website, and only at the end do an
+ actual 'deploy', so you might want to choose 'build' as your default
+ target.
+ </p>
+<a name="N100F6"></a><a name="checksums"></a>
<h4>Deploying only modified files</h4>
-<p>Use the <a href="../docs_0_80/faq.html#checksums">checkums</a> feature of the Cocoon CLI.
- This enables Forrest to keep track of which generated files have actually
- been changed. The Ant tasks used by Forrestbot will then deploy only the
- modified files. Ant keeps a <span class="codefrag">cache.properties</span> file.
- If you need to deploy all files then remove this file and let it
- be re-generated.
+<p>
+ Use the <a href="../docs_0_80/faq.html#checksums">checkums</a> feature of
+ the Cocoon CLI. This enables Forrest to keep track of which
+ generated files have actually been changed. The Ant tasks used by
+ Forrestbot will then deploy only the modified files. Ant keeps a
+ <span class="codefrag">cache.properties</span> file. If you need to deploy all files
+ then remove this file and let it be re-generated.
</p>
-<p>Note that the deplo.svn and deploy.cvs workstages handle modified files
- with their own mechanism.
+<p>
+ Note that the deplo.svn and deploy.cvs workstages handle modified
+ files with their own mechanism.
</p>
-<a name="N10101"></a><a name="Correct+Use+of+getsrc.local"></a>
+<a name="N1010A"></a><a name="Correct+Use+of+getsrc.local"></a>
<h4>Correct Use of getsrc.local</h4>
-<p>There is a wrinkle when using the 'getsrc.local' implementation
- of the 'getsrc' workstage. If you define your own 'getsrc.local'
- target, make sure it starts with the <span class="codefrag"><property></span>
- task given here:</p>
+<p>
+ There is a wrinkle when using the 'getsrc.local' implementation of
+ the 'getsrc' workstage. If you define your own 'getsrc.local'
+ target, make sure it starts with the <span class="codefrag"><property></span>
+ task given here:
+ </p>
<pre class="code"><target name="getsrc.local">
<property name="build.home-dir" location="${getsrc.local.root-dir}"/>
[...]
</target></pre>
-<p>Alternatively (and preferably), define your 'getsrc' target like
- this:</p>
+<p>
+ Alternatively (and preferably), define your 'getsrc' target like
+ this:
+ </p>
<pre class="code"><target name="getsrc" depends="getsrc.clean-workdir, getsrc.get, getsrc.local"/></pre>
-<p>and then implement the actual fetching of the sources in the
- 'getsrc.get' target. This latter approach is safer since it is more
- likely to be forward-compatible with future versions of
- Forrestbot.</p>
-<a name="N1011D"></a><a name="Workstage+Properties"></a>
+<p>
+ and then implement the actual fetching of the sources in the
+ 'getsrc.get' target. This latter approach is safer since it is more
+ likely to be forward-compatible with future versions of Forrestbot.
+ </p>
+<a name="N10126"></a><a name="Workstage+Properties"></a>
<h3 class="underlined_5">Workstage Properties</h3>
-<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>
-<p>Many workstage properties use usernames and passwords. You may want
- to keep them out of your project's Ant buildfile (especially if you
- store that file in CVS or SVN). A nice way to do this is to create a
- separate properties file (e.g., <span class="codefrag">auth.properties</span>) that
- just sets those properties (don't include it in CVS/SVN). Then, at the
- top of your project buildfile, have <span class="codefrag"><property
- file="auth.properties"/></span>.</p>
-<a name="N1012F"></a><a name="Misc.+Properties"></a>
+<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>
+<p>
+ Many workstage properties use usernames and passwords. You may want to
+ keep them out of your project's Ant buildfile (especially if you store
+ that file in CVS or SVN). A nice way to do this is to create a
+ separate properties file (e.g., <span class="codefrag">auth.properties</span>) that
+ just sets those properties (don't include it in CVS/SVN). Then, at the
+ top of your project buildfile, have <span class="codefrag"><property
+ file="auth.properties"/></span>.
+ </p>
+<a name="N10138"></a><a name="Misc.+Properties"></a>
<h4>Misc. Properties</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Property</th>
-
<th colspan="1" rowspan="1">Description</th>
-
<th colspan="1" rowspan="1">Default Value</th>
-
<th colspan="1" rowspan="1">Required?</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">ant.project.name (you specify this by <project
name="____"> in your buildfile)</td>
-
<td colspan="1" rowspan="1">This must be unique for each project.</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
</table>
-<a name="N10166"></a><a name="getsrc.clean-workdir"></a>
+<a name="N1016F"></a><a name="getsrc.clean-workdir"></a>
<h4>getsrc.clean-workdir</h4>
-<p>This should be executed before a getsrc implementation is
- executed, e.g., <span class="codefrag"><target name="getsrc"
- depends="getsrc.clean-workdir, getsrc.svn"/></span>.</p>
-<a name="N10173"></a><a name="getsrc.local"></a>
+<p>
+ This should be executed before a getsrc implementation is executed,
+ e.g., <span class="codefrag"><target name="getsrc" depends="getsrc.clean-workdir,
+ getsrc.svn"/></span>.
+ </p>
+<a name="N1017C"></a><a name="getsrc.local"></a>
<h4>getsrc.local</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Property</th>
-
<th colspan="1" rowspan="1">Description</th>
-
<th colspan="1" rowspan="1">Default Value</th>
-
<th colspan="1" rowspan="1">Required?</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">getsrc.local.root-dir</td>
-
<td colspan="1" rowspan="1">Absolute path to the project's root directory on the local
computer. Use <strong>location=</strong> instead of
<strong>value=</strong> for this <property></td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
</table>
-<a name="N101B0"></a><a name="getsrc.cvs"></a>
+<a name="N101B9"></a><a name="getsrc.cvs"></a>
<h4>getsrc.cvs</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Property</th>
-
<th colspan="1" rowspan="1">Description</th>
-
<th colspan="1" rowspan="1">Default Value</th>
-
<th colspan="1" rowspan="1">Required?</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">getsrc.cvs.user</td>
-
<td colspan="1" rowspan="1">CVS username</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">getsrc.cvs.password</td>
-
<td colspan="1" rowspan="1">CVS password</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">getsrc.cvs.root</td>
-
<td colspan="1" rowspan="1">CVS root directory</td>
-
<td colspan="1" rowspan="1">/home/cvsroot</td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">getsrc.cvs.host</td>
-
<td colspan="1" rowspan="1">CVS host</td>
-
<td colspan="1" rowspan="1">cvs.apache.org</td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">getsrc.cvs.module</td>
-
<td colspan="1" rowspan="1">CVS module name (an alias for or the full path to the
directory that contains forrest.properties)</td>
-
<td colspan="1" rowspan="1">${ant.project.name}</td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">getsrc.cvs.tag</td>
-
<td colspan="1" rowspan="1">CVS tag or branch name</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
</table>
-<a name="N10258"></a><a name="getsrc.svn"></a>
+<a name="N10261"></a><a name="getsrc.svn"></a>
<h4>getsrc.svn</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Property</th>
-
<th colspan="1" rowspan="1">Description</th>
-
<th colspan="1" rowspan="1">Default Value</th>
-
<th colspan="1" rowspan="1">Required?</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">getsrc.svn.url</td>
-
<td colspan="1" rowspan="1">Full repository URL for project (this directory must contain
forrest.properties)</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">getsrc.svn.revision</td>
-
<td colspan="1" rowspan="1">Revision number to fetch</td>
-
<td colspan="1" rowspan="1">HEAD</td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
</table>
-<a name="N102A6"></a><a name="build.forrest"></a>
+<a name="N102AF"></a><a name="build.forrest"></a>
<h4>build.forrest</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Property</th>
-
<th colspan="1" rowspan="1">Description</th>
-
<th colspan="1" rowspan="1">Default Value</th>
-
<th colspan="1" rowspan="1">Required?</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">build.work-dir</td>
-
<td colspan="1" rowspan="1">Directory to temporarily hold working files</td>
-
<td colspan="1" rowspan="1">work/${ant.project.name}</td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">build.log-dir</td>
-
<td colspan="1" rowspan="1">Directory to hold log files</td>
-
<td colspan="1" rowspan="1">logs</td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
</table>
-<a name="N102F5"></a><a name="deploy.local"></a>
+<a name="N102FE"></a><a name="deploy.local"></a>
<h4>deploy.local</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Property</th>
-
<th colspan="1" rowspan="1">Description</th>
-
<th colspan="1" rowspan="1">Default Value</th>
-
<th colspan="1" rowspan="1">Required?</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.local.dir</td>
-
<td colspan="1" rowspan="1">Path to deploy site to - the dir that would be the
equivalant of build/site dir. Relative paths are relative to
${basedir}, which defaults to the dir containing the Forrestbot
project buildfile (mybuildfile.xml).</td>
-
<td colspan="1" rowspan="1">sites/${ant.project.name}</td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
</table>
-<a name="N1032D"></a><a name="deploy.scp"></a>
+<a name="N10336"></a><a name="deploy.scp"></a>
<h4>deploy.scp</h4>
-<p>The <span class="codefrag">${user.home}/.ssh/known_hosts</span> must properly
- recognize the host, so you should manually make an ssh connection to
- the host if you never have before.</p>
-<p>If <span class="codefrag">${deploy.scp.keyfile}</span>is defined, then it will use
- key-based authentication in preference. Otherwise it will use
- <span class="codefrag">${deploy.scp.password}</span>
+<p>
+ The <span class="codefrag">${user.home}/.ssh/known_hosts</span> must properly
+ recognize the host, so you should manually make an ssh connection to
+ the host if you never have before.
+ </p>
+<p>
+ If <span class="codefrag">${deploy.scp.keyfile}</span>is defined, then it will use
+ key-based authentication in preference. Otherwise it will use
+ <span class="codefrag">${deploy.scp.password}</span>
+
</p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Property</th>
-
<th colspan="1" rowspan="1">Description</th>
-
<th colspan="1" rowspan="1">Default Value</th>
-
<th colspan="1" rowspan="1">Required?</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.scp.dest</td>
-
<td colspan="1" rowspan="1">Full destination reference in the format
user@host:/directory/path</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.scp.keyfile</td>
-
<td colspan="1" rowspan="1">Location of the local file holding the private key.
Usually /home/me/.ssh/id_dsa or /home/me/.ssh/id_rsa
<br>
Note that the deploy.scp.passphrase must also be supplied.
</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">No. However, if this is not supplied then scp will fallback
to use the less secure deploy.scp.password</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.scp.passphrase</td>
-
<td colspan="1" rowspan="1">Local passphrase for your private key.</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">No. You will be prompted if it is not set.</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.scp.password</td>
-
<td colspan="1" rowspan="1">Password for user@host</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">No. You will be prompted if it is not set.
<br>
Not needed if using the preferred
@@ -857,421 +793,321 @@
</tr>
</table>
-<a name="N103B8"></a><a name="deploy.cvs"></a>
+<a name="N103C2"></a><a name="deploy.cvs"></a>
<h4>deploy.cvs</h4>
-<p>This is only available on *nix operating systems.</p>
+<p>
+ This is only available on *nix operating systems.
+ </p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Property</th>
-
<th colspan="1" rowspan="1">Description</th>
-
<th colspan="1" rowspan="1">Default Value</th>
-
<th colspan="1" rowspan="1">Required?</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.cvs.user</td>
-
<td colspan="1" rowspan="1">CVS username to use when committing changes</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.cvs.password</td>
-
<td colspan="1" rowspan="1">CVS password</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.cvs.root</td>
-
<td colspan="1" rowspan="1">CVS root</td>
-
<td colspan="1" rowspan="1">/home/cvs</td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.cvs.host</td>
-
<td colspan="1" rowspan="1">CVS host</td>
-
<td colspan="1" rowspan="1">cvs.apache.org</td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.cvs.module</td>
-
<td colspan="1" rowspan="1">CVS module</td>
-
<td colspan="1" rowspan="1">${ant.project.name}</td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.cvs.commit-message</td>
-
<td colspan="1" rowspan="1">Message to use when committing. You probably want to put a
machine name or person's name here.</td>
-
<td colspan="1" rowspan="1">Automatic publish from forrestbot</td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
</table>
-<a name="N10464"></a><a name="deploy.svn"></a>
+<a name="N1046E"></a><a name="deploy.svn"></a>
<h4>deploy.svn</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Property</th>
-
<th colspan="1" rowspan="1">Description</th>
-
<th colspan="1" rowspan="1">Default Value</th>
-
<th colspan="1" rowspan="1">Required?</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.svn.user</td>
-
<td colspan="1" rowspan="1">SVN username to use when committing changes</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.svn.password</td>
-
<td colspan="1" rowspan="1">SVN password</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.svn.url</td>
-
<td colspan="1" rowspan="1">Full repository URL</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.svn.commit-message</td>
-
<td colspan="1" rowspan="1">Message to use when committing. You probably want to put a
machine name or person's name here.</td>
-
<td colspan="1" rowspan="1">Automatic publish from forrestbot</td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
</table>
-<a name="N104DE"></a><a name="deploy.ftp"></a>
+<a name="N104E8"></a><a name="deploy.ftp"></a>
<h4>deploy.ftp</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Property</th>
-
<th colspan="1" rowspan="1">Description</th>
-
<th colspan="1" rowspan="1">Default Value</th>
-
<th colspan="1" rowspan="1">Required?</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.ftp.server</td>
-
<td colspan="1" rowspan="1">FTP server to upload files to</td>
-
<td colspan="1" rowspan="1">localhost</td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.ftp.user</td>
-
<td colspan="1" rowspan="1">FTP username to use for authenticating with the server</td>
-
<td colspan="1" rowspan="1">anonymous</td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.ftp.password</td>
-
<td colspan="1" rowspan="1">Password for the FTP user</td>
-
<td colspan="1" rowspan="1">forrestbot@</td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">deploy.ftp.remotedir</td>
-
<td colspan="1" rowspan="1">The directory to upload to (this can be an absolute path or
relative to the FTP user's default directory)</td>
-
<td colspan="1" rowspan="1">incoming</td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
</table>
-<a name="N1055B"></a><a name="notify"></a>
+<a name="N10565"></a><a name="notify"></a>
<h4>notify</h4>
-<p>These settings are used by all notify implementations.</p>
+<p>
+ These settings are used by all notify implementations.
+ </p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Property</th>
-
<th colspan="1" rowspan="1">Description</th>
-
<th colspan="1" rowspan="1">Default Value</th>
-
<th colspan="1" rowspan="1">Required?</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">notify.administrator</td>
-
<td colspan="1" rowspan="1">Name and email address of the forrestbot administrator</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">notify.on.failure</td>
-
<td colspan="1" rowspan="1">On a build failure, notification will happen if this is
true.</td>
-
<td colspan="1" rowspan="1">true</td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">notify.on.success</td>
-
<td colspan="1" rowspan="1">On a succesful build, notification will happen if this is
true.</td>
-
<td colspan="1" rowspan="1">true</td>
-
<td colspan="1" rowspan="1">No</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">notify.log</td>
-
<td colspan="1" rowspan="1">Log file</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">No. Set by other workstage(s).</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">notify.deploy-location</td>
-
<td colspan="1" rowspan="1">Deployed location</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">No. Set by other workstage(s).</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">notify.completion-status</td>
-
<td colspan="1" rowspan="1">Result of the build</td>
-
<td colspan="1" rowspan="1"></td>
-
<td colspan="1" rowspan="1">No. Set by other workstage(s).</td>
</tr>
</table>
-<a name="N10605"></a><a name="notify.local"></a>
+<a name="N1060F"></a><a name="notify.local"></a>
<h4>notify.local</h4>
-<p>No properties.</p>
-<a name="N1060F"></a><a name="notify.email"></a>
+<p>
+ No properties.
+ </p>
+<a name="N10619"></a><a name="notify.email"></a>
<h4>notify.email</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<tr>
<th colspan="1" rowspan="1">Property</th>
-
<th colspan="1" rowspan="1">Description</th>
-
<th colspan="1" rowspan="1">Default Value</th>
-
<th colspan="1" rowspan="1">Required?</th>
</tr>
-
<tr>
<td colspan="1" rowspan="1">notify.email.host</td>
-
<td colspan="1" rowspan="1">SMTP host through which the email will be sent.</td>
-
<td colspan="1" rowspan="1">localhost</td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">notify.email.to</td>
-
<td colspan="1" rowspan="1">Email address to send notification to.</td>
-
<td colspan="1" rowspan="1">${user.name}@localhost</td>
-
<td colspan="1" rowspan="1">Yes</td>
</tr>
-
<tr>
<td colspan="1" rowspan="1">notify.email.from</td>
-
<td colspan="1" rowspan="1">From: address in the email</td>
-
<td colspan="1" rowspan="1">Forrestbot</td>
-
<td colspan="1" rowspan="1">No, but some mailers may require a valid email address.</td>
</tr>
</table>
</div>
-
-<a name="N10677"></a><a name="Forrestbot+Design"></a>
+<a name="N10681"></a><a name="Forrestbot+Design"></a>
<h2 class="underlined_10">Forrestbot Design</h2>
<div class="section">
-<p>Forrest and Forrestbot use Ant buildfiles extensively. Ant 1.6's
- <span class="codefrag"><import></span> task is used to import multiple buildfiles
- into a single build. The following is the flow of control when running
- Forrestbot:</p>
+<p>
+ Forrest and Forrestbot use Ant buildfiles extensively. Ant 1.6's
+ <span class="codefrag"><import></span> 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 project buildfile (<span class="codefrag">mybuildfile.xml</span>)<ul>
<li>
<span class="codefrag">$FORREST_HOME/tools/forrestbot/core/forrestbot.xml</span>
+
<ul>
<li>Workstage buildfiles
(<span class="codefrag">$FORREST_HOME/tools/forrestbot/core/{getsrc,build,deploy,notify}.xml</span>)</li>
-
<li>
<span class="codefrag">$FORREST_HOME/main/forrest.build.xml</span>
@@ -1284,16 +1120,20 @@
</li>
</ul>
-<p>The workstage buildfiles define the default workstage implementations
- and set up the properties and files so that targets in the main Forrest
- buildfile (<span class="codefrag">forrest.build.xml</span>) will run. After those targets
- are executed, the targets in the workstage buildfiles can perform
- reporting, deployment, or other post-build activities.</p>
-<p>Your project buildfile specifies the workstages you want to use, sets
- properties for them, and does any additional pre- and post-processing.
- In addition, you can override the default workstage implementations by
- defining the relevant targets in your project buildfile before the
- <span class="codefrag"><import></span> task (see the example above).</p>
+<p>
+ The workstage buildfiles define the default workstage implementations
+ and set up the properties and files so that targets in the main Forrest
+ buildfile (<span class="codefrag">forrest.build.xml</span>) will run. After those targets
+ are executed, the targets in the workstage buildfiles can perform
+ reporting, deployment, or other post-build activities.
+ </p>
+<p>
+ Your project buildfile specifies the workstages you want to use, sets
+ properties for them, and does any additional pre- and post-processing.
+ In addition, you can override the default workstage implementations by
+ defining the relevant targets in your project buildfile before the
+ <span class="codefrag"><import></span> task (see the example above).
+ </p>
</div>
</div>
Modified: forrest/site/tools/forrestbot.pdf
URL: http://svn.apache.org/viewvc/forrest/site/tools/forrestbot.pdf?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
Binary files - no diff available.
Modified: forrest/site/tools/xxe.html
URL: http://svn.apache.org/viewvc/forrest/site/tools/xxe.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/tools/xxe.html (original)
+++ forrest/site/tools/xxe.html Mon Apr 9 21:44:00 2007
@@ -186,17 +186,21 @@
<div class="note">
<div class="label">Note</div>
-<div class="content">This is not a particular endorsement of XXE over other xml editors.
- It is just that we provide this tool to take advantage of XXE.</div>
+<div class="content">
+ This is not a particular endorsement of XXE over other xml editors. It is
+ just that we provide this tool to take advantage of XXE.
+ </div>
</div>
<p>
-<a href="http://www.xmlmind.com/xmleditor/">XMLmind XML Editor</a>
- is a validating XML editor featuring a word processor-like view. We
- support the Forrest plugin for XXE only, please direct all XXE-related
- questions to XXE support or mailing lists.</p>
+
+<a href="http://www.xmlmind.com/xmleditor/">XMLmind XML Editor</a>
+ is a validating XML editor featuring a word processor-like view. We
+ support the Forrest plugin for XXE only, please direct all XXE-related
+ questions to XXE support or mailing lists.
+ </p>
-<a name="N10016"></a><a name="Requirements"></a>
+<a name="N10017"></a><a name="Requirements"></a>
<h2 class="underlined_10">Requirements</h2>
<div class="section">
<ul>
@@ -209,10 +213,12 @@
</ul>
</div>
-<a name="N10026"></a><a name="build"></a>
+<a name="N10027"></a><a name="build"></a>
<h2 class="underlined_10">Build</h2>
<div class="section">
-<p>To build the configuration:</p>
+<p>
+ To build the configuration:
+ </p>
<ol>
<li>Make sure the FORREST_HOME environment variable is set</li>
@@ -223,7 +229,9 @@
<li>Run <span class="codefrag">ant</span> in this directory</li>
</ol>
-<p>e.g.</p>
+<p>
+ e.g.
+ </p>
<pre class="code">you@yourHost:~/src/apache/forrest-trunk$ cd tools/xxe
you@yourHost:~/src/apache/forrest-trunk/tools/xxe$ ant Buildfile:
build.xml -init: clean: copy-dtds: [copy] Copying 71 files to
@@ -234,28 +242,30 @@
/home/you/src/apache/forrest-trunk/tools/xxe/dist/XXE_forrest_config-1.4.zip
BUILD SUCCESSFUL Total time: 9 seconds</pre>
<p>
+
<strong>Developer note:</strong>
-<br>To work directly with the SVN
- version of the configuration, check out
- http://svn.apache.org/repos/asf/forrest/trunk/tools/xxe/ into the
- <span class="codefrag">forrest</span> folder in the XXE <span class="codefrag">addon</span> folder. Run
- the build there to copy the DTDs</p>
+
+<br>
+ To work directly with the SVN version of the configuration, check out
+ http://svn.apache.org/repos/asf/forrest/trunk/tools/xxe/ into the
+ <span class="codefrag">forrest</span> folder in the XXE <span class="codefrag">addon</span> folder. Run
+ the build there to copy the DTDs
+ </p>
<p>
<a href="http://www.xmlmind.com/xmleditor/_distrib/doc/configure/index.html">
- XXE Custom Configuration Info</a>
+ XXE Custom Configuration Info</a>
</p>
</div>
-<a name="N1005B"></a><a name="Install"></a>
+<a name="N1005E"></a><a name="Install"></a>
<h2 class="underlined_10">Install</h2>
<div class="section">
<ol>
<li>Extract into the XXE application config directory (e.g.
- <span class="codefrag">D:\Program Files\XMLmind_XML_Editor\config</span>)<br>
-
+ <span class="codefrag">D:\Program Files\XMLmind_XML_Editor\config</span>)<br>
<strong>OR</strong>
</li>
@@ -265,33 +275,38 @@
location, as it permits upgrading XXE without having to reinstall
this config <div class="note">
<div class="label">Note</div>
-<div class="content">This location is new for XXE 2.10, and is not
- tested with earlier releases!</div>
-</div>
+<div class="content">
+ This location is new for XXE 2.10, and is not tested with earlier
+ releases!
+ </div>
+</div>
</li>
</ol>
</div>
-<a name="N10078"></a><a name="Upgrade"></a>
+<a name="N10079"></a><a name="Upgrade"></a>
<h2 class="underlined_10">Upgrade</h2>
<div class="section">
<ol>
<li>Delete the <span class="codefrag">forrest</span> directory from the XXE application
config directory. (e.g. <span class="codefrag">D:\Program
- Files\XMLmind_XML_Editor\config</span>)<br>
+ Files\XMLmind_XML_Editor\config</span>)<br>
<strong>OR</strong>
</li>
<li>Delete the 'forrest' directory from your user XXE config directory:
- <ul>
+ <ul>
+
<li>*nix-es: <span class="codefrag">~/.xxe/addon/</span>
-</li>
+</li>
+
<li>Windows:
<span class="codefrag">%SystemDrive%\Documents and Settings\user\Application
Data\XMLmind\XMLeditor\</span>
-</li>
+</li>
+
</ul> depending on where you
installed the previous version of the tool </li>
@@ -309,16 +324,17 @@
<li>Updated the tool to work with XXE 3.0p1. (FOR-779) <div class="note">
<div class="label">Note</div>
-<div class="content">This
- change is backwards INCOMPATIBLE, therefore the tool now
- <em>requires</em> XXE 3.0p1+.</div>
-</div>
+<div class="content">
+ This change is backwards INCOMPATIBLE, therefore the tool now
+ <em>requires</em> XXE 3.0p1+.
+ </div>
+</div>
</li>
<li>Added XXE-provided default rendering of tables</li>
</ul>
-<a name="N100BE"></a><a name="1.3"></a>
+<a name="N100BD"></a><a name="1.3"></a>
<h3 class="underlined_5">1.3</h3>
<ul>
Modified: forrest/site/who.html
URL: http://svn.apache.org/viewvc/forrest/site/who.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/who.html (original)
+++ forrest/site/who.html Mon Apr 9 21:44:00 2007
@@ -209,16 +209,18 @@
<a name="N1000D"></a><a name="community"></a>
<h2 class="underlined_10">The Forrest Community</h2>
<div class="section">
-<p> The Forrest Project operates as a meritocracy: the more you do, the
- more responsibility you will obtain. This page lists all of the people who have
- gone the extra mile and are Committers. If you would like to get involved, the
- first step is to join the mailing lists. </p>
-<p>
- Of course the committers are not the only people involved in the community.
- Thanks to the many people for their contributions
- of patches, assistance, ideas, and email discussion.
- Some are mentioned at the <a href="docs_0_80/changes.html">changes</a> page.
- See how we <a href="guidelines.html#contribution">acknowledge</a> contributions.
+<p>
+ The Forrest Project operates as a meritocracy: the more you do, the more
+ responsibility you will obtain. This page lists all of the people who
+ have gone the extra mile and are Committers. If you would like to get
+ involved, the first step is to join the mailing lists.
+ </p>
+<p>
+ Of course the committers are not the only people involved in the
+ community. Thanks to the many people for their contributions of patches,
+ assistance, ideas, and email discussion. Some are mentioned at the
+ <a href="docs_0_80/changes.html">changes</a> page. See how we
+ <a href="guidelines.html#contribution">acknowledge</a> contributions.
</p>
<p>
Please do not send emails directly to individual developers asking for
@@ -230,7 +232,10 @@
<a name="N10029"></a><a name="committers"></a>
<h2 class="underlined_10">List of committers</h2>
<div class="section">
-<p>List of all people who have ever been committers at Apache Forrest, sorted alphabetically.</p>
+<p>
+ List of all people who have ever been committers at Apache Forrest,
+ sorted alphabetically.
+ </p>
<ul>
<li>
@@ -301,7 +306,7 @@
</li>
<li>[JT] - Jeff Turner (jefft.at.apache.org)</li>
-
+
<li>
<strong>[TW] - Tim Williams (twilliams.at.apache.org)</strong>
</li>
@@ -312,25 +317,33 @@
<a name="N10088"></a><a name="notes"></a>
<h2 class="underlined_10">Notes</h2>
<div class="section">
-<p>Strong type denotes "Project Management Committee (<a href="guidelines.html#pmc">PMC</a>) member".
- Emphasis type denotes "emeritus PMC member".
- See the <a href="guidelines.html#roles">ASF role definitions</a> for detailed role information.
- The actual list of PMC members is in the SVN "committers" repository
- at /board/committee-info.txt
- </p>
-<p>Some people were committers prior to Forrest becoming a top-level project and
- so gaining a PMC. They were not around since then, so have never been on the PMC.
- All new committers are <a href="guidelines.html#pmc-committers">encouraged</a> to be PMC members.
+<p>
+ Strong type denotes "Project Management Committee
+ (<a href="guidelines.html#pmc">PMC</a>) member". Emphasis type denotes
+ "emeritus PMC member". See the <a href="guidelines.html#roles">ASF role
+ definitions</a> for detailed role information. The actual list of PMC
+ members is in the SVN "committers" repository at
+ /board/committee-info.txt
+ </p>
+<p>
+ Some people were committers prior to Forrest becoming a top-level
+ project and so gaining a PMC. They were not around since then, so have
+ never been on the PMC. All new committers are
+ <a href="guidelines.html#pmc-committers">encouraged</a> to be PMC
+ members.
</p>
<p>
Committers can be as active as they choose and there is no performance
- pressure from the project. For those who are interested in the work
- that each paticular committer has done, see the
+ pressure from the project. For those who are interested in the work that
+ each paticular committer has done, see the
<a href="guidelines.html#contribution">acknowledgements</a> section.
</p>
-<p> All <a href="http://cocoon.apache.org/community/members.html">Apache Cocoon committers</a>
- and <a href="http://lenya.apache.org/community/acknowledgements.html">Apache Lenya committers</a>
- also have rights to commit to Forrest.</p>
+<p>
+ All <a href="http://cocoon.apache.org/community/members.html">Apache
+ Cocoon committers</a> and
+ <a href="http://lenya.apache.org/community/acknowledgements.html">Apache
+ Lenya committers</a> also have rights to commit to Forrest.
+ </p>
</div>
</div>
Modified: forrest/site/zone.html
URL: http://svn.apache.org/viewvc/forrest/site/zone.html?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
--- forrest/site/zone.html (original)
+++ forrest/site/zone.html Mon Apr 9 21:44:00 2007
@@ -265,14 +265,11 @@
<h2 class="underlined_10">Overview</h2>
<div class="section">
<p>
- The server
- <a href="http://forrest.zones.apache.org/">forrest.zones.apache.org</a>
- provides our testing and demonstration area.
- It is managed by Apache Forrest committers.
- The material is intended for developer use only.
+ The server <a href="http://forrest.zones.apache.org/">forrest.zones.apache.org</a>
+ provides our testing and demonstration area. It is managed by Apache
+ Forrest committers. The material is intended for developer use only.
</p>
</div>
-
<a name="N1001B"></a><a name="configuration"></a>
<h2 class="underlined_10">Configuration</h2>
@@ -314,30 +311,30 @@
</pre>
<p>
All files are owned in the group "other" so any one of us can
- edit/update. Make sure that your 'umask' is set properly so that
- new files have group write permissions.
- See the <a href="#admin-user">notes</a> about user administration.
- FIXME: Add a proper group.
+ edit/update. Make sure that your 'umask' is set properly so that new
+ files have group write permissions. See the
+ <a href="#admin-user">notes</a> about user administration. FIXME: Add a
+ proper group.
</p>
<p>
- Cron runs the various Forrestbots and management tasks, such as
- updating the forrest-trunk software; cleaning up old logfiles, etc.
- FIXME: These are not yet managed under SVN, see ~crossley/my-crontab.txt
+ Cron runs the various Forrestbots and management tasks, such as updating
+ the forrest-trunk software; cleaning up old logfiles, etc. FIXME: These
+ are not yet managed under SVN, see ~crossley/my-crontab.txt
</p>
</div>
-
<a name="N10052"></a><a name="software"></a>
<h2 class="underlined_10">Software</h2>
<div class="section">
<p>
- Global zone software is as described in
- <a href="http://www.apache.org/dev/solaris-zones.html">zone administration</a>.
- </p>
+ Global zone software is as described in
+ <a href="http://www.apache.org/dev/solaris-zones.html">zone
+ administration</a>.
+ </p>
<p>
- Various local software is installed in
- <span class="codefrag">/export/opt/</span> (not managed with SVN) ...
- </p>
+ Various local software is installed in <span class="codefrag">/export/opt/</span> (not
+ managed with SVN) ...
+ </p>
<a name="N10065"></a><a name="s-forrest"></a>
<h3 class="underlined_5">Forrest</h3>
<p>
@@ -369,22 +366,22 @@
To manually update -stable or -release do this:
</p>
<pre class="code">
+
source $CONFIG/setenv-java-14.sh
cd /export/opt/forrest-trunk-stable
svn up
cd main
./build.sh clean; ./build.sh
-</pre>
-</div>
+ </pre>
+</div>
<a name="N10092"></a><a name="fb"></a>
<h2 class="underlined_10">The forrestbots</h2>
<div class="section">
<p>
- There are various forrestbots operating with different versions
- of forrest.
- Their home is at $CONFIG
+ There are various forrestbots operating with different versions of
+ forrest. Their home is at $CONFIG
</p>
<p>
@@ -408,44 +405,39 @@
Configuration files and the generated results are at $DOC_ROOT/fts/
</pre>
<p>
- Forrestbot logs are at
- $CONFIG/forrestbot-trunk*/logs/
- and old ones are cleaned up by the crontab.
- There is also a log file for each site that forrestbot builds
- which captures the output of cron (cronout-*.txt).
- Be sure to verify this logfile after making configuration changes.
+ Forrestbot logs are at $CONFIG/forrestbot-trunk*/logs/ and old ones are
+ cleaned up by the crontab. There is also a log file for each site that
+ forrestbot builds which captures the output of cron (cronout-*.txt). Be
+ sure to verify this logfile after making configuration changes.
</p>
</div>
-
<a name="N100B3"></a><a name="admin"></a>
<h2 class="underlined_10">Administration</h2>
<div class="section">
<p>
See the general notes for the
- <a href="http://www.apache.org/dev/solaris-zones.html">zone administration</a>.
+ <a href="http://www.apache.org/dev/solaris-zones.html">zone
+ administration</a>.
</p>
<p>
- The project chair is the root user.
- Committers can ask on the dev list to get a user account added or modified.
+ The project chair is the root user. Committers can ask on the dev list
+ to get a user account added or modified.
</p>
<p>
Follow Leo's config ideas at
<a href="http://wiki.apache.org/gump/GumpZonesConfig">GumpZonesConfig</a>.
</p>
<p>
- Also keep an occasional eye on
- $CONFIG/update-forrest-trunk.log
- This is the output of the cronjob to do svn update to trunk
- and re-build.
+ Also keep an occasional eye on $CONFIG/update-forrest-trunk.log This is
+ the output of the cronjob to do svn update to trunk and re-build.
</p>
<p>
- FIXME:
- Start apache2 on boot (using new Solaris init.d replacement called smf).
- At the moment we need to realise that it is down and manually
- restart as per http://www.apache.org/dev/solaris-zones.html
- Also it seems that /var/run/apache2 is wiped out on reboot,
- so need to mkdir again.
+ FIXME: Start apache2 on boot (using new Solaris init.d replacement
+ called smf). At the moment we need to realise that it is down and
+ manually restart as per http://www.apache.org/dev/solaris-zones.html
+ Also it seems that /var/run/apache2 is wiped out on reboot, so need to
+ mkdir again.
</p>
<pre class="code">
sudo mkdir /var/run/apache2
@@ -453,11 +445,15 @@
</pre>
<a name="N100D4"></a><a name="admin-user"></a>
<h3 class="underlined_5">User administration</h3>
-<p>After receiving your account, please be sure to configure it properly.</p>
-<p>See some notes at
- <a href="http://www.apache.org/dev/solaris-zones.html">zone administration</a>
- and the general notes for
- <a href="http://www.apache.org/dev/new-committers-guide.html#shell">new committers</a> (especially the part about 'umask').
+<p>
+ After receiving your account, please be sure to configure it properly.
+ </p>
+<p>
+ See some notes at
+ <a href="http://www.apache.org/dev/solaris-zones.html">zone
+ administration</a> and the general notes for
+ <a href="http://www.apache.org/dev/new-committers-guide.html#shell">new
+ committers</a> (especially the part about 'umask').
</p>
<p>
Look at the setup of some other users on our zone.
Modified: forrest/site/zone.pdf
URL: http://svn.apache.org/viewvc/forrest/site/zone.pdf?view=diff&rev=527020&r1=527019&r2=527020
==============================================================================
Binary files - no diff available.