From a78d1ddd4fd493742e9ef5fa4c52a4da7051c20a Mon Sep 17 00:00:00 2001 From: Steve Loughran Date: Sun, 30 Apr 2006 22:41:33 +0000 Subject: [PATCH] edit doc to move from CVS to SVN, more stuff on IDE/app server installs, more on how to install extra libraries. git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@398455 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/install.html | 180 +++++++++++++++++++++++++++++---------- 1 file changed, 134 insertions(+), 46 deletions(-) diff --git a/docs/manual/install.html b/docs/manual/install.html index 37950c11f..6d7e47fc0 100644 --- a/docs/manual/install.html +++ b/docs/manual/install.html @@ -13,22 +13,63 @@

The latest stable version of Ant is available from the Ant web page http://ant.apache.org/. -If you like living on the edge, you can download the latest version from http://cvs.apache.org/builds/ant/nightly/.

-

Source Edition

+

As a binary in an RPM Package

+ +

Consult the jpackage section below.

-

If you prefer the source edition, you can download the source for the latest Ant release from http://ant.apache.org/srcdownload.cgi. +

Bundled in IDEs

+

+ All the main Java IDEs ship with Ant, products such as Eclipse, NetBeans + and IntelliJ IDEA. If you install Ant this way you usually get the most recent + release of Ant at the time the IDE was released. Some of the IDEs (Eclipse + and NetBeans in particular) ship with extra tasks that only work if + IDE-specific tools are on Ant's path. To use these on command-line versions + of Ant, the relevant JARs need to be added to the command-line Ant as + extra libraries/tasks. Note that if it is an IDE task or extension that is + not behaving, the Ant team is unable to field bug reports. Try the IDE mailing + lists first, who will cross-file bugs if appropriate. +

+

+ IDE's can invariably be pointed at different Ant installations. This lets + developers upgrade to a new release of Ant, and eliminate inconsistencies + between command-line and IDE Ant. +

-Again, if you prefer the edge, you can access -the code as it is being developed via CVS. The Jakarta website has details on -accessing CVS. Please checkout the -ant module. +

Bundled in Java applications

+ +

+ Many Java applications, most particularly application servers, ship with + a version of Ant. These are primarily for internal use by the application, + using the Java APIs to delegate tasks such as JSP page compilation to the Ant + runtime. Such distributions are usually unsupported by everyone. Particularly + troublesome are those products that non only ship with their own Ant release, + they add their own version of ANT.BAT or ant.sh to the PATH. If Ant starts + behaving wierdly after installing something, try the + diagnostics advice. +

+ +

Source Edition

+

If you prefer the source edition, you can download the source for the latest +Ant release from +http://ant.apache.org/srcdownload.cgi. + +If you prefer the leading-edge code, you can access +the code as it is being developed via SVN. The Ant website has details on +accessing SVN. +All bug fixes will go in against the HEAD of the source tree, and the first +response to many bugreps will be "have you tried the latest version". +Don't be afraid to download and build a prererelease edition, as everything +other than new features are usually stable. +

+

+ + See the section Building Ant on how to build Ant from the source code. You can also access the - -Ant CVS repository on-line.

+ +Ant SVN repository on-line.

System Requirements

@@ -37,10 +78,10 @@ commercial flavours of Unix such as Solaris and HP-UX, Windows 9x and NT, OS/2 Warp, Novell Netware 6, OpenVMS and MacOS X. The platforms used most for development are, in no particular order, Linux, MacOS X, Windows XP and Unix; these are therefore that platforms -that work best. +that tend to work best.

To build and use Ant, you must have a JAXP-compliant XML parser installed and -available on your classpath.

+available on your classpath, such as Xerces.

The binary distribution of Ant includes the latest version of the Apache Xerces2 XML parser. @@ -50,8 +91,8 @@ for more information about JAXP. If you wish to use a different JAXP-compliant parser, you should remove xercesImpl.jar and xml-apis.jar from Ant's lib directory. - -You can then either put the jars from your preferred parser into Ant's +

+You can then either put the JARs of your preferred parser into Ant's lib directory or put the jars on the system classpath. Some parts of Ant will fail if you use an old parser, especially one that is not namespace-aware. In particular, avoid the Crimson parser.

@@ -60,7 +101,8 @@ that is not namespace-aware. In particular, avoid the Crimson parser.

For the current version of Ant, you will also need a JDK installed on -your system, version 1.2 or later. +your system, version 1.2 or later required, 1.5 or later strongly recommended. +The later the version of Java , the more Ant tasks you get.

Note #2: If a JDK is not present, only the JRE runtime, then many tasks will not work. @@ -76,7 +118,6 @@ your system, version 1.2 or later. +--- lib // contains Ant jars plus necessary dependencies | +--- docs // contains documentation - | +--- ant2 // a brief description of ant2 requirements | | | +--- images // various logos for html documentation | | @@ -92,7 +133,7 @@ Only the bin and lib directories are required to run Ant. To install Ant, choose a directory and copy the distribution -file there. This directory will be known as ANT_HOME. +files there. This directory will be known as ANT_HOME.

@@ -133,8 +174,8 @@ version from jpackage.org:

On most occasions you will not need to explicitly bootstrap Ant since the build @@ -400,13 +478,13 @@ If you wish to install the build into the current ANT_HOME directory, you can use:

build install    (Windows)

-

build.sh install    (Unix)

+

sh build.sh install    (Unix)

You can avoid the lengthy Javadoc step, if desired, with:

build install-lite    (Windows)

-

build.sh install-lite    (Unix)

+

sh build.sh install-lite    (Unix)

This will only install the bin and lib directories.

Both the install and @@ -421,7 +499,7 @@ indicated feature. Note that only one of the regexp libraries is needed for use with the mappers (and Java 1.4 and higher includes a regexp implementation which Ant will find automatically). -You will also need to install the +You will also need to install the particular Ant optional jar containing the task definitions to make these tasks available. Please refer to the Installing Ant / Optional Tasks section above.

@@ -530,7 +608,7 @@ you need jakarta-oro 2.0.1 or later, and commons-net< @@ -586,7 +664,7 @@ you need jakarta-oro 2.0.1 or later, and commons-net< +Already included Java 1.4+ @@ -633,6 +711,8 @@ code will check and print the following things.

-Running ant -diagnostics is a good way to check that ant is installed. It is also a first step towards self-diagnosis of any problem. Any configuration problem reported to the user mailing list will probably result ins someone asking you to run the command and show the results, so save time by using it yourself. + Running ant -diagnostics is a good way to check that ant is + installed. It is also a first step towards self-diagnosis of any problem. + Any configuration problem reported to the user mailing list will probably + result ins someone asking you to run the command and show the results, so + save time by using it yourself.

-For under-IDE diagostics, use the <diagnostics> task to run the same tests as an ant task. This can be added to a diagnostics target in a build file to see what tasks are available under the IDE, what the XML parser and classpath is, etc. + For under-IDE diagostics, use the <diagnostics> task to run the same + tests as an ant task. This can be added to a diagnostics target in a build + file to see what tasks are available under the IDE, what the XML parser and + classpath is, etc.

user mailing list

If you cannot get Ant installed or working, the Ant user mailing list is the best place to start with any problem. Please do your homework first, make sure -that it is not a CLASSPATH problem, and run a diagnostics check to see what Ant thinks of its own -state. Why the user list, and not the developer list? Because there are more users than developers, so more people who can help you.

+that it is not a CLASSPATH problem, and run a diagnostics check to see what Ant thinks of its own +state. Why the user list, and not the developer list? +Because there are more users than developers, so more people who can help you.

BeanShell JAR(s) BeanShell with script task.
- Note: Ant 1.6 and later require BeanShell version 1.3 or + Note: Ant requires BeanShell version 1.3 or later		 http://www.beanshell.org/
Support for SMTP over TLS/SSL
in the Mail task
-Already included in jdk 1.4		 http://java.sun.com/products/jsse/