From 8f282967e0e43ab691161b50a23918e860b8389e Mon Sep 17 00:00:00 2001 From: Stefan Bodewig Date: Wed, 1 Aug 2001 09:23:47 +0000 Subject: [PATCH] Clean up documentation for to better explain the nested elements. PR: 2158 git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@269420 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/CoreTypes/patternset.html | 69 +++++++++++++++++++++++---- 1 file changed, 61 insertions(+), 8 deletions(-) diff --git a/docs/manual/CoreTypes/patternset.html b/docs/manual/CoreTypes/patternset.html index 2f49b61fa..b575d72a7 100644 --- a/docs/manual/CoreTypes/patternset.html +++ b/docs/manual/CoreTypes/patternset.html @@ -47,8 +47,66 @@ or the following attributes.

exclude file by using a nested excludesfile elements. - -

Examples

+

Parameters specified as nested elements

+

include and exclude

+

Each such element defines a single pattern for files to include or +exclude.

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
namethe pattern + to in/exclude.Yes
ifOnly use this pattern if the named property is set.No
unlessOnly use this pattern if the named property is + not set.No
+

includesfile and excludesfile

+

If you want to list the files to include or exclude external to +your build file, you should use the includesfile/excludesfile +attributes or elements. Using the attribute, you can only specify a +single file of each type, while the nested elements can be specified +more than once - the nested elements also support if/unless attributes +you can use to test the existance of a property.

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
namethe name of the file holding the patterns to + in/exclude.Yes
ifOnly read this file if the named property is set.No
unlessOnly read this file if the named property is + not set.No
+

Examples

 <patternset id="non.test.sources" >
   <include name="**/*.java"/>
@@ -78,12 +136,7 @@ that it should be used only if a property is not set.

will only include the files in the sub-directory prof if the property professional is set to some value.

-

If you want to list the files to include or exclude external to -your build file, you should use the includesfile/excludesfile -attributes or elements. Using the attribute, you can only specify a -single file of each type, while the nested elements can be specified -more than once - the nested elements also support if/unless attributes -you can use to test the existance of a property. For example:

+

The two sets

 <patternset includesfile="some-file" />