AsmTools Repository Structure
This document describes the high-level structure of the AsmTools source tree.
Table of Contents
|Table of Contents
The AsmTools repository currently has a very flat Mercurial structure to it (vs SVN). The content of this section will be updated as a less flat forest structure evolves.
Working Copy Structure
Your working copy (in this example, named ATOS) has the following structure:
This directory contains the Ant build files and build properties. You must change property values in the local.properties file in order to successfully build AsmTools. For more information, see AsmTools Build Instructions.
This directory contains release documentation that is copied to the build distribution directory as part of the build process.
When you build AsmTools, the release notes are copied into the build-distribution.
This directory contains the source files required to create the examples in the binary release. The examples can only be built by building the product.
This directory contains the Gnu Public License (2), and copyrights that apply to this open source product.
This directory contains all Java programming language source files and various property files that are used to produce the AsmTools binary.
Contains source files for tests used to test the product, both during the build and manually.
Please review the AsmTools Developer's Guide and AsmTools Source Code Description for coding guidelines and descriptions of the various packages included in the AsmTools source.
Build Distribution Structure
The build distribution directory is created by the JT harness Ant build, into which it generates the built binary distribution. By default, this directory is named
asmtools-build, and it is created in the same parent directory as the ATOS working copy.
The AsmTools build output directory has the following structure:
Contains the Gnu Public License (2), and Oracle copyrights that apply to this open source product. Also contains the README.html
This directory contains the entire unbundled distribution. It includes the binary and documentation files required to execute the AsmTools.
Contains the AsmTools binary (asmtools.jar)
Contains documentation that accompanies the AsmTools product. The release notes from the working copy are copied to this location.
Contains the asmtools.zip file. This Zip archive contains the entire AsmTools distribution including documentation, examples, and sample code (the contents of the binaries directory).
Contains intermediate binaries produced during the build process.
A placeholder directory. Contains the output of the Javadoc™ tool when you specify the javadoc Ant target.