replaced "process" with "target"; modified section about ant.

This commit is contained in:
Tobi Schäfer 2001-11-14 16:22:43 +00:00
parent 31d1c925c4
commit 22c5a32feb

View file

@ -14,27 +14,27 @@ The build directory consists of the following files:
PREREQUISITES PREREQUISITES
============= =============
To build Helma you need a software called Ant. Ant is a build system that was developed for the Jakarta Tomcat project. For more information about Ant, see <http://jakarta.apache.org/ant/>. The Helma build script is using a software called Ant. Ant is a build system that was developed for the Jakarta Tomcat project. For more information about Ant, see <http://jakarta.apache.org/ant/>.
To run Ant, you also need JDK 1.3 or higher <http://java.sun.com/j2se/>. To run Ant, you also need JDK 1.3 or higher <http://java.sun.com/j2se/>.
For checking out the source files from Helma's CVS you also need a local installation of a CVS command-line client. More information about CVS at <http://www.cvshome.org/>. For checking out the source files from Helma's CVS you also need a local installation of a CVS command-line client. More information about CVS at <http://www.cvshome.org/>.
STARTING BUILD PROCESSES STARTING BUILD
======================== ==============
A build process is started by invoking the shell script appropriate to your platform, ie. build.sh for *nix (Linux, NetBSD etc.) and build.bat for Windows systems. The build system is started by invoking the shell script appropriate to your platform, ie. build.sh for *nix (Linux, NetBSD etc.) and build.bat for Windows systems.
The generic syntax is The generic syntax is
./build process ./build target
The parameter "process" specifies one of the following build processes. The parameter "target" specifies one of the following build targets.
BUILD PROCESSES BUILD TARGETS
=============== =============
checkout checkout
Fetches (or updates, resp.) the Helma source files from the CVS and copies them into the src/ directory (which will be created if necessary). Fetches (or updates, resp.) the Helma source files from the CVS and copies them into the src/ directory (which will be created if necessary).
@ -49,7 +49,7 @@ javadoc
Creates the Java API documentation for the Helma classes. The resulting files are saved into the docs/apidocs/ directory (which will be created if necessary). Creates the Java API documentation for the Helma classes. The resulting files are saved into the docs/apidocs/ directory (which will be created if necessary).
package package
Executes all previous build processes (checkout, compile, jar, javadoc) and saves the created files in the directory helma-1.x/ (with 1.x being the version number). All directories will be created if necessary. Builds all previous targets (checkout, compile, jar, javadoc) and saves the created files in the directory helma-1.x/ (with 1.x being the version number). All directories will be created if necessary.
package-zip package-zip
Same as "package". Additionally, the files in the output directory will be compressed as .zip file. Same as "package". Additionally, the files in the output directory will be compressed as .zip file.
@ -58,7 +58,7 @@ package-tgz
Same as "package". Additionall, the file in the output directory will be compressed as .tar.gz file. Same as "package". Additionall, the file in the output directory will be compressed as .tar.gz file.
package-all package-all
Executes all previous build processes. The result is a complete and up-to-date (as in the CVS) installation of Helma, the API documentation, source and build files as well as compressed packages for *nix and Windows systems including all the files. Builds all previous targets. The result is a complete and up-to-date (as in the CVS) installation of Helma, the API documentation, source and build files as well as compressed packages for *nix and Windows systems including all the files.
-- --