Broke out and increased build/test docs; some new info in the build module notes.

Included release instructions in the build/test docs
author: wisberg <wisberg> 2003-02-27 00:39:30 +0000
committer: wisberg <wisberg> 2003-02-27 00:39:30 +0000
commit: 53e98bac085b1b4e6fb0ec7d1e0227bfd14879c5 (patch)
tree: 25a000895c2137f3b933389a6560e1bbb3eb9032 /build/readme-build-module.html
parent: 9b1c6f8915bd8e2c9ae866caed54daf458812572 (diff)
download: aspectj-53e98bac085b1b4e6fb0ec7d1e0227bfd14879c5.tar.gz
aspectj-53e98bac085b1b4e6fb0ec7d1e0227bfd14879c5.zip
1 files changed, 116 insertions, 143 deletions
diff --git a/build/readme-build-module.html b/build/readme-build-module.html
index 2345d29aa..2e6897b4f 100644
--- a/build/readme-build-module.html
+++ b/build/readme-build-module.html
@@ -1,153 +1,85 @@
 <html>
-<title>AspectJ build</title>
+<title>AspectJ build module</title>
 <body>
 <h1>AspectJ build</h1>
 
 This build module contains taskdefs and resources for doing builds
-and checking source licenses.
-
-<h3>Usage</h3>
-<h4>Running the build</h4>
-To do a build, use Ant to run <a href="build.xml">build.xml</a>
-from this directory.  To run Ant, use <a href="../lib/ant">../lib/ant</a>
-scripts and libraries.    
-Consider defining the following flag properties:
-<p>
-<table cellpadding="1" border="1">
-<tr><th>Property</th><th>Meaning</th>
-    </tr>
-<tr><td>module.name
-    </td><td>To build any module (esp. those not directly supported
-             by a target), use the "any-module" target and define
-             the module name.
-	</td></tr>
-<tr><td>check.build.jar
-    </td><td>any value cause build to fail if 
-    <code>lib/build/build.jar</code> is out of date.  (This is a
-     built archive of the build module to avoid bootstrapping.)
-	</td></tr>
-<tr><td>build.config
-    </td><td>override default configuration in build.xml.
-     Significant values include "verbose" for more output
-     and "useEclipseCompiles" to assume that Eclipse has 
-     compiled modules into their bin directories, and just
-     assemble those classes.
-	</td></tr>
-</table>
+and checking source licenses.  This document describes our approach
+to builds and provides some notes for maintaining the build module
+and debugging builds.
+For information
+on running builds and doing testing for the AspectJ project, see
+  <a href="readme-build-and-test-aspectj.html">
+           readme-build-and-test-aspectj.html</a>.
+
+<h3>Approach</h3>
+The AspectJ project source files are broken into modules, 
+the subdirectories of the modules directory.
+(To eclipse users, each module is a Java project.)
+The modules are compiled independently and may be assembled
+by the build script into the release jar files.
+All required libraries are checked into the <code>lib</code> module.
+We use Ant to drive the build, but the logic for building and
+assembling modules resides in the BuildModule taskdef,
+which reads module dependencies from the Eclipse .classpath files
+and assembles the product according to the templates in the
+product directory.
+This makes it easy to change dependencies and add modules,
+but could make it difficult to debug if something were to go wrong.
 
-<p>
-For example, to build everything into a release bundle,
-with verbose logging
-<pre>
-  cd modules/build
-  ../lib/ant/bin/ant 
-</pre>
-
-To build only the asm module (and any modules it requires):
-<pre>
-  cd modules/build
-  ../lib/ant/bin/ant -f build.xml any-module -Dmodule.name=asm
-</pre>
-	
-<p>		
-
-<h5>Release builds</h5>
-Release builds differ only in running
-from a clean, up-to-date tree and with correct build version values
-in <a href="build-properties.xml">build-properties.xml</a>, which
-will update <code>org.aspectj.bridge.Version</code>.
-See <a href="#version">Version synchronization</a> below
-for more details on how the version is updated.
-
-<p>Do a quick test of the release by running the examples build script:
-<pre>
-    cd {aspect}/doc/examples
-    ant -f build.xml
-</pre>
-This should build and run the spacewar example. 
-To run all examples, use target <code>all</code>.
-To run all the examples that do not require manual operation,
-use target <code>nonGui</code>. 
-</p>
-<p>
-Finally, tag the tree so others can do diffs or create patches
-based on the release code.  E.g., from the command line:
-<pre>
-   cd org.aspectj/
-   cvs tag -R -c v1_1_0
-</pre>
-<p>
 
-<h4>Updating module dependencies and file locations</h4>  
+<h3>Maintaining the build module</h3>
+ 
 Because the BuildModule taskdef extracts dependencies from the Eclipse 
 <code>.classpath</code> file, there is no need to update build scripts when
 adding or removing modules or changing their dependencies, so long
 as they are all in the base modules directory (usually the base of
-the eclipse workspace.
-All required libraries are checked into the <code>lib</code> module.
-
-<p>The BuildModule taskdef makes some assumptions about the naming, 
-position, and contents of module directories and files.  
-Understand those (documented in 
-<a href="src/org/aspectj/internal/tools/ant/taskdefs/BuildModule.java">
-   BuildModule.java</a>) before using non-standard module directories. 
+the eclipse workspace).
+Likewise, updating a product assembly should be easy, 
+since they are based on introspection of the product directories.
+
+Still, the taskdef workings are not obvious in the build script, so 
+this section makes clear some of the implicit logic
+in case it's required when debugging build failures or
+to make changes.
+
+<h4>Build module code updates</h4>
+The build module produces taskdefs used to run the build.
+The scripts avoid bootstrapping by using a build library jar 
+checked in to
+  <code>lib/build/build.jar</code>.
+That means code updates in the build module are not reflected in
+the build process until the <code>build.jar<code> produced by 
+building this <code>build<code> module replaces that found in
+  <code>lib/build/build.jar</code>.  Once the module update is
+  confirmed, the new <code>lib/build/build.jar</code> must be checked in
+  to propogate the changes to other users.
+The scripts support an Ant variable <code>check.build.jar</code> 
+by warning when <code>lib/build/build.jar</code> is out of date.
 
-<p>
-<h4>Running builds or built jars under Eclipse</h4>
-When running Ant from eclipse,
-do not use the default Eclipse Ant classpath; remove those jars and
-add all the libraries in <a href="../lib/ant/lib">../lib/ant/lib</a>
-as well as in <a href="../lib/junit">../lib/junit</a>.
-<p>
-<u>warning</u>: Jar files do not seem to be closed properly when running under eclipse.
-This affects build products (e.g., installers) which are run under eclipse
-(e.g., by opening with the "default system editor") and libraries used
-when compiling under Javac (if not zip products or input).  This problem
-presents as files not being writable, i.e., deleted or modified.
-Ant provides no notice of the problem when
-deleting with quiet="on" (often used to avoid unnecessary errors caused
-by trying to delete directories that do not exist).
-
-<p>
-Currently BuildModule tasks forks the Javac command to work around
-this problem, but the Zip commands do not work around it.
-
-If under Eclipse, you get strange behavior with Ant builds, clear 
-out everything and build from the command line. In some cases, you
-have to exit Eclipse before files can be deleted.  (*sigh*)
-
-<h4>Running the test harness</h4>
-The <code>build-testing-drivers</code> target builds a single jar with
-the AspectJ binaries and a test harness as the main class. 
-It reads test suite files like 
-   <a href="../tests/ajcTests.xml">../tests/ajcTests.xml</a>.
-For more information, see
-  <a href="../tests/readme-tests-module.html">
-           ../tests/readme-tests-module.html</a>.
-  
-<p>
-JUnit tests may be run under eclipse or by using Ant to "build"
-   <a href="../tests/junitModules.xml">../tests/junitModules.xml</a>
-(which uses the eclipse module bin directories as its classpath).
-
-<h3>Development</h3>
 <h4>BuildModule task</h4>
 The 
 <a href="src/org/aspectj/internal/tools/ant/taskdefs/BuildModule.java">
    BuildModule</a>
 taskdef implements an integrated module or product build.
-<u>Module builds</u> are based on the Eclipse <code>.classpath</code>
+<p><u>Module builds</u> are based on the Eclipse <code>.classpath</code>
 file, and can produce
-a jar with the module classes, with two variations: (a) include only
-the module classes, or assemble the jar complete with all antecedent
-modules and libraries; and (b) compile the module(s) without any
-testing source or libraries.  If there is a file {moduleName}.mf.txt
+a jar with the module classes, with two variations: 
+<ul>
+  <li> include only the module classes, 
+      or assemble the jar complete with all antecedent modules and 
+      libraries;
+  </li><li>compile the module(s) with or without any
+           testing source or libraries
+  </li>
+</ul>
+If there is a file {moduleName}.mf.txt
 in the module directory, it will be used as the manifest for the
 module jar file.
 
-<u>Product builds</u> are defined by introspection of a 
+<p><u>Product builds</u> are defined by introspection of a 
 <a href="products">products</a> subdirectory like 
-<a href="products/tools">products/tools</a> for the AspectJ tools installer.
+<a href="products/tools">products/tools</a> for the AspectJ installer.
 
 These have an <code>install</code> directory for installer resources
 and a <code>dist</code> directory containing all files belonging in
@@ -155,22 +87,16 @@ the distribution, including 0-length placeholders for the module build
 results.  These placeholder file names are mapped to the originating
 module by the task itself (yes, an awful hack).
 
-<h4>Build notes</h4>
-<p>
-<u>Directory names</u>: Top-level temporary build directories are prefixed "aj-",
-so you can safely destroy any such directory or ignore it
-in CVS or the Eclipse package explorer.  By default the build script
-puts them at the same level as other modules.  In build scripts, property names 
-follow a similar convention; those prefixed "aj-" may be deleted at will, while
-"aspectj-" names are source directories which should never be deleted.
-
 <p>
 <a name="version"></a>
-<u>Version synchronization</u>: 
-Developers use the default "DEVELOPMENT" version unless doing or testing
-release builds.
-
-The build version is set in 
+<h4>Version synchronization</h4>
+The version is expressed in the jar manifests, in the <code>Version</code> class, 
+and in some documentation files.  The build script 
+ensures all version expressions
+are aligned.  When not doing or testing release builds, 
+developers use the default "DEVELOPMENT" version.
+
+<p>The build version is set in 
 <a href="build-properties.xml">build-properties.xml</a> and propogated
 using Ant copy filters out to
 the <a href="../runtime/runtime.mf.txt">aspectjrt.jar manifest</a>,
@@ -190,8 +116,55 @@ determines whether Version.java has the same version by scanning the source file
 The scan is dim-witted; do not change the lines flagged in the template 
 without also changing the scanning code in the task.
 
+<h4>Temporary aj-{name} and persistant aspectj-{name}</h4>
+<p>
+Top-level temporary build directories are prefixed "aj-",
+so you can safely destroy any such directory or ignore it
+in CVS or the Eclipse package explorer.  By default the build script
+puts them at the same level as other modules.  In build scripts, property names 
+follow a similar convention; those prefixed "aj-" may be deleted at will, while
+"aspectj-" names are source directories which should never be deleted.
+
+<h3>Debugging build problems</h3>
+<h4>Running under Eclipse</h4>
+When running Ant from eclipse,
+do not use the default Eclipse Ant classpath; remove those jars and
+add all the libraries in <a href="../lib/ant/lib">../lib/ant/lib</a>
+as well as in <a href="../lib/junit">../lib/junit</a>.
+<p>
+
+<h4>Why new or changed modules might not work</h4>
+The BuildModule taskdef makes some assumptions about the naming, 
+position, and contents of module directories and files.  
+Understand those (documented in 
+<a href="src/org/aspectj/internal/tools/ant/taskdefs/BuildModule.java">
+   BuildModule.java</a>) before using non-standard module directories. 
+
+<h4>Silent classpath and build failures</h4>
+<u>warning</u>: When Ant runs compile processes, sometimes Jar files
+are not closed until the process quits.  When running Ant under Eclipse,
+that means the jar files are not writable until eclipse quits.
+This affects build products (e.g., installers) which are run under eclipse
+(e.g., by opening with the "default system editor") and libraries used
+when compiling under Javac (if not zip products or input).  This problem
+presents as files not being writable, i.e., deleted or modified.
 <p>
-<hr>
+One workaround is to delete any existing build products 
+before re-creating them.  The problem with this is that Ant provides no 
+notice of that deletes fail when deleting with quiet="on", but when not
+running in quiet mode, deletes will fail if the directory does not exist.
+The workaround-workaround would be to create any required directories 
+before trying to deleting any files, with the result of creating unused
+empty directories.
 
+<p>
+Currently BuildModule tasks forks the Javac command to try to work around
+this problem, but the Zip commands do not work around it.
+
+If under Eclipse, you get strange behavior with Ant builds, clear 
+out everything and build from the command line. In some cases, you
+have to exit Eclipse before files can be deleted.  (*sigh*)
+
+<p>
 </body>
 </html>
author	wisberg <wisberg>	2003-02-27 00:39:30 +0000
committer	wisberg <wisberg>	2003-02-27 00:39:30 +0000
commit	53e98bac085b1b4e6fb0ec7d1e0227bfd14879c5 (patch)
tree	25a000895c2137f3b933389a6560e1bbb3eb9032 /build/readme-build-module.html
parent	9b1c6f8915bd8e2c9ae866caed54daf458812572 (diff)
download	aspectj-53e98bac085b1b4e6fb0ec7d1e0227bfd14879c5.tar.gz aspectj-53e98bac085b1b4e6fb0ec7d1e0227bfd14879c5.zip