You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2011/01/13 01:59:31 UTC

svn commit: r1058382 - in /forrest/trunk/site-author: content/xdocs/docs_0_90/faq.xml status.xml

Author: crossley
Date: Thu Jan 13 00:59:30 2011
New Revision: 1058382

URL: http://svn.apache.org/viewvc?rev=1058382&view=rev
Log:
Improved the FAQ about "version and properties" and linked to the
documentation of the new Properties system.
Issue: FOR-734

Modified:
    forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml
    forrest/trunk/site-author/status.xml

Modified: forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml?rev=1058382&r1=1058381&r2=1058382&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_90/faq.xml Thu Jan 13 00:59:30 2011
@@ -44,7 +44,7 @@
         <p>
           You have a local copy of the main documentation with your version of
           Forrest. Do 'cd site-author; forrest run' and visit
-          http://localhost:8888/ in your browser. The most recent documentation
+          <code>http://localhost:8888/</code> in your browser. The most recent documentation
           is in SVN trunk which creates the forrest.apache.org website.
         </p>
         <p>
@@ -167,8 +167,8 @@ forrest -Dproject.start-uri=live-sites.h
         </p>
         <p>
           Another useful technique is to use 'wget' or Apache Ant's Get task to
-          retrieve individual files, e.g. Do 'forrest run' and then 'wget
-          http://localhost:8888/index.pdf'.
+          retrieve individual files, e.g. Do 'forrest run' and then
+          <code>'wget http://localhost:8888/index.pdf'</code>
         </p>
       </answer>
     </faq>
@@ -1457,11 +1457,27 @@ X [0]         /docs_0_80/upgrading_08.ht
         <p>
           Do <code>'forrest -projecthelp'</code> or <code>'./build.sh'</code> to
           find the version number.
+          Also when starting <code>'forrest'</code> or <code>'forrest run'</code> 
+          the versions are reported for forrest, java, and ant.
         </p>
         <p>
-          To list the properties, add "forrest.echo=true" to your
+          To list the properties and other stuff, add "forrest.echo=true" to your
           forrest.properties file and watch the build messages. Doing
-          <code>'forrest -v'</code> will provide verbose build messages.
+          <code>'forrest -v'</code> will provide verbose build messages and other useful
+          information.
+        </p>
+        <p>
+          In <code>'forrest run'</code> mode, use the
+          <link href="site:forrestbar">Forrestbar</link> to see the build-info
+          and properties, or access them directly:
+        </p>
+        <dl>
+          <dd><code>http://localhost:8888/build-info</code></dd>
+          <dd><code>http://localhost:8888/module.properties.properties</code></dd>
+        </dl>
+        <p>
+          See the documentation about the new <link href="site:properties">Properties</link>
+          system.
         </p>
       </answer>
     </faq>

Modified: forrest/trunk/site-author/status.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/status.xml?rev=1058382&r1=1058381&r2=1058382&view=diff
==============================================================================
--- forrest/trunk/site-author/status.xml (original)
+++ forrest/trunk/site-author/status.xml Thu Jan 13 00:59:30 2011
@@ -154,6 +154,10 @@
         <link href="site:upgrading_09">upgrading to v0.9</link>
       </action>
 <!-- 2011-01 -->
+      <action context="docs" type="update" dev="DC" importance="high">
+        Improved the FAQ about "version and properties" and linked to the
+        documentation of the new <link href="site:properties">Properties</link> system.
+      </action>
       <action context="code" type="update" dev="BMD" due-to="Richard Calmbach,Mathieu Champlon" fixes-bug="FOR-752">
         Fix hard-coded path in ForrestLogTargetFactory and
         ForrestConfUtils which caused files to be placed in the wrong