From 559859ef43a7d03b5f17ff1121f9d3e7a5c79656 Mon Sep 17 00:00:00 2001 From: Conor MacNeill Date: Tue, 27 Jun 2000 13:07:34 +0000 Subject: [PATCH] Update documentation Add section on system requirements Remove references to xml.jar and replace with JAXP compliant XML parser Add section on build events. Basic information only Add an example of nested include and exclude tag usage Update documentation for Replace task git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@267707 13f79535-47bb-0310-9956-ffa450edef68 --- docs/index.html | 129 ++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 113 insertions(+), 16 deletions(-) diff --git a/docs/index.html b/docs/index.html index e50252d44..99fdd70c8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -17,17 +17,19 @@
  • Tom Dimock (tad1@cornell.edu)
  • Bill Kelly (bill.kelly@softwired-inc.com)
  • Arnout J. Kuiper (ajkuiper@wxs.nl)
    • +
  • Conor MacNeill (conor@cortexebusiness.com.au)
  • Stefano Mazzocchi (stefano@apache.org)
  • Sam Ruby (rubys@us.ibm.com)
    • -

    Version 1.0.8.1 - 2000/06/13

    +

    Version 1.0.8.1 - 2000/06/27

    Table of Contents

    +

    Introduction

    Ant is a Java based build tool. In theory it is kind of like make without @@ -68,6 +72,7 @@ gives you the ability to be cross platform. To work anywhere and everywhere. And hey, if you really need to execute a shell command, Ant has an exec rule that allows different commands to be executed based on the OS that it is executing on.

    +

    Getting Ant

    Binary edition

    @@ -82,14 +87,20 @@ href="http://jakarta.apache.org/builds/tomcat/release/v3.0/src/jakarta-tools.src href="http://jakarta.apache.org/from-cvs/jakarta-tools/">http://jakarta.apache.org/from-cvs/jakarta-ant/ (current). See the section Building Ant on how to build Ant from the source code.

    +
    -

    Building Ant

    +

    System Requirements

    - Download and install the Java API for XML Parsing kit from - http://java.sun.com/xml. - Make sure the "jaxp.jar" and "parser.jar" files are in your class - path. -

    + To build and use ant you must have a JAXP compilant XML parser installed and available on your classpath. +

    + If you do not have a JAXP compliant XML parse installed, you may use the reference implementation + available from Sun. It is available from http://java.sun.com/xml. + Once installed make sure the "jaxp.jar" and "parser.jar" files are in your classpath. +

    + You will also need the JDK installed on your system, version 1.1 or later. + +

    +

    Building Ant

    Go to the directory jakarta-ant.

    Make sure the JDK is in you path.

    Run bootstrap.bat (Windows) or bootstrap.sh (UNIX) @@ -131,11 +142,13 @@ export PATH=${PATH}:${ANT_HOME}/bin

    Advanced

    There are lots of variants that can be used to run Ant. What you need is at least the following:

    -

    The classpath for Ant must contain ant.jar and xml.jar.

    +

    The classpath for Ant must contain ant.jar and any jars/classes +needed for your chosen JAXP compliant XML parser.

    When you need JDK functionality (like a javac task, or a rmic task), then for JDK 1.1, the classes.zip file of the JDK must be added to the classpath; for JDK 1.2, tools.jar -must be added.

    +must be added. The scripts supplied with ant, in the bin directory, will add +tools.jar automatically if the JAVA_HOME environment variable is set.

    When you are executing platform specific applications (like the exec task, or the cvs task), the property ant.home must be set to the directory containing a bin directory, which contains the antRun shell script necessary to run execs on Unix.

    @@ -163,9 +176,11 @@ commandline.

    ant [options] [target]
 Options:
 -help                  print this message
+-version               print the version information and exit
 -quiet                 be extra quiet
 -verbose               be extra verbose
 -logfile <file>        use given file for log
+-listener <classname>  add an instance of class as a project listener
 -buildfile <file>      use given buildfile
 -D<property>=<value>   use value for given property

    Examples

    @@ -194,12 +209,17 @@ value build/classes.

    When you have installed Ant in the do-it-yourself way, Ant can be started with:

    - 
    set CLASSPATH=c:\ant\lib\ant.jar;c:\ant\lib\xml.jar;c:\jdk1.2.2\lib\tools.jar
-java -Dant.home=c:\ant org.apache.tools.ant.Main [options] [target]
    + 
    java -Dant.home=c:\ant org.apache.tools.ant.Main [options] [target]
    +

    These instructions actually do exactly the same as the ant command. The options and target are the same as when running Ant with the ant -command.

    +command. This example assumes you have set up your classpath to include +

    Writing a simple buildfile

    The buildfile is written in XML. Each buildfile contains one project.

    @@ -359,13 +379,14 @@ this should not cause problems.

    </project> +

    Directory based tasks

    Some tasks use directory trees for the task they perform. For instance, the Javac task which works upon a directory tree with .java files. Sometimes it can be very useful to work on a subset of that directory tree. This section describes how you can select a subset of such a directory tree.

    -

    Ant gives you two ways to create a subset, which both can be used at the same +

    Ant gives you two ways to create a subset, both of which can be used at the same time: