cvs commit: xml-forrest/src/core/fresh-site forrest-targets.ent

[cr...@apache.org]

crossley    2003/12/29 20:45:27

  Modified:    src/documentation/content/xdocs your-project.xml
               src/core/fresh-site forrest-targets.ent
  Log:
  Add note to take care if set forrrest.home using build.properties
  (which caused grief at Cocoon).
  
  Revision  Changes    Path
  1.34      +11 -7     xml-forrest/src/documentation/content/xdocs/your-project.xml
  
  Index: your-project.xml
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/documentation/content/xdocs/your-project.xml,v
  retrieving revision 1.33
  retrieving revision 1.34
  diff -u -r1.33 -r1.34
  --- your-project.xml	29 Dec 2003 10:07:53 -0000	1.33
  +++ your-project.xml	30 Dec 2003 04:45:27 -0000	1.34
  @@ -842,8 +842,7 @@
           Always use <code>forrest.antproxy.xml</code>, not
           <code>forrest.build.xml</code>.  The <code>forrest.antproxy.xml</code>
           script invokes <code>forrest.build.xml</code> using Forrest's own
  -        bundled version of Ant, which has non-standard support for catalog
  -        files.
  +        bundled version of Ant.
         </note>
         <p>
           You'll notice that these targets require <code>${forrest.home}</code>
  @@ -851,19 +850,19 @@
           shbat distribution of Forrest.  Thus we need a mechanism for the user
           to inform the build script of their Forrest's location.  Typically
           this is done by setting a property in a properties file like
  -        <code>build.properties</code>, but can also be done by looking for the
  +        <code>project.properties</code>, but can also be done by looking for the
           <code>FORREST_HOME</code> environment variable.
         </p>
         <p>
           Forrest comes with an Ant snippet file,
  -        <code>forrest-targets.ent</code>, that supplies the targets listed
  +        <code>forrest-targets.ent</code> that supplies the targets listed
           above, as well as searching for a <code>${forrest.home}</code>
           definition in a number of likely places:
         </p>
         <ul>
           <li>In the <code>FORREST_HOME</code> environment variable.</li>
  -        <li>In the <code>build.properties</code> file.</li>
           <li>In the <code>project.properties</code> file.</li>
  +        <li>In the <code>build.properties</code> file.</li>
           <li>In the <code>ant.properties</code> file.</li>
           <li>In the <code>.ant.properties</code> file.</li>
         </ul>
  @@ -895,6 +894,11 @@
           Having done this, the Forrest targets (<code>site, webapp, war,
             validate</code>) are automatically added to your project.  
         </p>
  +      <note>
  +        Take care if you set forrrest.home using <code>build.properties</code>
  +        because if your build already reads build.properties then the forrest
  +        targets will not be able to re-set the forrest.home property.
  +      </note>
       </section>
     </body>
   </document>
  
  
  
  1.2       +6 -6      xml-forrest/src/core/fresh-site/forrest-targets.ent
  
  Index: forrest-targets.ent
  ===================================================================
  RCS file: /home/cvs/xml-forrest/src/core/fresh-site/forrest-targets.ent,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- forrest-targets.ent	20 Oct 2003 15:38:35 -0000	1.1
  +++ forrest-targets.ent	30 Dec 2003 04:45:27 -0000	1.2
  @@ -1,12 +1,12 @@
   <!--
   This build.xml snippet contains Forrest targets for Ant 1.5+.  It checks that
   the user has set ${forrest.home}, either in one of:
  -  build.properties
  +  FORREST_HOME environment variable
     project.properties
  +  build.properties
     ant.properties
     .ant.properties
  -or with the FORREST_HOME environment variable, and prints an informative error
  -message if not found.
  +and prints an informative error message if not found.
   
   Usage:
   1) Copy this file to somewhere in your project.
  @@ -63,7 +63,7 @@
     </target>
   
     <target name="forrest.checkenv" if="env.FORREST_HOME">
  -    <echo level="verbose">Found $FORREST_HOME..</echo>
  +    <echo level="verbose">Found $FORREST_HOME=${env.FORREST_HOME}</echo>
       <property name="forrest.home" location="${env.FORREST_HOME}"/>
       <echo level="verbose">forrest.home set to ${forrest.home}</echo>
       <available file="${forrest.home}" type="dir" property="forrest.home.present"/>
  @@ -161,8 +161,8 @@
         Then either:
   
         - Set FORREST_HOME as the Forrest build instructions describe
  -      - Create a build.properties, with the forrest.home property pointing to
  -        the forrest shbat directory, eg:
  +      - Create a project.properties, with the forrest.home property
  +        pointing to the forrest shbat directory, e.g.
   
           forrest.home=${winpath}  (Windows)
           forrest.home=${unixpath}  (Unix)