SigTest Tool Repository Structure
This document describes the high-level structure of the SigTest tool source tree.
Table of Contents
- Repository structure
- Working copy structure
- Build distribution structure
Repository Structure
The SigTest tool repository has the following structure:
sigtest/
branches/ - Code branches, for off-trunk development.
tags/ - Official product release branches (for example, version 3.3). Please make no changes here.
trunk/
www/ - Web site content. Please make no changes here.
code/ - The most current development thread.
NOTE: Remember the revision number from your checkout.
If you contribute code changes, this number will be useful when you merge
your code branch back into the trunk.
Working Copy Structure
Use the Subversion checkout command to create a working
copy of the javatest/trunk/code directory. For example:
svn checkout https://svn.java.net/svn/sigtest~svn SIGTEST --username java.net_username
Your working copy (in this example, named SIGTEST) has the following structure:
SIGTEST/
build/
This directory contains the Ant build files and build
properties. You must change property values in the
build.properties file in order to successfully build
SigTest tool. For more information, see SigTest Tool Build Instructions.
examples/
This directory contains sample code which can be used to run sigtest. The SigTest User Guide describes examples which can be found in this directory.
When you build SigTest tool, the README is copied into the build-distribution.
legal/
This directory contains the Gnu Public License (2), and
copyrights that apply to this open source product.
src/
This directory contains all Java programming language source files and various
property files that are used to produce the SigTest tool binary.
Please review the SigTest Tool Developer's
Guide and SigTest Tool Source Code
Description for coding guidelines and descriptions of the various
packages included in the SigTest tool source.
Build Distribution Structure
The build distribution directory is created by the SigTest tool
Ant build, into which it generates the built binary
distribution. By default, this directory is named
sigtest-build, and it is created in the same parent
directory as the SIGTEST working copy.
The SigTest tool build distribution has the following structure:
sigtest-<VERSION>-build/
- sigtest-<VERSION>.zip
This is the bundled build product.
release/
This directory contains the finished build product - unbundled.
temp/
This directory contains temporary build products, before bundle preparation.
The structure of the release directory is the structure that one sees when unbundling the build product, sigtest-<VERSION>.zip.
README.html
document.css
examples/
This directory contains sample code which can be used to run sigtest. The SigTest User Guide describes examples which can be found in this directory.
javadoc/
A placeholder directory. Contains the output of the Javadoc™ tool when
you specify the javadoc Ant target.
legal/
Contains the Gnu Public License (2), and
Oracle copyrights that apply to this open source product.
lib/
Contains the SigTest tool binaries (sigtest.jar and sigtestdev.jar)
