From 32b5622cabeecb2db814809fad3de0bca204dd9c Mon Sep 17 00:00:00 2001 From: Diane Holt Date: Thu, 13 Dec 2001 17:16:26 +0000 Subject: [PATCH] Add TOCs for Installing, Using, Running, Developing; add some name tags; clean-up tweaks here&there. PR: Obtained from: Submitted by: Reviewed by: git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@270139 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/developlist.html | 21 ++++++++++++ docs/manual/index.html | 2 +- docs/manual/installlist.html | 22 +++++++++++++ docs/manual/running.html | 64 ++++++++++++++++++++---------------- docs/manual/runninglist.html | 22 +++++++++++++ docs/manual/toc.html | 8 ++--- docs/manual/using.html | 33 ++++++++++--------- docs/manual/usinglist.html | 28 ++++++++++++++++ 8 files changed, 151 insertions(+), 49 deletions(-) create mode 100644 docs/manual/developlist.html create mode 100644 docs/manual/installlist.html create mode 100644 docs/manual/runninglist.html create mode 100644 docs/manual/usinglist.html diff --git a/docs/manual/developlist.html b/docs/manual/developlist.html new file mode 100644 index 000000000..82efc7795 --- /dev/null +++ b/docs/manual/developlist.html @@ -0,0 +1,21 @@ + + + + +Apache Ant User Manual + + + + + +

Table of Contents

+ +

Developing with Ant

+ +Writing Your Own Task
+Build Events
+Source-code Integration
+ + + + diff --git a/docs/manual/index.html b/docs/manual/index.html index 18be35d54..569b8fa60 100644 --- a/docs/manual/index.html +++ b/docs/manual/index.html @@ -5,7 +5,7 @@ Apache Ant User Manual - + diff --git a/docs/manual/installlist.html b/docs/manual/installlist.html new file mode 100644 index 000000000..fd4442a49 --- /dev/null +++ b/docs/manual/installlist.html @@ -0,0 +1,22 @@ + + + + +Apache Ant User Manual + + + + + +

Table of Contents

+ +

Installing Ant

+Getting Ant
+System Requirements
+Installing Ant
+Building Ant
+Library Dependencies
+ + + + diff --git a/docs/manual/running.html b/docs/manual/running.html index 4f442074e..b70685bae 100644 --- a/docs/manual/running.html +++ b/docs/manual/running.html @@ -8,50 +8,58 @@

Running Ant

-

Running Ant is simple, when you installed it as described in the previous -section. Just type ant.

-

When nothing is specified, Ant looks for a build.xml -file in the current directory. If found, it uses that file as the -buildfile. If you use the -find option, -Ant will search for a buildfile in -the parent directory, and so on, until the root of the filesystem -has been reached. To make Ant use -another buildfile, use the command-line +

Command Line

+

If you've installed Ant as described in the + Installing Ant section, +running Ant from the command-line is simple: just type +ant.

+

When no arguments are specified, Ant looks for a build.xml +file in the current directory and, if found, uses that file as the +buildfile and runs the "default" target. +If you use the -find option, +Ant will search for a buildfile first in the current directory, then in +the parent directory, and so on, until either a buildfile is found or the root +of the filesystem has been reached. To make Ant use +a buildfile other than build.xml, use the command-line option -buildfile file, -where file is the buildfile you want to use.

+where file is the name of the buildfile you want to use.

-

You can also set properties that override properties specified in the +

You can also set properties that +override properties specified in the buildfile (see the property task). This can be done with the -Dproperty=value option, where property is the name of the property, and value is the value for that property. -This can also be used to pass in the value of some environment variables. -You can also access environment variables using the -property task. - +This can also be used to pass in the value of environment variables. Just pass -DMYVAR=%MYVAR% (Windows) or -DMYVAR=$MYVAR (Unix) to Ant - you can then access -these variables inside your buildfile as ${MYVAR}.

+these variables inside your buildfile as ${MYVAR}. +You can also access environment variables using the +property task. +

-

Two more options are: -quiet, +

Options that affect the amount of logging output by Ant are: -quiet, which instructs Ant to print less -information on the console when running, and +information on the console when running; -verbose, which causes Ant to print -additional information to the console.

+additional information to the console; and -debug, +which causes Ant to print considerably more additional information. +

It is also possible to specify one or more targets that should be executed. When omitted, the target that is specified in the -default attribute of the <project> tag is +default attribute of the +project tag is used.

-

The -projecthelp option prints out the -description of the project, if it exists, followed by a list of this -project's targets. First those with a description, then those without -one.

+

The -projecthelp option prints out a list +of the buildfile's targets, along with the +text in the description attribute of the target, +if one was specified, followed by a list of those targets without one.

-

Command-line option summary:

+

Command-line Options Summary

ant [options] [target [target2 [target3] ...]]
 Options:
 -help                  print this message
@@ -91,7 +99,7 @@ target called dist.
 target called dist, setting the build property to the
 value build/classes.
 
-Files
+Files
 
 The Ant wrapper script for Unix will source (read and evaluate) the
 file ~/.antrc before it does anything - the Windows batch
@@ -100,7 +108,7 @@ file invokes %HOME%\antrc_pre.bat at the start and
 files to set/unset environment variables that should only be visible
 during the execution of Ant.  See the next section for example.
 
-Environment Variables
+Environment Variables
 
 The wrapper scripts use the following environment variables (if
 set):
@@ -118,7 +126,7 @@ set):
   include the -find flag.
 
 
-Running Ant by Hand
+Running Ant via Java
 If you have installed Ant in the do-it-yourself way, Ant can be started
 with:
 
diff --git a/docs/manual/runninglist.html b/docs/manual/runninglist.html
new file mode 100644
index 000000000..96bf23541
--- /dev/null
+++ b/docs/manual/runninglist.html
@@ -0,0 +1,22 @@
+
+
+
+
+Apache Ant User Manual
+
+
+
+
+
+Table of Contents
+
+Running Ant
+Command Line

+    Options

+    Files

+    Environment Variables

+Running Ant via Java

+
+
+
+
diff --git a/docs/manual/toc.html b/docs/manual/toc.html
index c6776fa7f..0c878c47c 100644
--- a/docs/manual/toc.html
+++ b/docs/manual/toc.html
@@ -10,13 +10,13 @@
 
 Table of Contents
 Introduction

-Installing Ant

-Running Ant

-Using Ant

+Installing Ant

+Using Ant

+Running Ant

 Built-in Tasks

 Optional Tasks

 Editor/IDE Integration

-Developing with Ant

+Developing with Ant

 Ant API

 License

 Feedback


diff --git a/docs/manual/using.html b/docs/manual/using.html
index 7a66ba34b..f63c5f535 100644
--- a/docs/manual/using.html
+++ b/docs/manual/using.html
@@ -8,12 +8,13 @@
 
 Using Ant
 Writing a Simple Buildfile
-Ant's buildfiles are written in XML. Each buildfile contains one project.
-Each task element of the buildfile can have an id attribute and
+
Ant's buildfiles are written in XML. Each buildfile contains one project
+and at least one (default) target. Targets contain task elements.
+Each task element of the buildfile can have an id attribute and
 can later be referred to by the value supplied to this. The value has
 to be unique. (For additional information, see the
  Tasks section below.)
-Projects
+Projects
 A project has three attributes:
 
@@ -43,7 +44,7 @@ to be unique. (For additional information, see the
   
   
 
 Optionally, a description for the project can be provided as a
-top-level <description> element (see the <description> element (see the description type).
 
 Each project defines one or more targets.
@@ -52,7 +53,7 @@ to be executed. When starting Ant, you can select which target(s) you
 want to have executed. When no target is given,
 the project's default is used.
 
-Targets
+Targets
 A target can depend on other targets. You might have a target for compiling,
 for example, and a target for creating a distributable. You can only build a
 distributable when you have compiled first, so the distribute target
@@ -161,7 +162,7 @@ Tasks can be assigned an id attribute:
 
<taskname id="taskID" ... />
 
 where taskname is the name of the task, and taskID is
-a unique name for this task.
+a unique identifier for this task.
 You can refer to the
 corresponding task object in scripts or other tasks via this name.
 For example, in scripts you could do:
@@ -187,17 +188,17 @@ be backward-compatible with this behaviour, since there will likely be no
 task instances at all, only proxies.
 
 
-Properties
+Properties
 A project can have a set of properties. These might be set in the buildfile
-by the property task, or might be set outside Ant. A
-property has a name and a value, the name is case sensitive. Properties may be used in the value of
+by the property task, or might be set outside Ant. A
+property has a name and a value; the name is case-sensitive. Properties may be used in the value of
 task attributes. This is done by placing the property name between
 "${" and "}" in the
 attribute value. For example,
 if there is a "builddir" property with the value
 "build", then this could be used in an attribute like this:
 ${builddir}/classes.
-This is resolved as build/classes.
+This is resolved at run-time as build/classes.
 
 Built-in Properties
 Ant provides access to all system properties as if they had been
@@ -219,7 +220,7 @@ ant.java.version    the JVM version Ant detected; currently it can hold
                     the values "1.1", "1.2", "1.3" and "1.4".

-

Example

+

Example Buildfile

 <project name="MyProject" default="dist" basedir=".">
 
@@ -256,16 +257,16 @@ ant.java.version    the JVM version Ant detected; currently it can hold
 </project>

-

Token Filters

+

Token Filters

A project can have a set of tokens that might be automatically expanded if found when a file is copied, when the filtering-copy behavior is selected in the tasks that support this. These might be set in the buildfile -by the filter task.

+by the filter task.

Since this can potentially be a very harmful behavior, the tokens in the files must be of the form @token@, where token is the token name that is set -in the filter task. This token syntax matches the syntax of other build systems +in the <filter> task. This token syntax matches the syntax of other build systems that perform such filtering and remains sufficiently orthogonal to most programming and scripting languages, as well as with documentation systems.

Note: If a token with the format @token@ @@ -411,9 +412,9 @@ that contain space characters, nested arg elements can be used.

References

The id attribute of the buildfile's elements can be -used to refer to them. This can useful if you are going to replicate +used to refer to them. This can be useful if you are going to replicate the same snippet of XML over and over again - using a -<classpath> structure more than once for +<classpath> structure more than once, for example.

The following example:

diff --git a/docs/manual/usinglist.html b/docs/manual/usinglist.html
new file mode 100644
index 000000000..113b32cf3
--- /dev/null
+++ b/docs/manual/usinglist.html
@@ -0,0 +1,28 @@
+
+
+
+
+Apache Ant User Manual
+
+
+
+
+
+Table of Contents
+
+Using Ant
+Writing a Simple Buildfile

+    Projects

+    Targets

+    Tasks

+    Properties

+    Built-in Properties

+    Example Buildfile

+    Token Filters

+    Path-like Structures

+    Command-line Arguments

+    References

+
+
+
+