Author: crossley
Date: Tue Sep 12 21:18:23 2006
New Revision: 442830
URL: http://svn.apache.org/viewvc?view=rev&rev=442830
Log:
Automatic publish from forrestbot
Modified:
forrest/site/docs_0_80/faq.html
forrest/site/docs_0_80/faq.pdf
forrest/site/docs_0_80/faq.xml
forrest/site/howto-dev.html
forrest/site/howto-dev.pdf
forrest/site/tools/forrestbot.html
forrest/site/tools/forrestbot.pdf
Modified: forrest/site/docs_0_80/faq.html
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_80/faq.html?view=diff&rev=442830&r1=442829&r2=442830
==============================================================================
--- forrest/site/docs_0_80/faq.html (original)
+++ forrest/site/docs_0_80/faq.html Tue Sep 12 21:18:23 2006
@@ -1517,9 +1517,8 @@
to a big savings for a site with thousands of files.
</p>
<p>
- Another reason could be if you are not using the forrestbot to
- deploy the generated site. Some tools depend on the
"date-last-modified"
- timestamp of the generated files.
+ Some tools depend on the "date-last-modified" timestamp of the
generated files.
+ For example, the Forrestbot will then deploy only the modified files.
</p>
<p>
There was some discussion about this on the Forrest developer mailing
Modified: forrest/site/docs_0_80/faq.pdf
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_80/faq.pdf?view=diff&rev=442830&r1=442829&r2=442830
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_80/faq.xml
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_80/faq.xml?view=diff&rev=442830&r1=442829&r2=442830
==============================================================================
--- forrest/site/docs_0_80/faq.xml (original)
+++ forrest/site/docs_0_80/faq.xml Tue Sep 12 21:18:23 2006
@@ -647,9 +647,8 @@
to a big savings for a site with thousands of files.
</p>
<p>
- Another reason could be if you are not using the forrestbot to
- deploy the generated site. Some tools depend on the
"date-last-modified"
- timestamp of the generated files.
+ Some tools depend on the "date-last-modified" timestamp of the
generated files.
+ For example, the Forrestbot will then deploy only the modified files.
</p>
<p>
There was some discussion about this on the Forrest developer mailing
Modified: forrest/site/howto-dev.html
URL:
http://svn.apache.org/viewvc/forrest/site/howto-dev.html?view=diff&rev=442830&r1=442829&r2=442830
==============================================================================
--- forrest/site/howto-dev.html (original)
+++ forrest/site/howto-dev.html Tue Sep 12 21:18:23 2006
@@ -265,6 +265,9 @@
<a href="#svn-find-break">Updating svn backwards to find where something
broke</a>
</li>
<li>
+<a href="#svn-merge">Reverting Changes using SVN Merge</a>
+</li>
+<li>
<a href="#svn-patch">Creating patches</a>
</li>
<li>
@@ -573,7 +576,20 @@
After finding the break, move back to head of trunk
svn update -r HEAD.
</pre>
-<a name="N100B4"></a><a name="svn-patch"></a>
+<a name="N100B4"></a><a name="svn-merge"></a>
+<h4>Reverting Changes using SVN Merge</h4>
+<p>Two examples of using SVN Merge.</p>
+<pre class="code">
+$ svn merge -r 400:300 /site-author/content/xdocs/index.xml
/site-author/content/xdocs/index.xml
+
+or
+
+$ svn merge -r 303:302
+
+... then commit as usual.
+ </pre>
+<p> More information can be found at <a
href="http://svnbook.red-bean.com/en/1.0/ch04s04.html#svn-ch-4-sect-4.2";>Common
use-cases for merging</a> section of the Red Bean SVN Book.</p>
+<a name="N100C9"></a><a name="svn-patch"></a>
<h4>Creating patches</h4>
<p>See
<a href="contrib.html#patch">instructions</a> for creating and
contributing patches.
@@ -589,7 +605,7 @@
</ul>
<p>After creating the patch, open it with a text editor and review it.
</p>
-<a name="N100D1"></a><a name="tips-svn"></a>
+<a name="N100E6"></a><a name="tips-svn"></a>
<h4>Tips</h4>
<ul>
@@ -618,7 +634,7 @@
</li>
</ul>
-<a name="N100F4"></a><a name="edit"></a>
+<a name="N10109"></a><a name="edit"></a>
<h3 class="underlined_5">Editing content</h3>
<p>
See the
@@ -627,7 +643,7 @@
be used, because Forrest treats the editing of content as a separate
concern. Be sure to configure the editor to find local copies of DTDs.
</p>
-<a name="N10101"></a><a name="code-style"></a>
+<a name="N10116"></a><a name="code-style"></a>
<h4>Code style guidelines</h4>
<p>
Consistent code makes everyone's life easier.
@@ -641,7 +657,7 @@
Don't change anything that is not necessary. Remember that people
need to be
able to read the differences on the [EMAIL PROTECTED] mailing list.
</p>
-<a name="N10112"></a><a name="whitespace"></a>
+<a name="N10127"></a><a name="whitespace"></a>
<h4>Whitespace</h4>
<p>
For new files, use spaces instead of tabs (java files have
four-space indentation,
@@ -668,7 +684,7 @@
references.
</div>
</div>
-<a name="N1012A"></a><a name="line-length"></a>
+<a name="N1013F"></a><a name="line-length"></a>
<h4>Line length</h4>
<p>
If each paragraph of an xml source document is one enourmous long
@@ -677,7 +693,7 @@
efficiently review the changes. Fold long lines to a sensible
line-length (normally 80-characters wide but not more than 120
characters).
</p>
-<a name="N10134"></a><a name="review"></a>
+<a name="N10149"></a><a name="review"></a>
<h4>Use 'forrest run' for immediate gratification</h4>
<p>
Edit documentation content and immediately view it in the browser.
@@ -692,7 +708,7 @@
tools such as "xmllint". As a last resort, you can use
'forrest validate-xdocs'.
</p>
-<a name="N10141"></a><a name="tips-edit"></a>
+<a name="N10156"></a><a name="tips-edit"></a>
<h4>Tips</h4>
<ul>
@@ -701,7 +717,7 @@
</li>
</ul>
-<a name="N1014F"></a><a name="sitemap"></a>
+<a name="N10164"></a><a name="sitemap"></a>
<h3 class="underlined_5">Understanding the Cocoon sitemap</h3>
<p>
The Cocoon sitemap is essential for Forrest developers. See some
introductions ....
@@ -731,9 +747,9 @@
</li>
</ul>
-<a name="N10186"></a><a name="debug"></a>
+<a name="N1019B"></a><a name="debug"></a>
<h3 class="underlined_5">Debugging and profiling techniques</h3>
-<a name="N1018C"></a><a name="debug-logfiles"></a>
+<a name="N101A1"></a><a name="debug-logfiles"></a>
<h4>View logfiles</h4>
<p>
The log files in WEB-INF/logs are indispensible when it comes
@@ -746,7 +762,7 @@
describes the location of the Cocoon logfiles and their
configuration.
</p>
-<a name="N1019D"></a><a name="debug-intermediate"></a>
+<a name="N101B2"></a><a name="debug-intermediate"></a>
<h4>View intermediate processing</h4>
<p>
Perhaps the easiest way to "debug" Forrest is to be aware of all the
@@ -758,7 +774,7 @@
<p>
The techniques described below help you to be aware of the
intermediate processing steps.
</p>
-<a name="N101AA"></a><a name="debug-cocoon-profiler"></a>
+<a name="N101BF"></a><a name="debug-cocoon-profiler"></a>
<h4>Using Cocoon sitemap profiler</h4>
<p>
Cocoon provides a simple profiler to analyse itself.
@@ -789,7 +805,7 @@
NOTE: Do not forget to turn off the profiler in
<span class="codefrag">main/webapp/sitemap.xmap</span> when finished.
</p>
-<a name="N101C6"></a><a name="debug-sitemap-exec"></a>
+<a name="N101DB"></a><a name="debug-sitemap-exec"></a>
<h4>Using Cocoon sitemap execution logger</h4>
<p>
In main/webapp/WEB-INF/xconf/forrest-core.xconf
@@ -797,7 +813,7 @@
For each sitemap component that is executed, a message will go to
WEB-INF/logs/debug.log
</p>
-<a name="N101D0"></a><a name="debug-logtransformer"></a>
+<a name="N101E5"></a><a name="debug-logtransformer"></a>
<h4>Using Cocoon LogTransformer</h4>
<p>
LogTransformers can be inserted in the sitemaps. This will write
@@ -827,7 +843,7 @@
path is being taken through the sitemap. Add various LogTransformers
with different filenames and see which one gets triggered.
</p>
-<a name="N101E7"></a><a name="debug-validation"></a>
+<a name="N101FC"></a><a name="debug-validation"></a>
<h4>Using Cocoon Validation Transformers</h4>
<p>
Validating Transformers can be inserted in the sitemaps to validate
@@ -852,7 +868,7 @@
<a
href="http://cocoon.zones.apache.org/daisy/documentation/components/1058/g2/684.html";>ValidatingTransformer</a>
and
<a
href="http://cocoon.zones.apache.org/daisy/documentation/components/1058/g2/691.html";>ValidationReportTransformer</a>.
</p>
-<a name="N10207"></a><a name="debug-java"></a>
+<a name="N1021C"></a><a name="debug-java"></a>
<h4>Java code</h4>
<p>There are two ways to debug your java code. The first is through embedded
logging, the second is by tracing the codes execution.</p>
@@ -866,7 +882,7 @@
on. The <span class="codefrag">forrest.jvmargs</span>code> property
in the <span class="codefrag">forrest.properties</span>
file can be used to start forrest in debug mode on a specific port.
For example:</p>
<pre class="code">forrest.jvmargs=-Xdebug
-Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n</pre>
-<a name="N10224"></a><a name="debug-links"></a>
+<a name="N10239"></a><a name="debug-links"></a>
<h4>Finding broken internal links</h4>
<p>
Do 'forrest site' to produce the whole documentation set.
@@ -887,7 +903,7 @@
configuration file or the link in your source document is not
using the correct name for the "site:..." value.
</p>
-<a name="N10238"></a><a name="tips-debug"></a>
+<a name="N1024D"></a><a name="tips-debug"></a>
<h4>Tips</h4>
<ul>
@@ -905,7 +921,7 @@
integrated operation with the IDE, please provide a documentation
patch.
</div>
</div>
-<a name="N10248"></a><a name="profile-yourkit"></a>
+<a name="N1025D"></a><a name="profile-yourkit"></a>
<h4>Profiling Forrest with YourKit</h4>
<p>
Assuming you have the YourKit software installed you simply need to
do two things to
@@ -920,7 +936,7 @@
expected, check the current filters - YourKit seems to filter out
org.apache.* namespaces by
default.
</p>
-<a name="N10259"></a><a name="profile-netbeans"></a>
+<a name="N1026E"></a><a name="profile-netbeans"></a>
<h4>Profiling Forrest with Netbeans</h4>
<p>
Assuming you have the Netbeans IDE installed, you simply need to do
a couple things to
@@ -936,13 +952,13 @@
project. Click Profile->Attach Profiler and make selections
appropriate to what you are trying
to achieve.
</p>
-<a name="N1026B"></a><a name="find"></a>
+<a name="N10280"></a><a name="find"></a>
<h3 class="underlined_5">Finding the relevant sources</h3>
<p>
You will need to be able to find which sources, sitemaps, stylesheets
are responsible for certain processing.
</p>
-<a name="N10274"></a><a name="find-scenario-1"></a>
+<a name="N10289"></a><a name="find-scenario-1"></a>
<h4>Scenario: How does i18n work</h4>
<p>
We will do a search for "i18n" to start with, then refine that after
@@ -985,7 +1001,7 @@
is declared to use i18n, then further down the page the "skinit"
pipeline uses the i18n transformer only if i18n is switched on.
</p>
-<a name="N10296"></a><a name="tips-find"></a>
+<a name="N102AB"></a><a name="tips-find"></a>
<h4>Tips</h4>
<ul>
@@ -995,31 +1011,31 @@
</ul>
</div>
-<a name="N102A6"></a><a name="Frequently Asked Questions"></a>
+<a name="N102BB"></a><a name="Frequently Asked Questions"></a>
<h2 class="underlined_10">Frequently Asked Questions</h2>
<div class="section">
-<a name="N102AA"></a><a name="1+General+issues"></a>
+<a name="N102BF"></a><a name="1+General+issues"></a>
<h3 class="underlined_5">1 General issues</h3>
-<a name="N102AE"></a><a name="1.1+FAQ+1"></a>
+<a name="N102C3"></a><a name="1.1+FAQ+1"></a>
<h4>1.1 FAQ 1</h4>
<p>
####
</p>
-<a name="N102B6"></a><a name="2+Other+issues"></a>
+<a name="N102CB"></a><a name="2+Other+issues"></a>
<h3 class="underlined_5">2 Other issues</h3>
-<a name="N102BA"></a><a name="2.1+FAQ+2.1"></a>
+<a name="N102CF"></a><a name="2.1+FAQ+2.1"></a>
<h4>2.1 FAQ 2.1</h4>
<p>
###
</p>
</div>
-<a name="N102C2"></a><a name="Tips"></a>
+<a name="N102D7"></a><a name="Tips"></a>
<h2 class="underlined_10">Tips</h2>
<div class="section">
<p>
This is a collection of general tips that do not fit in the sections
above.
</p>
-<a name="N102CA"></a><a name="tip-howto"></a>
+<a name="N102DF"></a><a name="tip-howto"></a>
<h3 class="underlined_5">Explanations about howto topics on the mailing
lists</h3>
<p>
Often there are useful discussions on the mailing lists which explain
@@ -1028,7 +1044,7 @@
which links to the email discussion. Later someone else can summarise.
</p>
</div>
-<a name="N102D4"></a><a name="References"></a>
+<a name="N102E9"></a><a name="References"></a>
<h2 class="underlined_10">References</h2>
<div class="section">
<p>
Modified: forrest/site/howto-dev.pdf
URL:
http://svn.apache.org/viewvc/forrest/site/howto-dev.pdf?view=diff&rev=442830&r1=442829&r2=442830
==============================================================================
Binary files - no diff available.
Modified: forrest/site/tools/forrestbot.html
URL:
http://svn.apache.org/viewvc/forrest/site/tools/forrestbot.html?view=diff&rev=442830&r1=442829&r2=442830
==============================================================================
--- forrest/site/tools/forrestbot.html (original)
+++ forrest/site/tools/forrestbot.html Tue Sep 12 21:18:23 2006
@@ -171,6 +171,9 @@
<a href="#Workstages">Workstages</a>
<ul class="minitoc">
<li>
+<a href="#checksums">Deploying only modified files</a>
+</li>
+<li>
<a href="#Correct+Use+of+getsrc.local">Correct Use of getsrc.local</a>
</li>
</ul>
@@ -443,7 +446,19 @@
'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="Correct+Use+of+getsrc.local"></a>
+<a name="N100ED"></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>
+<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>
<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'
@@ -460,7 +475,7 @@
'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="N10109"></a><a name="Workstage+Properties"></a>
+<a name="N1011D"></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
@@ -472,7 +487,7 @@
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="N1011B"></a><a name="Misc.+Properties"></a>
+<a name="N1012F"></a><a name="Misc.+Properties"></a>
<h4>Misc. Properties</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -503,12 +518,12 @@
</tr>
</table>
-<a name="N10152"></a><a name="getsrc.clean-workdir"></a>
+<a name="N10166"></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="N1015F"></a><a name="getsrc.local"></a>
+<a name="N10173"></a><a name="getsrc.local"></a>
<h4>getsrc.local</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -540,7 +555,7 @@
</tr>
</table>
-<a name="N1019C"></a><a name="getsrc.cvs"></a>
+<a name="N101B0"></a><a name="getsrc.cvs"></a>
<h4>getsrc.cvs</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -636,7 +651,7 @@
</tr>
</table>
-<a name="N10244"></a><a name="getsrc.svn"></a>
+<a name="N10258"></a><a name="getsrc.svn"></a>
<h4>getsrc.svn</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -680,7 +695,7 @@
</tr>
</table>
-<a name="N10292"></a><a name="build.forrest"></a>
+<a name="N102A6"></a><a name="build.forrest"></a>
<h4>build.forrest</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -723,7 +738,7 @@
</tr>
</table>
-<a name="N102E1"></a><a name="deploy.local"></a>
+<a name="N102F5"></a><a name="deploy.local"></a>
<h4>deploy.local</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -756,7 +771,7 @@
</tr>
</table>
-<a name="N10319"></a><a name="deploy.scp"></a>
+<a name="N1032D"></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
@@ -842,7 +857,7 @@
</tr>
</table>
-<a name="N103A4"></a><a name="deploy.cvs"></a>
+<a name="N103B8"></a><a name="deploy.cvs"></a>
<h4>deploy.cvs</h4>
<p>This is only available on *nix operating systems.</p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -939,7 +954,7 @@
</tr>
</table>
-<a name="N10450"></a><a name="deploy.svn"></a>
+<a name="N10464"></a><a name="deploy.svn"></a>
<h4>deploy.svn</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -1009,7 +1024,7 @@
</tr>
</table>
-<a name="N104CA"></a><a name="deploy.ftp"></a>
+<a name="N104DE"></a><a name="deploy.ftp"></a>
<h4>deploy.ftp</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -1079,7 +1094,7 @@
</tr>
</table>
-<a name="N10547"></a><a name="notify"></a>
+<a name="N1055B"></a><a name="notify"></a>
<h4>notify</h4>
<p>These settings are used by all notify implementations.</p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -1177,10 +1192,10 @@
</tr>
</table>
-<a name="N105F1"></a><a name="notify.local"></a>
+<a name="N10605"></a><a name="notify.local"></a>
<h4>notify.local</h4>
<p>No properties.</p>
-<a name="N105FB"></a><a name="notify.email"></a>
+<a name="N1060F"></a><a name="notify.email"></a>
<h4>notify.email</h4>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -1239,7 +1254,7 @@
</div>
-<a name="N10663"></a><a name="Forrestbot+Design"></a>
+<a name="N10677"></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
Modified: forrest/site/tools/forrestbot.pdf
URL:
http://svn.apache.org/viewvc/forrest/site/tools/forrestbot.pdf?view=diff&rev=442830&r1=442829&r2=442830
==============================================================================
Binary files - no diff available.
