1 | <!--
|
---|
2 | Licensed to the Apache Software Foundation (ASF) under one or more
|
---|
3 | contributor license agreements. See the NOTICE file distributed with
|
---|
4 | this work for additional information regarding copyright ownership.
|
---|
5 | The ASF licenses this file to You under the Apache License, Version 2.0
|
---|
6 | (the "License"); you may not use this file except in compliance with
|
---|
7 | the License. You may obtain a copy of the License at
|
---|
8 |
|
---|
9 | http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 |
|
---|
11 | Unless required by applicable law or agreed to in writing, software
|
---|
12 | distributed under the License is distributed on an "AS IS" BASIS,
|
---|
13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
14 | See the License for the specific language governing permissions and
|
---|
15 | limitations under the License.
|
---|
16 | -->
|
---|
17 | <html>
|
---|
18 |
|
---|
19 | <head>
|
---|
20 | <meta http-equiv="Content-Language" content="en-us">
|
---|
21 | <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
---|
22 | <title>DirSet Type</title>
|
---|
23 | </head>
|
---|
24 |
|
---|
25 | <body>
|
---|
26 |
|
---|
27 | <h2><a name="dirset">DirSet</a></h2>
|
---|
28 | <p>A DirSet is a group of directories. These directories can be found in a
|
---|
29 | directory tree starting in a base directory and are matched by
|
---|
30 | patterns taken from a number of <a href="patternset.html">PatternSets</a>
|
---|
31 | and <a href="selectors.html">Selectors</a>.
|
---|
32 | </p>
|
---|
33 | <p>PatternSets can be specified as nested
|
---|
34 | <code><patternset></code> elements. In addition, DirSet holds
|
---|
35 | an implicit PatternSet and supports the nested
|
---|
36 | <code><include></code>, <code><includesfile></code>,
|
---|
37 | <code><exclude></code> and <code><excludesfile></code>
|
---|
38 | elements of <code><patternset></code> directly, as well as
|
---|
39 | <code><patternset></code>'s attributes.</p>
|
---|
40 | <p>Selectors are available as nested elements within the DirSet.
|
---|
41 | If any of the selectors within the DirSet do not select the directory, it
|
---|
42 | is not considered part of the DirSet. This makes a DirSet
|
---|
43 | equivalent to an <code><and></code> selector container.</p>
|
---|
44 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
45 | <tr>
|
---|
46 | <td valign="top"><b>Attribute</b></td>
|
---|
47 | <td valign="top"><b>Description</b></td>
|
---|
48 | <td align="center" valign="top"><b>Required</b></td>
|
---|
49 | </tr>
|
---|
50 | <tr>
|
---|
51 | <td valign="top">dir</td>
|
---|
52 | <td valign="top">The root of the directory tree of this DirSet.</td>
|
---|
53 | <td valign="top" align="center">Yes</td>
|
---|
54 | </tr>
|
---|
55 | <tr>
|
---|
56 | <td valign="top">includes</td>
|
---|
57 | <td valign="top">A comma- or space-separated list of patterns of directories that
|
---|
58 | must be included; all directories are included when omitted.</td>
|
---|
59 | <td valign="top" align="center">No</td>
|
---|
60 | </tr>
|
---|
61 | <tr>
|
---|
62 | <td valign="top">includesfile</td>
|
---|
63 | <td valign="top">The name of a file; each line of this file is
|
---|
64 | taken to be an include pattern.</td>
|
---|
65 | <td valign="top" align="center">No</td>
|
---|
66 | </tr>
|
---|
67 | <tr>
|
---|
68 | <td valign="top">excludes</td>
|
---|
69 | <td valign="top">A comma- or space-separated list of patterns of directories that
|
---|
70 | must be excluded; no directories are excluded when omitted.</td>
|
---|
71 | <td valign="top" align="center">No</td>
|
---|
72 | </tr>
|
---|
73 | <tr>
|
---|
74 | <td valign="top">excludesfile</td>
|
---|
75 | <td valign="top">The name of a file; each line of this file is
|
---|
76 | taken to be an exclude pattern.</td>
|
---|
77 | <td valign="top" align="center">No</td>
|
---|
78 | </tr>
|
---|
79 | <tr>
|
---|
80 | <td valign="top">casesensitive</td>
|
---|
81 | <td valign="top">Specifies whether case-sensitivity should be applied
|
---|
82 | (<code>true</code>|<code>yes</code>|<code>on</code> or
|
---|
83 | <code>false</code>|<code>no</code>|<code>off</code>).</td>
|
---|
84 | <td valign="top" align="center">No; defaults to true.</td>
|
---|
85 | </tr>
|
---|
86 | <tr>
|
---|
87 | <td valign="top">followsymlinks</td>
|
---|
88 | <td valign="top">Shall symbolic links be followed? Defaults to
|
---|
89 | true. See <a href="fileset.html#symlink">fileset's documentation</a>.</td>
|
---|
90 | <td valign="top" align="center">No</td>
|
---|
91 | </tr>
|
---|
92 | </table>
|
---|
93 |
|
---|
94 | <h3>Examples</h3>
|
---|
95 | <blockquote><pre>
|
---|
96 | <dirset dir="${build.dir}">
|
---|
97 | <include name="apps/**/classes"/>
|
---|
98 | <exclude name="apps/**/*Test*"/>
|
---|
99 | </dirset>
|
---|
100 | </pre></blockquote>
|
---|
101 | <p>Groups all directories named <code>classes</code> found under the
|
---|
102 | <code>apps</code> subdirectory of <code>${build.dir}</code>, except those
|
---|
103 | that have the text <code>Test</code> in their name.</p>
|
---|
104 | <blockquote><pre>
|
---|
105 | <dirset dir="${build.dir}">
|
---|
106 | <patternset id="non.test.classes">
|
---|
107 | <include name="apps/**/classes"/>
|
---|
108 | <exclude name="apps/**/*Test*"/>
|
---|
109 | </patternset>
|
---|
110 | </dirset>
|
---|
111 | </pre></blockquote>
|
---|
112 | <p>Groups the same directories as the above example, but also establishes
|
---|
113 | a PatternSet that can be referenced in other
|
---|
114 | <code><dirset></code> elements, rooted at a different directory.</p>
|
---|
115 | <blockquote><pre>
|
---|
116 | <dirset dir="${debug_build.dir}">
|
---|
117 | <patternset refid="non.test.classes"/>
|
---|
118 | </dirset>
|
---|
119 | </pre></blockquote>
|
---|
120 | <p>Groups all directories in directory <code>${debug_build.dir}</code>,
|
---|
121 | using the same patterns as the above example.</p>
|
---|
122 |
|
---|
123 |
|
---|
124 |
|
---|
125 | </body>
|
---|
126 | </html>
|
---|
127 |
|
---|