Date: Wed, 19 Jan 2005 23:15:26 +0000
Subject: [PATCH] gave up on xdoc updates for now; did the libraries task by
hand. minor updates of nice + mapper.
git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@277392 13f79535-47bb-0310-9956-ffa450edef68
---
docs/manual/CoreTasks/libraries.html | 391 +++++++++++++++++++++++++++
docs/manual/CoreTasks/nice.html | 6 +-
docs/manual/api/index.html | 46 +++-
docs/manual/coretasklist.html | 1 +
4 files changed, 431 insertions(+), 13 deletions(-)
create mode 100644 docs/manual/CoreTasks/libraries.html
diff --git a/docs/manual/CoreTasks/libraries.html b/docs/manual/CoreTasks/libraries.html
new file mode 100644
index 000000000..e884ee074
--- /dev/null
+++ b/docs/manual/CoreTasks/libraries.html
@@ -0,0 +1,391 @@
+
+
+
+
+Libraries Task
+
+
+
+
+
+Description
+
+
+ Extensible library download mechanism, integrated with the
+ Maven repository hosted
+ at ibiblio.org.
+
+
+
+
+ This task can:
+
+
+ - Download publicly published JAR files by version.
+ - Download JAR files from private file: or http: repositories
+ - Cache the JAR files in a directory tree
+ - Check for updates on a regular schedule
+ - Build paths for compilation/execution.
+ - Fail the build if needed libraries are missing
+ - Force an update of all libraries
+ - Skip all downloading when offline
+
+
+Parameters
+
+
+ Attribute |
+ Description |
+ Required |
+
+
+ destDir |
+ Destination directory for all downloads
+ |
+ Yes |
+
+
+ offline |
+ Flag to indicate that the system is offline, and that
+ no downloads should take place.
+ |
+ No |
+
+
+ flatten |
+ flag to indicate that files should be flattened when downloaded
+ |
+ No -default false |
+
+
+ pathID |
+ Name of a path to create containing all
+ libraries in this declaration.
+ |
+ No |
+
+
+ repositoryRef |
+ Reference to a predefined repository
+ |
+ Only if no repository is defined inline |
+
+
+
+
+
+Nested Elements
+
+
+library
+This is the core of the system; a library to (potentially) download.
+
+
+
+ Attribute |
+ Description |
+ Required |
+
+
+ project |
+ Name of the project
+ |
+ Yes |
+
+
+ version |
+
+ |
+ Yes |
+
+
+ archive |
+ Name of the archive
+ |
+ No |
+
+
+ destinationName |
+ Filename of downloaded file
+ |
+ No, default remote name |
+
+
+
+ suffix |
+ Suffix of the archive
+ |
+ No -default ".jar" |
+
+
+ enabled |
+ flag to turn on or off specific download/use
+ of an archive
+ |
+ No -default "true" |
+
+
+
+Repository
+
+A repository is Ant datatype that extends the Repository
type.
+Ant only ships with one: the mavenrepository;
+
+
+
+ Attribute |
+ Description |
+ Required |
+
+
+ url |
+ URL of the repository
+ |
+ No |
+
+
+ |
+
+ |
+ No |
+
+
+
+Example:
+
+ <repository ref="predefined.repository" />
+
+
+mavenrepository
+
+
+
+ Attribute |
+ Description |
+ Required |
+
+
+ url |
+ URL of the repository
+ |
+ No |
+
+
+ checkMD5 |
+ Flag to turn on MD5 checking
+ (unimplemented)
+ |
+ No |
+
+
+ username |
+ HTTP authentication username
+ |
+ No |
+
+
+ password |
+ HTTP authentication password
+ |
+ Only if username is set |
+
+
+
+UpdatePolicies
+
+Update policies are an (extensible) means of tuning the download, running
+code before and possibly after a download. They can enable or disable
+checks for individual files, skip the download process, or perform some
+post-download validation.
+
+
+All policies have at least the common set of attributes; some may have more,
+in which case an updated attribute list is shown.
+
+
+
+ Attribute |
+ Description |
+ Required |
+
+
+ enabled |
+ Enabled flag
+ |
+ No -default "true" |
+
+
+
+Policies can be chained by listing them in order. Before an update/download
+takes place, all policies will be executed in order. After the download, the
+policies will be invoked in reverse order. The compound policy in such a
+situation is left to the experimentor, though reading the source will help.
+
+
+
+Developers may add new polices (such
+as signing incoming files) by adding new datatypes extending the
+LibraryPolicy
class.
+
+noupdate
+
+This policy will disable remote downloads when enabled. It is the policy
+equivalent of the offline flag.
+
+
+Example:
+
+ <noupdate />
+
+
+forceupdate
+
+This policy forces all libraries to be downloaded. If any download failed,
+the build will halt.
+Example:
+
+ <forceupdate />
+
+
+timestamp
+
+This policy tells Ant to check the repository to see if the files have changed
+using timestamp checks. Any files which are up to date will not be downloaded again.
+
+Example:
+
+ <timestamp />
+
+
+scheduledupdate
+
+This policy tells Ant to check the repository to see if the files have changed,
+but only intermittently. An interval of the size of the schedule has to have
+passed, or the set of files to check has to have changed.
+
+
+
+ Attribute |
+ Description |
+ Required |
+
+
+ enabled |
+ Enabled flag
+ |
+ No -default "true" |
+
+
+ markerFile |
+ Name of a file to cache download history
+ |
+ Yes |
+
+
+ Days |
+ number of days between update checks
+ |
+ No |
+
+
+ Hours |
+ number of hours between update checks
+ |
+ No |
+
+
+ Minutes |
+ number of minutes between update checks
+ |
+ No |
+
+
+
+Example:
+
+ <scheduledupdate days="1" hours="3" minutes="17" />
+
+
+Check for an update every 27 hours, 17 minutes.
+
+
+assertdownloaded
+
+This policy is really for testing the library. It does not
+alter the download policy, but after any download has taken place,
+it verifies that the number of files downloaded matches the number
+expected.
+
+
+
+ Attribute |
+ Description |
+ Required |
+
+
+ count |
+ number of downloaded files expected.
+ |
+ Yes |
+
+
+ enabled |
+ Enabled flag
+ |
+ No -default "true" |
+
+
+
+Example:
+
+ <assertdownloaded cound="4" />
+
+
+Examples
+
+ <!--
+ versions.properties says
+ xdoclet.version=2.0
+ commons-logging.version=1.0.3
+ commons-collections.version=3.1
+ -->
+ <property file="versions.properties" />
+
+ <libraries destDir="${lib.dir}" pathid="xdoclet.lib" >
+ <mavenrepository />
+ <library project="xdoclet"
+ version="${xdoclet.version}" />
+ <library project="commons-logging"
+ version="${commons-logging.version}" />
+ <library project="commons-collections"
+ version="${commons-collections.version}" />
+ </libraries>
+
+
+Load in versions from a file, then download the relevant archives. No
+update schedule is defined, but a path is created for insertion into a
+classpath. This property file driven dependency model is what we recommend
+over hard coding versions in a build file.
+
+ <libraries destDir="build/lib" offline="${offline}" flatten="true">
+ <mavenrepository url="${private.server}"/>
+ <library project="doomed" archive="dead-code"
+ suffix=".war"
+ destinationName="product.war"
+ version="LATEST"
+ />
+ <scheduledupdate markerfile="build/lib/marker.properties"
+ hours="11" />
+ </libraries>
+
+
+Download doomed/dead-code.LATEST.war from a private repository, save it to
+build/lib/product.war with an update schedule of every eleven hours.
+
+
+Copyright © 2005 The Apache Software Foundation. All rights
+Reserved.
+
+
+
+
diff --git a/docs/manual/CoreTasks/nice.html b/docs/manual/CoreTasks/nice.html
index 4403b089a..7c871d32a 100644
--- a/docs/manual/CoreTasks/nice.html
+++ b/docs/manual/CoreTasks/nice.html
@@ -36,19 +36,19 @@
Examples
<nice newpriority="10"/>
-Set the Thread priority to 10.
+Set the Thread priority to 10 (highest).
<nice currentpriority="priority"/>
Store the current Thread priority in the user property "priority".
<nice currentpriority="currentpriority" newpriority="1"/>
-Set the current Thread priority to 1, storing the original
+
Set the current Thread priority to 1 (lowest), storing the original
priority in the user property "currentpriority". This
can be used to set the priority back to its original value later.
-Copyright © 2004 The Apache Software Foundation. All rights
+
Copyright © 2004-2005 The Apache Software Foundation. All rights
Reserved.