Back to > Overview > Developers Guide

The build structures

Authors:
	Szabo Csaba <crow@nolimits.ro>
	Antal Attila <atech@nolimits.ro>

Table of Contents

1. Introduction
2. Using Ant
3. Targets
    3.1. The most general step
    3.2. Compiling
    3.3. Generating the packages
    3.4. Helper applications
    3.5. Documentation
    3.6. Testing
    3.7. Cleaning
    3.8. Distribution
4. Documentation
    4.1. XML
    4.2. Styles

1. Introduction

For building all types of applications, and to save a lot of time for this, we using an entire building application named Ant. In the $DATASTORE_HOME/tools/bin/ directory you can find this utility, on the other hand in the directory $DATASTORE_HOME/tools/lib/ you can find the packages for Ant.

2. Using Ant

In the base of the build staying a build.xml file. This file contains groups (targets) of commands. Those commands executes all things for build a needed application

Launching the build is very simple, only type in the command line the following:

tools/bin/ant target

What's mean the target you can see in the following chapter.

When you want to make build under Windows 98 you may get an error message: Out of environment space. To resolve this problem you must edit the config.sys file and put in the following line:

SHELL={WINDIR}\command.com /P /E:1024

Where the WINDIR is the Windows directory (ex. c:\windows)

3. Targets

3.1. The most general step

This step to execute the build is sufficient for full functionality.

main - as same with the sar target, see later

3.2. Compiling

This steps only compiles the source codes.

compile - compile all java files
antlr - compile the ANTLR grammatical files to java

3.3. Generating the packages

Here we have two special steps, other than jar, for obtaining the special Avalon packages.

jar - builds all the jar files
bar - builds the framework blocks
sar - builds the datastore.sar server file

3.4. Helper applications

DataStore have some client applications to administer the database and working with data. Other applications is the examples, which showing some ways to connect to DataStore server.

client - building the client applications
examples - building the example applications

3.5. Documentation

Steps to generate different documentations.

javadocs - builds the java API interface
xdocs - builds documentation from /src/xdocs
docs - builds all the documentation including the main target

3.6. Testing

Run the unit test, and you have problems the build is breaking down. For informations consult the log file from the logs directory

run-tests - runs all the unit tests

3.7. Cleaning

You make changes but is not taking effect, the problem is you need to clean the old builds.

clean - delete the build directory
clean-all - delete the build, apps, ext, logs directories. Remains only the source distribution codes

3.8. Distribution

Making distributions you can get all. Remember: before this run the tests.

dist - building only the binary distribution in the dist directory, unarchived, unpacked
src-dist - building only the source distribution in the dist directory, unarchived, unpacked
distributions - building all the binary distributions, archived, packed (.tar.gz) in the dist directory

4. Documentation

4.1. XML

4.2. Styles