From 1b88e5367497ad4f9fbd3a10466b6312b4b5d91d Mon Sep 17 00:00:00 2001 From: Stefan Bodewig Date: Mon, 12 May 2003 15:19:18 +0000 Subject: [PATCH] Add documentation for propertyset git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@274564 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/CoreTasks/ant.html | 14 +++- docs/manual/CoreTasks/antcall.html | 10 ++- docs/manual/CoreTasks/java.html | 8 ++ docs/manual/CoreTypes/propertyset.html | 107 +++++++++++++++++++++++++ docs/manual/OptionalTasks/junit.html | 6 ++ docs/manual/conceptstypeslist.html | 1 + 6 files changed, 143 insertions(+), 3 deletions(-) create mode 100644 docs/manual/CoreTypes/propertyset.html diff --git a/docs/manual/CoreTasks/ant.html b/docs/manual/CoreTasks/ant.html index 3ae2bc5be..d22922867 100644 --- a/docs/manual/CoreTasks/ant.html +++ b/docs/manual/CoreTasks/ant.html @@ -87,7 +87,9 @@ project.

-

Parameters specified as nested elements

property

+

Parameters specified as nested elements

+ +

property

See the description of the property task. Note that the refid attribute points to a reference in the calling project, not in the new one.

@@ -114,6 +116,14 @@ optionally changing their id.

+

propertyset

+ +

You can specify a set of properties to be copied into the new +project with propertysets.

+ +

since Ant 1.6.

+

Basedir of the new project

The basedir value of the new project is affected by the two @@ -222,7 +232,7 @@ a <path> with the id path1, but new project using the id path2.

-

Copyright © 2000-2002 Apache Software Foundation. All rights +

Copyright © 2000-2003 Apache Software Foundation. All rights Reserved.

diff --git a/docs/manual/CoreTasks/antcall.html b/docs/manual/CoreTasks/antcall.html index eeb149a7e..6755a34ca 100644 --- a/docs/manual/CoreTasks/antcall.html +++ b/docs/manual/CoreTasks/antcall.html @@ -101,6 +101,14 @@ optionally changing their id.

+

propertyset

+ +

You can specify a set of properties to be copied into the new +project with propertysets.

+ +

since Ant 1.6.

+

Examples

   <target name="default">
@@ -124,7 +132,7 @@ optionally changing their id.

 
will copy the parent's definition of path1 into the
 new project using the id path2.

 
-
Copyright © 2000-2002 Apache Software Foundation. All rights
+
Copyright © 2000-2003 Apache Software Foundation. All rights
 Reserved.

 
 
diff --git a/docs/manual/CoreTasks/java.html b/docs/manual/CoreTasks/java.html
index 28359051c..dcb5cafcd 100644
--- a/docs/manual/CoreTasks/java.html
+++ b/docs/manual/CoreTasks/java.html
@@ -177,6 +177,14 @@ These properties will be made available to the VM during the execution
 of the class (either ANT's VM or the forked VM). The attributes
 for this element are the same as for environment
 variables.

+
+
syspropertyset

+
+
You can specify a set of properties to be used as system properties
+with syspropertysets.

+
+
since Ant 1.6.

+
 
classpath

 
Java's classpath attribute is a PATH like structure and can also be set via a nested
diff --git a/docs/manual/CoreTypes/propertyset.html b/docs/manual/CoreTypes/propertyset.html
new file mode 100644
index 000000000..2402d3652
--- /dev/null
+++ b/docs/manual/CoreTypes/propertyset.html
@@ -0,0 +1,107 @@
+
+
+
+
+PropertySet Type
+
+
+
+
+
PropertySet

+
Since Ant 1.6

+
+
Groups a set of properties to be used by reference in a task that
+supports this.

+
+
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+
AttributeDescriptionRequired
dynamicWhether to reevaluate the set everytime the set
+      is used.  Default is "true".No

+
Parameters specified as nested elements

+
+
propertyref

+
+
Selects properties from the current project to be included in the
+set.

+
+
+  
+    
+    
+    
+  
+  
+    
+    
+    
+  
+  
+    
+    
+  
+  
+    
+    
+  
+
AttributeDescriptionRequired
nameSelect the property with the given name.Exactly one of these.
prefixSelect the properties whose name starts with the
+      given string.
regexpSelect the properties that match the given
+      regular expression.  Similar to regexp type mappers, this
+      equires a supported regular expression library.

+
+
propertyset

+
+
A propertyset can be used as the set union of more
+propertysets.

+
+
For example:

+
+
+<propertyset id="properties-starting-with-foo">
+  <propertyref prefix="foo"/>
+</propertyset>
+<propertyset id="properties-starting-with-bar">
+  <propertyref prefix="bar"/>
+</propertyset>
+<propertyset id="my-set">
+  <propertyset refid="properties-starting-with-foo"/>
+  <propertyset refid="properties-starting-with-bar"/>
+</propertyset>
+

+
+
collects all properties whose name starts with either
+"foo" or "bar" in the set named
+"my-set".

+
+
mapper

+
+
A mapper - at maximum one mapper can be
+specified.  The mapper is used to change the names of the property
+keys, for example:
+
+
+<propertyset id="properties-starting-with-foo">
+  <propertyref prefix="foo"/>
+  <mapper type="glob" from="foo*" to="bar*"/>
+</propertyset>
+

+
+
collects all properties whose name starts with "foo", but
+changes the names to start with "bar" instead.

+
+

+
Copyright © 2003 Apache Software Foundation. All rights
+Reserved.

+
+
+
+
diff --git a/docs/manual/OptionalTasks/junit.html b/docs/manual/OptionalTasks/junit.html
index 97288c6d9..9414b3b3d 100644
--- a/docs/manual/OptionalTasks/junit.html
+++ b/docs/manual/OptionalTasks/junit.html
@@ -212,6 +212,12 @@ The attributes for this element are the same as for syspropertysets.

+
+
since Ant 1.6.

 
 
env

 
diff --git a/docs/manual/conceptstypeslist.html b/docs/manual/conceptstypeslist.html
index f1be1ef7b..1b95bfce1 100644
--- a/docs/manual/conceptstypeslist.html
+++ b/docs/manual/conceptstypeslist.html
@@ -25,6 +25,7 @@
 FilterSet

 PatternSet

 Path-like Structures

+PropertySet

 Selectors

 XMLCatalog

 ZipFileSet