The following paragraphs describe each of the targets specified in the armidale ant build file (<install_dir>/developer/build.xml).
The clean target performs the following operations.
1. Deletes the build directory tree created by the prepare target.
2. Deletes all .class files from the developer/src directory tree.
3. Deletes all files ending with tilde (ie. ~) from the developer/src directory tree.
The prepare target creates the following directories in the armidale installation directory (if they don't already exist).
build
build/classes
build/jars
build/distribution
backups
The compile_all target performs the following operations.
1. Invokes the prepare target.
2. Compiles all Java source files found in the developer/src directory tree.
The compile_utilities target performs the following operations.
1. Invokes the prepare target.
2. Compiles all Java source files found in the developer/src/armidale/utilities directory tree.
This target is useful when making changes to the armidale.utilities.MakeClass widget code generation program. Changes will often lead to the generation of code that will not compile!
The build_javadoc target performs the following operations.
1. Invokes the prepare target.
2. Generates javadoc documentation for the following armidale packages. The resulting documentation is placed in the development/javadoc directory tree.
armidale.api.api.* (excluding armidale.api.impl.* and armidale.api.gui.impl.*)
armidale.api.launcher.*
armidale.api.test.*
armidale.api.utilities.*
The build_jar target performs the following operations.
1. Invokes the compile_all target.
2. Generates the main armidale jar file in build/jars/armidale.jar. This jar contains all of the compiled armidale classes.
The build_distribution target performs the following operations.
1. Invokes the compile_all, build_javadoc, and build_jar targets.
2. Generates the following jars which comprise the standard armidale distribution. They will be placed in the build/distribution directory.
armidale-<version>-user.jar
armidale-<version>-documentation.jar
armidale-<version>-developer.jar
where:
<version> in the above file names is a version number like 0.9.2 (eg. armidale-0.9.2-user.jar).
See the User Installation and Developer Installation notes for more information about these jars.
The backup target performs the following operations.
1. Invokes the prepare target.
2. Creates a backup of the development system in a compressed tar file stored in the backups directory. The name of the back file includes the date, time and armidale version as showing the following example.
20020301_1452_armidale-0.9.2.tgz
The help target will list each target along with a brief description.
The show_config target will list each of the variables used by the armidale build system.