source: release-kits/shared/ant-tasks/svnant/doc/selectors.html@ 17129

Last change on this file since 17129 was 17129, checked in by oranfry, 16 years ago

a newer version of svnant
File size: 37.9 KB
Line 
1<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns:ant="http://www.fiset.ca/ant-docs/v1" xmlns:html="http://www.w3.org/1999/xhtml" xmlns="http://www.w3.org/1999/xhtml">
4<head>
5<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252"/>
6<title>Svn Selectors</title>
7<META HTTP-EQUIV="Content-Language" CONTENT="en-us"/>
8<style type="text/css">
9
10 body {
11 font: 80% Verdana, Arial, Helvetica, sans-serif;
12 margin: 5px; padding: 0;
13 /* background: rgb(95%,95%,80%); */
14 color: black;
15 }
16 h1 {
17 font-size: 200%; letter-spacing: 3px;
18 margin-bottom: 1em;
19 padding: 0.66em 0 0.33em 1em;
20 background: rgb(85%,85%,70%);
21 }
22 h2 {
23 background: rgb(90%,90%,80%);
24 }
25 h3 {
26 background-color: rgb(95%,95%,85%);
27 }
28 .sample {
29 font-family: Courier, "Courier New", monospace;
30 background-color: #f3f1f4;
31 }
32 div.sample {
33 margin-left: 10px;
34 margin-right: 10px;
35 padding-top: 3px;
36 padding-bottom: 3px;
37 padding-left: 3px;
38 padding-right: 3px;
39 border:1px dashed black;
40 width: 80%;
41 }
42 table.params {
43 width: 80%;
44 border: 1px solid gray;
45 margin-bottom:1em;
46 }
47 th.params, td.params {
48 padding: 0 0.5em;
49 border-left: 1px solid #DDD;
50 border-bottom: 1px solid #DDD;
51 font: 70%
52 }
53 th.params {
54
55 }
56 table.toc {
57 width: 80%;
58 border: 1px solid gray;
59 margin-bottom:1em;
60 }
61 td.toc {
62 padding: 0 0.5em;
63 border: none
64 font: 70%
65 }
66 table.type {
67 width: 80%;
68 border: none;
69 margin-bottom:1em;
70 }
71 th.type, td.type {
72 text-align: left;
73 padding: 0 0.5em;
74 border: none
75 font: 70%
76 }
77 th.type {
78 font-weight: bold;
79 }
80
81 </style>
82</head>
83<body lang="en-US" dir="LTR">
84<h1>Svn Selectors</h1>
85<h2>Table of Content</h2>
86<table class="toc">
87<tbody class="toc">
88<tr class="toc">
89<td class="toc">
90<a href="#svnAdded">svnAdded</a>
91</td>
92<td class="toc">File selector that performs discrimination based on the 'added' subversion status. </td>
93</tr>
94<tr class="toc">
95<td class="toc">
96<a href="#svnModified">svnModified</a>
97</td>
98<td class="toc">File selector that performs discrimination based on the 'modified' subversion status. </td>
99</tr>
100<tr class="toc">
101<td class="toc">
102<a href="#svnUnversioned">svnUnversioned</a>
103</td>
104<td class="toc">File selector that performs discrimination based on the 'unversioned' subversion status. </td>
105</tr>
106<tr class="toc">
107<td class="toc">
108<a href="#svnConflicted">svnConflicted</a>
109</td>
110<td class="toc">File selector that performs discrimination based on the 'conflicted' subversion status. </td>
111</tr>
112<tr class="toc">
113<td class="toc">
114<a href="#svnIgnored">svnIgnored</a>
115</td>
116<td class="toc">File selector that performs discrimination based on the 'ignored' subversion status. </td>
117</tr>
118<tr class="toc">
119<td class="toc">
120<a href="#svnLocked">svnLocked</a>
121</td>
122<td class="toc">File selector that performs discrimination based on the 'locked' subversion status. </td>
123</tr>
124<tr class="toc">
125<td class="toc">
126<a href="#svnNormal">svnNormal</a>
127</td>
128<td class="toc">File selector that performs discrimination based on the 'normal' subversion status. </td>
129</tr>
130<tr class="toc">
131<td class="toc">
132<a href="#svnReplaced">svnReplaced</a>
133</td>
134<td class="toc">File selector that performs discrimination based on the 'replaced' subversion status. </td>
135</tr>
136<tr class="toc">
137<td class="toc">
138<a href="#svnMissing">svnMissing</a>
139</td>
140<td class="toc">File selector that performs discrimination based on the 'missing' subversion status. </td>
141</tr>
142<tr class="toc">
143<td class="toc">
144<a href="#svnDeleted">svnDeleted</a>
145</td>
146<td class="toc">File selector that performs discrimination based on the 'deleted' subversion status. </td>
147</tr>
148</tbody>
149</table>
150<h2>Introduction</h2>
151<ant:introduction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
152 <p>
153 This document describes the file selectors offered in svnAnt. To use those selectors,
154 you must first obtain a copy of svnant.jar, add it to the classpath of your ant project
155 and define the types. Fortunately, there is a resource file, within the distributed JAR file,
156 and all those steps can be accomplished with the following code:
157 <div class="sample">
158<pre class="sample">
159
160&lt;path id="svnant.classpath"&gt;
161 &lt;pathelement location="${svnant.dir}/lib/svnant.jar" /&gt;
162 &lt;pathelement location="${svnant.dir}/lib/svnClientAdapter.jar" /&gt;
163&lt;/path&gt;
164
165&lt;typedef resource="svntypes.xml" classpathref="project.classpath"/&gt;
166
167 </pre>
168</div>
169 </p>
170 <p>
171 If you are upgrading from an earlier version of svnAnt, and the following line was used
172 in your <i>build.xml</i> file, then replace it with the ones above.
173 <div class="sample">
174<pre class="sample">
175
176&lt;taskdef resource="svntask.properties" classpathref="svnant.classpath"/&gt;
177
178 </pre>
179</div>
180 </p>
181 <h3>
182<a name="bindings">Bindings</a>
183</h3>
184 <p>
185 All file selectors offer two parameters: <b>javahl</b> and <b>svnkit</b>. Those parameters
186 are booleans, which means their values can be set to either <b>true</b> or <b>false</b>.
187 If not specified, those parameters are assumed to be set (true). These two parameters are used
188 to select which client is used to access Subversion.
189 </p>
190 <p>
191 There are three clients used by svnAnt to access Subversion:
192 <ul>
193 <li>JavaHL;</li>
194 <li>SVNKit; and,</li>
195 <li>Command Line Interface.</li>
196 </ul>
197 To better understand the difference between those three clients, please refer to
198 documentation on <b>svnClientAdapter.jar</b>.
199 </p>
200 <p>
201 The property <b>javahl</b> is considered only if the javahl libraries are available. Similarly,
202 the property <b>svnkit</b> is considered only if SVNKit is present. Finally, <b>javahl</b>
203 takes precedence over <b>svnkit</b>.
204 </p>
205 <p>
206 To better illustrate the previous paragraph, use the following steps:
207 <ol>
208 <li>If <b>javahl</b> is <i>true</i> and JavaHL bindings are available, then JavaHL is used.</li>
209 <li>If <b>svnkit</b> is <i>true</i> and SVNKit is present, then SVNKit is used.</li>
210 <li>If the two previous tests failed, for any reason, then the Command Line Interface is used.</li>
211 </ol>
212 </p>
213 </ant:introduction>
214<h1>
215<a name="">svnAdded</a>
216</h1>
217<p>File selector that performs discrimination based on the 'added' subversion status. </p>
218<table class="type">
219<tbody class="type">
220<tr class="type">
221<th class="type">Implementation:</th>
222<td class="type">org.tigris.subclipse.svnant.selectors.Added</td>
223</tr>
224</tbody>
225</table>
226<h2>Parameters</h2>
227<table class="params">
228<tr class="params">
229<th class="params">Attribute</th>
230<th class="params">Description</th>
231<th class="params">Required</th>
232</tr>
233<tr class="params">
234<td class="params">javahl</td>
235<td class="params">
236<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
237 If set, instructs the use of JavaHL bindings, if available.
238 Set to <b>false</b> to use command line client interface to subversion.
239 Defaults to true. See <a href="#bindings">note</a> for more details.
240 </ant:description>
241</td>
242<td class="params">
243<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
244 No
245 </ant:required>
246</td>
247</tr>
248<tr class="params">
249<td class="params">svnkit</td>
250<td class="params">
251<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
252 If set, instructs the use of SVNKit bindings, if available.
253 Set to <b>false</b> to use command line client interface to subversion.
254 Defaults to true. See <a href="#bindings">note</a> for more details.
255 </ant:description>
256</td>
257<td class="params">
258<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
259 No
260 </ant:required>
261</td>
262</tr>
263<tr class="params">
264<td class="params">failonerror</td>
265<td class="params">
266<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
267 Controls whether an error stops the build or is merely reported to the screen.
268 </ant:description>
269</td>
270<td class="params">
271<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
272 No (defaults to "true")
273 </ant:required>
274</td>
275</tr>
276</table>
277<h2>Nested Types</h2>No nested types defined for this type.<h2>Description</h2>
278 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
279 This file selector is used to discriminate files within a <b>fileset</b> based on a Subversion
280 status. In particular, this selector keeps files that are recognized as 'added'.
281 </p>
282 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
283 An 'added' file or directory is one that has been added to the repository, but not yet
284 commited. In general, <b>svn status</b> displays those items with the letter <i>A</i>
285 preceeding the name.
286 </p>
287 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
288 Example: to copy a number of files with the status 'added' from their location in
289 <b>workingcopy</b> to a new directory called <b>test</b>, the following ant task can
290 be used:
291 <div class="sample">
292<pre class="sample">
293
294&lt;copy todir="test"&gt;
295 &lt;fileset dir="workingcopy"&gt;
296 &lt;svnAdded/&gt;
297 &lt;/fileset&gt;
298&lt;/copy&gt;
299
300 </pre>
301</div>
302 </p>
303 <h1>
304<a name="">svnModified</a>
305</h1>
306<p>File selector that performs discrimination based on the 'modified' subversion status. </p>
307<table class="type">
308<tbody class="type">
309<tr class="type">
310<th class="type">Implementation:</th>
311<td class="type">org.tigris.subclipse.svnant.selectors.Modified</td>
312</tr>
313</tbody>
314</table>
315<h2>Parameters</h2>
316<table class="params">
317<tr class="params">
318<th class="params">Attribute</th>
319<th class="params">Description</th>
320<th class="params">Required</th>
321</tr>
322<tr class="params">
323<td class="params">javahl</td>
324<td class="params">
325<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
326 If set, instructs the use of JavaHL bindings, if available.
327 Set to <b>false</b> to use command line client interface to subversion.
328 Defaults to true. See <a href="#bindings">note</a> for more details.
329 </ant:description>
330</td>
331<td class="params">
332<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
333 No
334 </ant:required>
335</td>
336</tr>
337<tr class="params">
338<td class="params">svnkit</td>
339<td class="params">
340<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
341 If set, instructs the use of SVNKit bindings, if available.
342 Set to <b>false</b> to use command line client interface to subversion.
343 Defaults to true. See <a href="#bindings">note</a> for more details.
344 </ant:description>
345</td>
346<td class="params">
347<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
348 No
349 </ant:required>
350</td>
351</tr>
352<tr class="params">
353<td class="params">failonerror</td>
354<td class="params">
355<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
356 Controls whether an error stops the build or is merely reported to the screen.
357 </ant:description>
358</td>
359<td class="params">
360<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
361 No (defaults to "true")
362 </ant:required>
363</td>
364</tr>
365</table>
366<h2>Nested Types</h2>No nested types defined for this type.<h2>Description</h2>
367 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
368 This file selector is used to discriminate files within a <b>fileset</b> based on a Subversion
369 status. In particular, this selector keeps files that are recognized as 'modified'.
370 </p>
371 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
372 A 'modified' file or directory is one that has been changed since the last update and where
373 the changes have not yet been commited to the repository. In general, <b>svn status</b>
374 display those items with the letter <i>M</i> preceeding the name. It is important to note
375 that other items can also be considered modified, such as conflicted ones.
376 </p>
377 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
378 Example: to copy a number of files with the status 'modified' from their location in
379 <b>workingcopy</b> to a new directory called <b>test</b>, the following ant task can
380 be used:
381 <div class="sample">
382<pre class="sample">
383
384&lt;copy todir="test"&gt;
385 &lt;fileset dir="workingcopy"&gt;
386 &lt;svnModified/&gt;
387 &lt;/fileset&gt;
388&lt;/copy&gt;
389
390 </pre>
391</div>
392 </p>
393 <h1>
394<a name="">svnUnversioned</a>
395</h1>
396<p>File selector that performs discrimination based on the 'unversioned' subversion status. </p>
397<table class="type">
398<tbody class="type">
399<tr class="type">
400<th class="type">Implementation:</th>
401<td class="type">org.tigris.subclipse.svnant.selectors.Unversioned</td>
402</tr>
403</tbody>
404</table>
405<h2>Parameters</h2>
406<table class="params">
407<tr class="params">
408<th class="params">Attribute</th>
409<th class="params">Description</th>
410<th class="params">Required</th>
411</tr>
412<tr class="params">
413<td class="params">javahl</td>
414<td class="params">
415<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
416 If set, instructs the use of JavaHL bindings, if available.
417 Set to <b>false</b> to use command line client interface to subversion.
418 Defaults to true. See <a href="#bindings">note</a> for more details.
419 </ant:description>
420</td>
421<td class="params">
422<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
423 No
424 </ant:required>
425</td>
426</tr>
427<tr class="params">
428<td class="params">svnkit</td>
429<td class="params">
430<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
431 If set, instructs the use of SVNKit bindings, if available.
432 Set to <b>false</b> to use command line client interface to subversion.
433 Defaults to true. See <a href="#bindings">note</a> for more details.
434 </ant:description>
435</td>
436<td class="params">
437<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
438 No
439 </ant:required>
440</td>
441</tr>
442<tr class="params">
443<td class="params">failonerror</td>
444<td class="params">
445<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
446 Controls whether an error stops the build or is merely reported to the screen.
447 </ant:description>
448</td>
449<td class="params">
450<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
451 No (defaults to "true")
452 </ant:required>
453</td>
454</tr>
455</table>
456<h2>Nested Types</h2>No nested types defined for this type.<h2>Description</h2>
457 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
458 This file selector is used to discriminate files within a <b>fileset</b> based on a Subversion
459 status. In particular, this selector keeps files that are recognized as 'unversioned'.
460 </p>
461 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
462 An 'unversioned' file or directory is one that is present in a working copy but is not yet
463 known to the repository. In general, <b>svn status</b>
464 display those items with a question mark (<i>?</i>) preceeding the name. Note that 'ignored'
465 items are not considered 'unversioned'.
466 </p>
467 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
468 Eexample: to copy a number of files with the status 'unversioned' from their location in
469 <b>workingcopy</b> to a new directory called <b>test</b>, the following ant task can
470 be used:
471 <div class="sample">
472<pre class="sample">
473
474&lt;copy todir="test"&gt;
475 &lt;fileset dir="workingcopy"&gt;
476 &lt;svnUnversioned/&gt;
477 &lt;/fileset&gt;
478&lt;/copy&gt;
479
480 </pre>
481</div>
482 </p>
483 <h1>
484<a name="">svnConflicted</a>
485</h1>
486<p>File selector that performs discrimination based on the 'conflicted' subversion status. </p>
487<table class="type">
488<tbody class="type">
489<tr class="type">
490<th class="type">Implementation:</th>
491<td class="type">org.tigris.subclipse.svnant.selectors.Conflicted</td>
492</tr>
493</tbody>
494</table>
495<h2>Parameters</h2>
496<table class="params">
497<tr class="params">
498<th class="params">Attribute</th>
499<th class="params">Description</th>
500<th class="params">Required</th>
501</tr>
502<tr class="params">
503<td class="params">javahl</td>
504<td class="params">
505<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
506 If set, instructs the use of JavaHL bindings, if available.
507 Set to <b>false</b> to use command line client interface to subversion.
508 Defaults to true. See <a href="#bindings">note</a> for more details.
509 </ant:description>
510</td>
511<td class="params">
512<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
513 No
514 </ant:required>
515</td>
516</tr>
517<tr class="params">
518<td class="params">svnkit</td>
519<td class="params">
520<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
521 If set, instructs the use of SVNKit bindings, if available.
522 Set to <b>false</b> to use command line client interface to subversion.
523 Defaults to true. See <a href="#bindings">note</a> for more details.
524 </ant:description>
525</td>
526<td class="params">
527<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
528 No
529 </ant:required>
530</td>
531</tr>
532<tr class="params">
533<td class="params">failonerror</td>
534<td class="params">
535<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
536 Controls whether an error stops the build or is merely reported to the screen.
537 </ant:description>
538</td>
539<td class="params">
540<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
541 No (defaults to "true")
542 </ant:required>
543</td>
544</tr>
545</table>
546<h2>Nested Types</h2>No nested types defined for this type.<h2>Description</h2>
547 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
548 This file selector is used to discriminate files within a <b>fileset</b> based on a Subversion
549 status. In particular, this selector keeps files that are recognized as 'conflicted'.
550 </p>
551 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
552 When updating a subversion item (file or directory), it is possible to have two sets of
553 changes merged into the working item. This happens when the item was modified locally as
554 well as remotely during the period since the last update. If the two sets of changes conflict
555 (same lines of a file changes, same directory entries modified), then the item is marked
556 as 'conflicted'. In general, <b>svn status</b> displays 'conflicted' items with the letter
557 <i>C</i> preceeding the name. Note that 'conflicted' items are also considered 'modified'.
558 </p>
559 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
560 Example: to copy a number of files with the status 'conflicted' from their location in
561 <b>workingcopy</b> to a new directory called <b>test</b>, the following ant task can
562 be used:
563 <div class="sample">
564<pre class="sample">
565
566&lt;copy todir="test"&gt;
567 &lt;fileset dir="workingcopy"&gt;
568 &lt;svnConflicted/&gt;
569 &lt;/fileset&gt;
570&lt;/copy&gt;
571
572 </pre>
573</div>
574 </p>
575 <h1>
576<a name="">svnIgnored</a>
577</h1>
578<p>File selector that performs discrimination based on the 'ignored' subversion status. </p>
579<table class="type">
580<tbody class="type">
581<tr class="type">
582<th class="type">Implementation:</th>
583<td class="type">org.tigris.subclipse.svnant.selectors.Ignored</td>
584</tr>
585</tbody>
586</table>
587<h2>Parameters</h2>
588<table class="params">
589<tr class="params">
590<th class="params">Attribute</th>
591<th class="params">Description</th>
592<th class="params">Required</th>
593</tr>
594<tr class="params">
595<td class="params">javahl</td>
596<td class="params">
597<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
598 If set, instructs the use of JavaHL bindings, if available.
599 Set to <b>false</b> to use command line client interface to subversion.
600 Defaults to true. See <a href="#bindings">note</a> for more details.
601 </ant:description>
602</td>
603<td class="params">
604<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
605 No
606 </ant:required>
607</td>
608</tr>
609<tr class="params">
610<td class="params">svnkit</td>
611<td class="params">
612<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
613 If set, instructs the use of SVNKit bindings, if available.
614 Set to <b>false</b> to use command line client interface to subversion.
615 Defaults to true. See <a href="#bindings">note</a> for more details.
616 </ant:description>
617</td>
618<td class="params">
619<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
620 No
621 </ant:required>
622</td>
623</tr>
624<tr class="params">
625<td class="params">failonerror</td>
626<td class="params">
627<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
628 Controls whether an error stops the build or is merely reported to the screen.
629 </ant:description>
630</td>
631<td class="params">
632<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
633 No (defaults to "true")
634 </ant:required>
635</td>
636</tr>
637</table>
638<h2>Nested Types</h2>No nested types defined for this type.<h2>Description</h2>
639 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
640 This file selector is used to discriminate files within a <b>fileset</b> based on a Subversion
641 status. In particular, this selector keeps files that are recognized as 'ignored'.
642 </p>
643 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
644 An 'ignored' file or directory is one which name match the patterns found in the parent
645 directory's <b>svn:ignore</b> property. In general, <b>svn status --no-ignore</b>
646 display those items with the letter <i>I</i> preceeding the name.
647 </p>
648 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
649 Example: to copy a number of files with the status 'ignored' from their location in
650 <b>workingcopy</b> to a new directory called <b>test</b>, the following ant task can
651 be used:
652 <div class="sample">
653<pre class="sample">
654
655&lt;copy todir="test"&gt;
656 &lt;fileset dir="workingcopy"&gt;
657 &lt;svnIgnored/&gt;
658 &lt;/fileset&gt;
659&lt;/copy&gt;
660
661 </pre>
662</div>
663 </p>
664 <h1>
665<a name="">svnLocked</a>
666</h1>
667<p>File selector that performs discrimination based on the 'locked' subversion status. </p>
668<table class="type">
669<tbody class="type">
670<tr class="type">
671<th class="type">Implementation:</th>
672<td class="type">org.tigris.subclipse.svnant.selectors.Locked</td>
673</tr>
674</tbody>
675</table>
676<h2>Parameters</h2>
677<table class="params">
678<tr class="params">
679<th class="params">Attribute</th>
680<th class="params">Description</th>
681<th class="params">Required</th>
682</tr>
683<tr class="params">
684<td class="params">javahl</td>
685<td class="params">
686<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
687 If set, instructs the use of JavaHL bindings, if available.
688 Set to <b>false</b> to use command line client interface to subversion.
689 Defaults to true. See <a href="#bindings">note</a> for more details.
690 </ant:description>
691</td>
692<td class="params">
693<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
694 No
695 </ant:required>
696</td>
697</tr>
698<tr class="params">
699<td class="params">svnkit</td>
700<td class="params">
701<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
702 If set, instructs the use of SVNKit bindings, if available.
703 Set to <b>false</b> to use command line client interface to subversion.
704 Defaults to true. See <a href="#bindings">note</a> for more details.
705 </ant:description>
706</td>
707<td class="params">
708<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
709 No
710 </ant:required>
711</td>
712</tr>
713<tr class="params">
714<td class="params">failonerror</td>
715<td class="params">
716<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
717 Controls whether an error stops the build or is merely reported to the screen.
718 </ant:description>
719</td>
720<td class="params">
721<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
722 No (defaults to "true")
723 </ant:required>
724</td>
725</tr>
726</table>
727<h2>Nested Types</h2>No nested types defined for this type.<h2>Description</h2>
728 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
729 This file selector is used to discriminate files within a <b>fileset</b> based on a Subversion
730 status. In particular, this selector keeps files that are recognized as 'locked'.
731 </p>
732 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
733 A 'locked' file or directory is one where the repository has been informed of the
734 intent of a user to prevent others from modifying the file. For a working copy to
735 be aware of this fact, it must have been 'updated' since the lock status was changed.
736 In general, <b>svn status</b> displays those items with one of the letters <i>K</i>,
737 <i>O</i> or <i>B</i> in the sixth column. The 'lock' status is independent of most other
738 conditions such as 'modified', 'conflicted', etc.
739 </p>
740 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
741 Example: to copy a number of files with the status 'locked' from their location in
742 <b>workingcopy</b> to a new directory called <b>test</b>, the following ant task can
743 be used:
744 <div class="sample">
745<pre class="sample">
746
747&lt;copy todir="test"&gt;
748 &lt;fileset dir="workingcopy"&gt;
749 &lt;svnLocked/&gt;
750 &lt;/fileset&gt;
751&lt;/copy&gt;
752
753 </pre>
754</div>
755 </p>
756 <h1>
757<a name="">svnNormal</a>
758</h1>
759<p>File selector that performs discrimination based on the 'normal' subversion status. </p>
760<table class="type">
761<tbody class="type">
762<tr class="type">
763<th class="type">Implementation:</th>
764<td class="type">org.tigris.subclipse.svnant.selectors.Normal</td>
765</tr>
766</tbody>
767</table>
768<h2>Parameters</h2>
769<table class="params">
770<tr class="params">
771<th class="params">Attribute</th>
772<th class="params">Description</th>
773<th class="params">Required</th>
774</tr>
775<tr class="params">
776<td class="params">javahl</td>
777<td class="params">
778<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
779 If set, instructs the use of JavaHL bindings, if available.
780 Set to <b>false</b> to use command line client interface to subversion.
781 Defaults to true. See <a href="#bindings">note</a> for more details.
782 </ant:description>
783</td>
784<td class="params">
785<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
786 No
787 </ant:required>
788</td>
789</tr>
790<tr class="params">
791<td class="params">svnkit</td>
792<td class="params">
793<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
794 If set, instructs the use of SVNKit bindings, if available.
795 Set to <b>false</b> to use command line client interface to subversion.
796 Defaults to true. See <a href="#bindings">note</a> for more details.
797 </ant:description>
798</td>
799<td class="params">
800<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
801 No
802 </ant:required>
803</td>
804</tr>
805<tr class="params">
806<td class="params">failonerror</td>
807<td class="params">
808<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
809 Controls whether an error stops the build or is merely reported to the screen.
810 </ant:description>
811</td>
812<td class="params">
813<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
814 No (defaults to "true")
815 </ant:required>
816</td>
817</tr>
818</table>
819<h2>Nested Types</h2>No nested types defined for this type.<h2>Description</h2>
820 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
821 This file selector is used to discriminate files within a <b>fileset</b> based on a Subversion
822 status. In particular, this selector keeps files that are recognized as 'normal'.
823 </p>
824 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
825 A 'normal' file or directory is one that has not undergone any changes since the last
826 update. In general, this is the great majority of the files in a working copy. <b>svn status</b>
827 returns no special character for those items (a space in the first column).
828 </p>
829 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
830 Example: to copy a number of files with the status 'normal' from their location in
831 <b>workingcopy</b> to a new directory called <b>test</b>, the following ant task can
832 be used:
833 <div class="sample">
834<pre class="sample">
835
836&lt;copy todir="test"&gt;
837 &lt;fileset dir="workingcopy"&gt;
838 &lt;svnNormal/&gt;
839 &lt;/fileset&gt;
840&lt;/copy&gt;
841
842 </pre>
843</div>
844 </p>
845 <h1>
846<a name="">svnReplaced</a>
847</h1>
848<p>File selector that performs discrimination based on the 'replaced' subversion status. </p>
849<table class="type">
850<tbody class="type">
851<tr class="type">
852<th class="type">Implementation:</th>
853<td class="type">org.tigris.subclipse.svnant.selectors.Replaced</td>
854</tr>
855</tbody>
856</table>
857<h2>Parameters</h2>
858<table class="params">
859<tr class="params">
860<th class="params">Attribute</th>
861<th class="params">Description</th>
862<th class="params">Required</th>
863</tr>
864<tr class="params">
865<td class="params">javahl</td>
866<td class="params">
867<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
868 If set, instructs the use of JavaHL bindings, if available.
869 Set to <b>false</b> to use command line client interface to subversion.
870 Defaults to true. See <a href="#bindings">note</a> for more details.
871 </ant:description>
872</td>
873<td class="params">
874<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
875 No
876 </ant:required>
877</td>
878</tr>
879<tr class="params">
880<td class="params">svnkit</td>
881<td class="params">
882<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
883 If set, instructs the use of SVNKit bindings, if available.
884 Set to <b>false</b> to use command line client interface to subversion.
885 Defaults to true. See <a href="#bindings">note</a> for more details.
886 </ant:description>
887</td>
888<td class="params">
889<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
890 No
891 </ant:required>
892</td>
893</tr>
894<tr class="params">
895<td class="params">failonerror</td>
896<td class="params">
897<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
898 Controls whether an error stops the build or is merely reported to the screen.
899 </ant:description>
900</td>
901<td class="params">
902<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
903 No (defaults to "true")
904 </ant:required>
905</td>
906</tr>
907</table>
908<h2>Nested Types</h2>No nested types defined for this type.<h2>Description</h2>
909 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
910 This file selector is used to discriminate files within a <b>fileset</b> based on a Subversion
911 status. In particular, this selector keeps files that are recognized as 'replaced'.
912 </p>
913 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
914 A 'replaced' file or directory is one that has been deleted, then created anew and finally
915 added back to the repository. Also, those changes must not have been comitted.
916 In general, <b>svn status</b> displays those items with the letter <i>R</i> preceeding
917 the name.
918 </p>
919 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
920 Example: to copy a number of files with the status 'replaced' from their location in
921 <b>workingcopy</b> to a new directory called <b>test</b>, the following ant task can
922 be used:
923 <div class="sample">
924<pre class="sample">
925
926&lt;copy todir="test"&gt;
927 &lt;fileset dir="workingcopy"&gt;
928 &lt;svnReplaced/&gt;
929 &lt;/fileset&gt;
930&lt;/copy&gt;
931
932 </pre>
933</div>
934 </p>
935 <h1>
936<a name="">svnMissing</a>
937</h1>
938<p>File selector that performs discrimination based on the 'missing' subversion status. </p>
939<table class="type">
940<tbody class="type">
941<tr class="type">
942<th class="type">Implementation:</th>
943<td class="type">org.tigris.subclipse.svnant.selectors.Missing</td>
944</tr>
945</tbody>
946</table>
947<h2>Parameters</h2>
948<table class="params">
949<tr class="params">
950<th class="params">Attribute</th>
951<th class="params">Description</th>
952<th class="params">Required</th>
953</tr>
954<tr class="params">
955<td class="params">javahl</td>
956<td class="params">
957<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
958 If set, instructs the use of JavaHL bindings, if available.
959 Set to <b>false</b> to use command line client interface to subversion.
960 Defaults to true. See <a href="#bindings">note</a> for more details.
961 </ant:description>
962</td>
963<td class="params">
964<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
965 No
966 </ant:required>
967</td>
968</tr>
969<tr class="params">
970<td class="params">svnkit</td>
971<td class="params">
972<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
973 If set, instructs the use of SVNKit bindings, if available.
974 Set to <b>false</b> to use command line client interface to subversion.
975 Defaults to true. See <a href="#bindings">note</a> for more details.
976 </ant:description>
977</td>
978<td class="params">
979<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
980 No
981 </ant:required>
982</td>
983</tr>
984<tr class="params">
985<td class="params">failonerror</td>
986<td class="params">
987<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
988 Controls whether an error stops the build or is merely reported to the screen.
989 </ant:description>
990</td>
991<td class="params">
992<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
993 No (defaults to "true")
994 </ant:required>
995</td>
996</tr>
997</table>
998<h2>Nested Types</h2>No nested types defined for this type.<h2>Description</h2>
999 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1000 This file selector is used to discriminate files within a <b>fileset</b> based on a Subversion
1001 status. In particular, this selector keeps files that are recognized as 'missing'.
1002 </p>
1003 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1004 A 'missing' file or directory is one that is managed by Subversion and
1005 has been deleted without using the remove command. In general, <b>svn status</b>
1006 displays those items with the exclamation point (<i>!</i>) preceeding the name.
1007 </p>
1008 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1009 It is important to note that a regular FileSet (the one supplied by ANT) can not
1010 detect a missing item, since it does not exist on the file system. To detect
1011 Subversion missing items, use the FileSet provided by svn-ant (svnFileSet).
1012 </p>
1013 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1014 Example: to delete missing files from the repository associated with a <b>workingcopy</b>:
1015 <div class="sample">
1016<pre class="sample">
1017
1018&lt;svn&gt;
1019 &lt;delete&gt;
1020 &lt;svnFileSet dir="workingcopy"&gt;
1021 &lt;svnMissing/&gt;
1022 &lt;/svnFileSet&gt;
1023 &lt;/delete&gt;
1024&lt;/svn&gt;
1025
1026 </pre>
1027</div>
1028 </p>
1029 <h1>
1030<a name="">svnDeleted</a>
1031</h1>
1032<p>File selector that performs discrimination based on the 'deleted' subversion status. </p>
1033<table class="type">
1034<tbody class="type">
1035<tr class="type">
1036<th class="type">Implementation:</th>
1037<td class="type">org.tigris.subclipse.svnant.selectors.Deleted</td>
1038</tr>
1039</tbody>
1040</table>
1041<h2>Parameters</h2>
1042<table class="params">
1043<tr class="params">
1044<th class="params">Attribute</th>
1045<th class="params">Description</th>
1046<th class="params">Required</th>
1047</tr>
1048<tr class="params">
1049<td class="params">javahl</td>
1050<td class="params">
1051<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1052 If set, instructs the use of JavaHL bindings, if available.
1053 Set to <b>false</b> to use command line client interface to subversion.
1054 Defaults to true. See <a href="#bindings">note</a> for more details.
1055 </ant:description>
1056</td>
1057<td class="params">
1058<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1059 No
1060 </ant:required>
1061</td>
1062</tr>
1063<tr class="params">
1064<td class="params">svnkit</td>
1065<td class="params">
1066<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1067 If set, instructs the use of SVNKit bindings, if available.
1068 Set to <b>false</b> to use command line client interface to subversion.
1069 Defaults to true. See <a href="#bindings">note</a> for more details.
1070 </ant:description>
1071</td>
1072<td class="params">
1073<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1074 No
1075 </ant:required>
1076</td>
1077</tr>
1078<tr class="params">
1079<td class="params">failonerror</td>
1080<td class="params">
1081<ant:description xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1082 Controls whether an error stops the build or is merely reported to the screen.
1083 </ant:description>
1084</td>
1085<td class="params">
1086<ant:required xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1087 No (defaults to "true")
1088 </ant:required>
1089</td>
1090</tr>
1091</table>
1092<h2>Nested Types</h2>No nested types defined for this type.<h2>Description</h2>
1093 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1094 This file selector is used to discriminate files within a <b>fileset</b> based on a Subversion
1095 status. In particular, this selector keeps files that are recognized as 'deleted'.
1096 </p>
1097 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1098 A 'deleted' file or directory is one that has been erased using Subversion's 'remove'
1099 command. In general, <b>svn status</b> displays those items with the letter <i>D</i>
1100 preceeding the name.
1101 </p>
1102 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1103 It is important to note that a regular FileSet (the one supplied by ANT) can not
1104 detect a deleted item, since it does not exist on the file system. To detect
1105 Subversion deleted items, use the FileSet provided by svn-ant (svnFileSet).
1106 </p>
1107 <p xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1108 Example: to revert deleted files from a <b>workingcopy</b>:
1109 <div class="sample">
1110<pre class="sample">
1111
1112&lt;svn&gt;
1113 &lt;revert&gt;
1114 &lt;svnFileSet dir="workingcopy"&gt;
1115 &lt;svnDeleted/&gt;
1116 &lt;/svnFileSet&gt;
1117 &lt;/revert&gt;
1118&lt;/svn&gt;
1119
1120 </pre>
1121</div>
1122 </p>
1123 </body>
1124</html>
Note: See TracBrowser for help on using the repository browser.