diff --git a/docs/manual/projecthelper.html b/docs/manual/projecthelper.html index ac84f749b..e4e34d256 100644 --- a/docs/manual/projecthelper.html +++ b/docs/manual/projecthelper.html @@ -28,20 +28,21 @@

What is a ProjectHelper?

-The ProjectHelper in Ant is responsible to parse the build file -and create java instances representing the build workflow. It also declares which +The ProjectHelper in Ant is responsible for parsing the build file +and creating java instances representing the build workflow. It also signals which kind of file it can parse, and which file name it expects as default input file.

+

-So in Ant there is a default ProjectHelper -(org.apache.tools.ant.helper.ProjectHelper2) which will parse the +Ant' default ProjectHelper +(org.apache.tools.ant.helper.ProjectHelper2) parses the usual build.xml files. And if no build file is specified on the command line, it -will expect to find a build.xml file. +will expect to find a file named build.xml.

The immediate benefit of a such abstraction it that it is possible to make Ant -understand other kind of descriptive language than XML. Some experiment have +understand other kind of descriptive languages than XML. Some experiments have been done around a pure java frontend, and a groovy one too (ask the dev mailing list for further info about these).

@@ -49,12 +50,12 @@ list for further info about these).

How is Ant is selecting the proper ProjectHelper

-Ant can now know about several implementations of ProjectHelper -and have to decide which to use for each build file. +Ant knows about several implementations of ProjectHelper +and has to decide which to use for each build file.

-

So Ant at startup will list the found implementations and will keep it -ordered as it finds them in an internal 'repository': +

At startup Ant lists the all implementations found and keeps them +in the same order they've been found in an internal 'repository':

-In case of error while trying to instanciate a ProjectHelper, Ant -will log an error but still won't stop. If you want further debugging -info about the ProjectHelper internal 'repository', use the system +In case of an error while trying to instanciate a ProjectHelper, Ant +will log an error but won't stop. If you want further debugging +info about the ProjectHelper internal 'repository', use the system property ant.project-helper-repo.debug and set it to true; the full stack trace will then also be printed.

-Then when Ant is expected to parse a file, it will ask the -ProjectHelper repository to found an implementation that will be -able to parse the input file. Actually it will just iterate on the ordered list +When Ant is expected to parse a file, it will ask the +ProjectHelper repository to find an implementation that will be +able to parse the input file. Actually it will just iterate over the ordered list and the first implementation that returns true to supportsBuildFile(File buildFile) will be selected.

-And when Ant is launching and there is no input file specified, it will search for -a default input file. It will iterate on the list of ProjectHelper +When Ant is started and no input file has been specified, it will search for +a default input file. It will iterate over list of ProjectHelpers and will select the first one that expects a default file that actually exist.

@@ -102,7 +103,7 @@ constructor with no arguments.

-Then there are some functions that will help you define what your helper is +There are some functions that will help you define what your helper is capable of and what is is expecting: