cocoon-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From da...@cocoon.zones.apache.org
Subject [DAISY] Updated: The Cocoon Build System
Date Fri, 10 Jun 2005 14:12:03 GMT
A document has been updated:

Document ID: 29
Branch: main
Language: default
Name: The Cocoon Build System (unchanged)
Document Type: Simple Document (unchanged)
Updated on: 6/10/05 2:08:42 PM
Updated by: Mark Leicester

A new version has been created, state: draft

Parts
=====
Content
-------
This part has been updated.
Mime type: text/xml (unchanged)
File name:  (unchanged)
Size: 2629 bytes (previous version: 1285 bytes)
Content diff:
(10 equal lines skipped)
    
    <p>The Cocoon build system is based on Ant.</p>
    
--- <h2>Precedence of properties in *.properties files</h2>
+++ <h2>Using Ant .properties files</h2>
    
--- <p>As Ant runs, it makes use of the properties it finds in various .properties
+++ <p>Cocoon's build system is configured through Ant .properties files. As Ant
+++ runs, it makes use of the properties it finds in these various .properties
    files. A property is set like this:</p>
    
--- <pre>exclude.all.blocks=true
+++ <pre>property.name=value
    </pre>
    
--- <p>Once an Ant property is set it cannot be altered. Ant looks for properties
--- found in .properties files in the following order:</p>
+++ <p>For example:</p>
    
+++ <pre>exclude.webapp.javadocs=true
+++ </pre>
+++ 
+++ <h3>Property precedence</h3>
+++ 
+++ <p>Once an Ant property is set it cannot be altered. This allows us to override
+++ values without having to edit existing configuration files.</p>
+++ 
+++ <p>Let's take build properties as an example. Ant looks for properties defined
+++ in .properties files in the following locations, in the following order:</p>
+++ 
    <ol>
--- <li>cocoon.build.properties in the user's home directory.</li>
--- <li>local.build.properties in the main project directory.</li>
--- <li>build.properties in the main project directory.</li>
+++ <li>cocoon.build.properties in your user account's home directory.</li>
+++ <li>local.build.properties in the Cocoon root directory.</li>
+++ <li>build.properties in the Cocoon root directory.</li>
    </ol>
    
--- <p>For example, if cocoon.build.properties contains the line
--- "exclude.all.blocks=true" then this will override any settings to the contrary
--- in later files (i.e. in local.build.properties or build.properties).</p>
+++ <p>Now, let's say that we want to include the webapp javadocs in our Cocoon
+++ build.</p>
    
+++ <p>We don't edit build.properties directly. Instead we copy build.properties to
+++ one of two places:</p>
+++ 
+++ <ul>
+++ <li>If we copy build.properties to cocoon.build.properties in your user
+++ account's home directory (as in 1. above) then changes made in that file will
+++ only affect you.</li>
+++ <li>If we copy build.properties to local.build.properties in the Cocoon root
+++ directory (as in 2. above) then changes made in that file will affect all users
+++ of your machine.</li>
+++ </ul>
+++ 
+++ <p>Let's assume the latter case:</p>
+++ 
+++ <ol>
+++ <li>Copy the existing build.properties file from the Cocoon root directory to a
+++ new file called local.build.properties also in your Cocoon root directory.</li>
+++ <li>In local.build.properties, look for "exclude.webapp.javadocs=true".</li>
+++ <li>Change "true" to "false" and save the file.</li>
+++ <li>Run "build clean"</li>
+++ <li>Run "build"</li>
+++ </ol>
+++ 
+++ <p>Now Ant will find a file called local.build.properties in the Cocoon root
+++ directory, containing the line "exclude.webapp.javadocs=false", and this value
+++ will take precedence over the "exclude.webapp.javadocs=true" it will find in
+++ build.properties. The first file to set a property "wins".</p>
+++ 
    </body>
    </html>


Fields
======
no changes

Links
=====
no changes

Custom Fields
=============
no changes

Collections
===========
no changes

Mime
View raw message