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>Clearcase Tasks</title>
|
---|
23 | <link rel="stylesheet" type="text/css" href="../stylesheets/antmanual.css">
|
---|
24 | </head>
|
---|
25 |
|
---|
26 | <body>
|
---|
27 | <h1>Ant ClearCase Tasks</h1>
|
---|
28 | <p>by:<br>
|
---|
29 | Curtis White (cwhite at aracnet dot com),<br>
|
---|
30 | Sean P. Kane (spkane at genomatica dot com),<br>
|
---|
31 | Rob Anderson (Anderson.Rob at vectorscm dot com), and<br>
|
---|
32 | Sean Egan (sean at cm-logic dot com)</p>
|
---|
33 |
|
---|
34 | <p>Version 1.6 - 02/25/2003</p>
|
---|
35 |
|
---|
36 | <h1>ClearCase Support</h1>
|
---|
37 | <h2>Table of Contents</h2>
|
---|
38 | <ul>
|
---|
39 | <li><A href="#introduction">Introduction</a>
|
---|
40 | <li><A href="#cccheckin">CCCheckin</a>
|
---|
41 | <li><A href="#cccheckout">CCCheckout</a>
|
---|
42 | <li><A href="#ccuncheckout">CCUnCheckout</a>
|
---|
43 | <li><A href="#ccupdate">CCUpdate</a>
|
---|
44 | <li><A href="#ccmklbtype">CCMklbtype</a>
|
---|
45 | <li><A href="#ccmklabel">CCMklabel</a>
|
---|
46 | <li><A href="#ccrmtype">CCRmtype</a>
|
---|
47 | <li><A href="#cclock">CCLock</a>
|
---|
48 | <li><A href="#ccunlock">CCUnlock</a>
|
---|
49 | <li><A href="#ccmkbl">CCMkbl</a>
|
---|
50 | <li><A href="#ccmkattr">CCMkattr</a>
|
---|
51 | <li><A href="#ccmkdir">CCMkdir</a>
|
---|
52 | <li><A href="#ccmkelem">CCMkelem</a></li>
|
---|
53 |
|
---|
54 | </ul>
|
---|
55 |
|
---|
56 | <hr>
|
---|
57 | <h2><a name="introduction">Introduction</a></h2>
|
---|
58 | <p>Ant provides several optional tasks for working with ClearCase. These tasks correspond to various
|
---|
59 | ClearCase commands using the Cleartool program. The current tasks available for Ant correspond to only
|
---|
60 | a few of the significant ClearCase commands.</p>
|
---|
61 |
|
---|
62 | <p>More tasks can be easily added by deriving from the ClearCase class and then adding
|
---|
63 | functionality that is specific to that ClearCase command.</p>
|
---|
64 | <p>
|
---|
65 | Important: these tasks all require <code>cleartool</code> on the command line.
|
---|
66 | If a task fails with an IOException, especially error code 2 on Windows,
|
---|
67 | this is your problem.
|
---|
68 | </p>
|
---|
69 |
|
---|
70 |
|
---|
71 | <hr>
|
---|
72 | <h2><a name="cccheckin">CCCheckin</a></h2>
|
---|
73 | <h3>Description</h3>
|
---|
74 | Task to perform a "cleartool checkin" command to ClearCase.
|
---|
75 | <h3>Parameters</h3>
|
---|
76 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
77 | <tr>
|
---|
78 | <td><b>Attribute</b></td>
|
---|
79 | <td><b>Values</b></td>
|
---|
80 | <td><b>Required</b></td>
|
---|
81 | </tr>
|
---|
82 | <tr>
|
---|
83 | <td>viewpath</td>
|
---|
84 | <td>Path to the ClearCase view file or directory that the command
|
---|
85 | will operate on</td>
|
---|
86 | <td>No</td>
|
---|
87 | </tr>
|
---|
88 | <tr>
|
---|
89 | <td>comment</td>
|
---|
90 | <td>Specify a comment. Only one of comment or commentfile may be used.</td>
|
---|
91 | <td>No</td>
|
---|
92 | </tr>
|
---|
93 | <tr>
|
---|
94 | <td>commentfile</td>
|
---|
95 | <td>Specify a file containing a comment. Only one of comment or commentfile
|
---|
96 | may be used.</td>
|
---|
97 | <td>No</td>
|
---|
98 | </tr>
|
---|
99 | <tr>
|
---|
100 | <td>nowarn</td>
|
---|
101 | <td>Suppress warning messages</td>
|
---|
102 | <td>No</td>
|
---|
103 | </tr>
|
---|
104 | <tr>
|
---|
105 | <td>preservetime</td>
|
---|
106 | <td>Preserve the modification time</td>
|
---|
107 | <td>No</td>
|
---|
108 | </tr>
|
---|
109 | <tr>
|
---|
110 | <td>keepcopy</td>
|
---|
111 | <td>Keeps a copy of the file with a .keep extension</td>
|
---|
112 | <td>No</td>
|
---|
113 | </tr>
|
---|
114 | <tr>
|
---|
115 | <td>identical</td>
|
---|
116 | <td>Allows the file to be checked in even if it is identical
|
---|
117 | to the original</td>
|
---|
118 | <td>No</td>
|
---|
119 | </tr>
|
---|
120 | <tr>
|
---|
121 | <td>failonerr</td>
|
---|
122 | <td>Throw an exception if the command fails. Default is true</td>
|
---|
123 | <td>No</td>
|
---|
124 | </tr>
|
---|
125 | </table>
|
---|
126 | <h3>Examples</h3>
|
---|
127 | <blockquote>
|
---|
128 | <pre>
|
---|
129 | <cccheckin viewpath="c:/views/viewdir/afile"
|
---|
130 | commentfile="acomment.txt"
|
---|
131 | nowarn="true"
|
---|
132 | identical="true"/>
|
---|
133 | </pre>
|
---|
134 | </blockquote>
|
---|
135 | <p>Does a ClearCase <i>checkin</i> on the file <i>c:/views/viewdir/afile</i>.
|
---|
136 | Comment text from the file <i>acomment.txt</i> is added to ClearCase as a comment.
|
---|
137 | All warning messages are suppressed. The file is checked in even if it is
|
---|
138 | <i>identical</i> to the original.</p>
|
---|
139 | <hr>
|
---|
140 | <h2><a name="cccheckout">CCCheckout</a></h2>
|
---|
141 | <h3>Description</h3>
|
---|
142 | Task to perform a "cleartool checkout" command to ClearCase.
|
---|
143 | <h3>Parameters</h3>
|
---|
144 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
145 | <tr>
|
---|
146 | <td><b>Attribute</b></td>
|
---|
147 | <td><b>Values</b></td>
|
---|
148 | <td><b>Required</b></td>
|
---|
149 | </tr>
|
---|
150 | <tr>
|
---|
151 | <td>viewpath</td>
|
---|
152 | <td>Path to the ClearCase view file or directory that the command
|
---|
153 | will operate on</td>
|
---|
154 | <td>No</td>
|
---|
155 | </tr>
|
---|
156 | <tr>
|
---|
157 | <td>reserved</td>
|
---|
158 | <td>Specifies whether to check out the file as reserved or not</td>
|
---|
159 | <td>Yes</td>
|
---|
160 | </tr>
|
---|
161 | <tr>
|
---|
162 | <td>out</td>
|
---|
163 | <td>Creates a writable file under a different filename</td>
|
---|
164 | <td>No</td>
|
---|
165 | </tr>
|
---|
166 | <tr>
|
---|
167 | <td>nodata</td>
|
---|
168 | <td>Checks out the file but does not create an editable file
|
---|
169 | containing its data</td>
|
---|
170 | <td>No</td>
|
---|
171 | </tr>
|
---|
172 | <tr>
|
---|
173 | <td>branch</td>
|
---|
174 | <td>Specify a branch to check out the file to</td>
|
---|
175 | <td>No</td>
|
---|
176 | </tr>
|
---|
177 | <tr>
|
---|
178 | <td>version</td>
|
---|
179 | <td>Allows checkout of a version other than main latest</td>
|
---|
180 | <td>No</td>
|
---|
181 | </tr>
|
---|
182 | <tr>
|
---|
183 | <td>nowarn</td>
|
---|
184 | <td>Suppress warning messages</td>
|
---|
185 | <td>No</td>
|
---|
186 | </tr>
|
---|
187 | <tr>
|
---|
188 | <td>comment</td>
|
---|
189 | <td>Specify a comment. Only one of comment or commentfile may be used.</td>
|
---|
190 | <td>No</td>
|
---|
191 | </tr>
|
---|
192 | <tr>
|
---|
193 | <td>commentfile</td>
|
---|
194 | <td>Specify a file containing a comment. Only one of comment or
|
---|
195 | commentfile may be used.</td>
|
---|
196 | <td>No</td>
|
---|
197 | </tr>
|
---|
198 | <tr>
|
---|
199 | <td>notco</td>
|
---|
200 | <td>Fail if it's already checked out to the current view. Set to false to ignore it.<br>
|
---|
201 | Since ant 1.6.1</td>
|
---|
202 | <td>No</td>
|
---|
203 | </tr>
|
---|
204 | <tr>
|
---|
205 | <td>failonerr</td>
|
---|
206 | <td>Throw an exception if the command fails. Default is true.<br>
|
---|
207 | Since ant 1.6.1</td>
|
---|
208 | <td>No</td>
|
---|
209 | </tr>
|
---|
210 | </table>
|
---|
211 | <h3>Examples</h3>
|
---|
212 | <blockquote>
|
---|
213 | <pre>
|
---|
214 | <cccheckout viewpath="c:/views/viewdir/afile"
|
---|
215 | reserved="true"
|
---|
216 | branch="abranch"
|
---|
217 | nowarn="true"
|
---|
218 | comment="Some comment text"/>
|
---|
219 | </pre>
|
---|
220 | </blockquote>
|
---|
221 | <p>Does a ClearCase <i>checkout</i> on the file <i>c:/views/viewdir/afile</i>.
|
---|
222 | It is checked out as <i>reserved</i> on branch called <i>abranch</i>. All
|
---|
223 | warning messages are suppressed. A <i>Some comment text</i> is added to
|
---|
224 | ClearCase as a comment.</p>
|
---|
225 | <hr>
|
---|
226 | <h2><a name="ccuncheckout">CCUnCheckout</a></h2>
|
---|
227 | <h3>Description</h3>
|
---|
228 | Task to perform a UnCheckout command to ClearCase.
|
---|
229 | <h3>Parameters</h3>
|
---|
230 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
231 | <tr>
|
---|
232 | <td><b>Attribute</b></td>
|
---|
233 | <td><b>Values</b></td>
|
---|
234 | <td><b>Required</b></td>
|
---|
235 | </tr>
|
---|
236 | <tr>
|
---|
237 | <td>viewpath</td>
|
---|
238 | <td>Path to the ClearCase view file or directory that the command
|
---|
239 | will operate on</td>
|
---|
240 | <td>No</td>
|
---|
241 | </tr>
|
---|
242 | <tr>
|
---|
243 | <td>keepcopy</td>
|
---|
244 | <td>Specifies whether to keep a copy of the file with a .keep
|
---|
245 | extension or not</td>
|
---|
246 | <td>No</td>
|
---|
247 | </tr>
|
---|
248 | <tr>
|
---|
249 | <td>failonerr</td>
|
---|
250 | <td>Throw an exception if the command fails. Default is true<br>
|
---|
251 | Since ant 1.6.1</td>
|
---|
252 | <td>No</td>
|
---|
253 | </tr>
|
---|
254 | </table>
|
---|
255 | <h3>Examples</h3>
|
---|
256 | <blockquote>
|
---|
257 | <pre>
|
---|
258 | <ccuncheckout viewpath="c:/views/viewdir/afile"
|
---|
259 | keepcopy="true"/>
|
---|
260 | </pre>
|
---|
261 | </blockquote>
|
---|
262 | <p>Does a ClearCase <i>uncheckout</i> on the file <i>c:/views/viewdir/afile</i>.
|
---|
263 | A copy of the file called <i>c:/views/viewdir/afile.keep</i> is kept.</p>
|
---|
264 | <hr>
|
---|
265 | <h2><a name="ccupdate">CCUpdate</a></h2>
|
---|
266 | <h3>Description</h3>
|
---|
267 | Task to perform an "cleartool update" command to ClearCase.
|
---|
268 | <h3>Parameters</h3>
|
---|
269 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
270 | <tr>
|
---|
271 | <td><b>Attribute</b></td>
|
---|
272 | <td><b>Values</b></td>
|
---|
273 | <td><b>Required</b></td>
|
---|
274 | </tr>
|
---|
275 | <tr>
|
---|
276 | <td>viewpath</td>
|
---|
277 | <td>Path to the ClearCase snapshot view file or directory that the command
|
---|
278 | will operate on</td>
|
---|
279 | <td>No</td>
|
---|
280 | </tr>
|
---|
281 | <tr>
|
---|
282 | <td>graphical</td>
|
---|
283 | <td>Displays a graphical dialog during the update</td>
|
---|
284 | <td>No</td>
|
---|
285 | </tr>
|
---|
286 | <tr>
|
---|
287 | <td>log</td>
|
---|
288 | <td>Specifies a log file for ClearCase to write to</td>
|
---|
289 | <td>No</td>
|
---|
290 | </tr>
|
---|
291 | <tr>
|
---|
292 | <td>overwrite</td>
|
---|
293 | <td>Specifies whether to overwrite hijacked files or not</td>
|
---|
294 | <td>No</td>
|
---|
295 | </tr>
|
---|
296 | <tr>
|
---|
297 | <td>rename</td>
|
---|
298 | <td>Specifies that hijacked files should be renamed with a .keep extension</td>
|
---|
299 | <td>No</td>
|
---|
300 | </tr>
|
---|
301 | <tr>
|
---|
302 | <td>currenttime</td>
|
---|
303 | <td>Specifies that modification time should be written as the
|
---|
304 | current time. Either currenttime or preservetime can be
|
---|
305 | specified.</td>
|
---|
306 | <td>No</td>
|
---|
307 | </tr>
|
---|
308 | <tr>
|
---|
309 | <td>preservetime</td>
|
---|
310 | <td>Specifies that modification time should preserved from the
|
---|
311 | VOB time. Either currenttime or preservetime can be
|
---|
312 | specified.</td>
|
---|
313 | <td>No</td>
|
---|
314 | </tr>
|
---|
315 | <tr>
|
---|
316 | <td>failonerr</td>
|
---|
317 | <td>Throw an exception if the command fails. Default is true.<br>
|
---|
318 | Since ant 1.6.1</td>
|
---|
319 | <td>No</td>
|
---|
320 | </tr>
|
---|
321 | </table>
|
---|
322 | <h3>Examples</h3>
|
---|
323 | <blockquote>
|
---|
324 | <pre>
|
---|
325 | <ccupdate viewpath="c:/views/viewdir"
|
---|
326 | graphical="false"
|
---|
327 | log="log.log"
|
---|
328 | overwrite="true"
|
---|
329 | currenttime="true"
|
---|
330 | rename="false"/>
|
---|
331 | </pre>
|
---|
332 | </blockquote>
|
---|
333 | <p>Does a ClearCase <i>update</i> on the snapshot view directory <i>c:/views/viewdir</i>.
|
---|
334 | A graphical dialog will be displayed. The output will be logged to
|
---|
335 | <i>log.log</i> and it will overwrite any hijacked files. The modified
|
---|
336 | time will be set to the current time.</p>
|
---|
337 |
|
---|
338 |
|
---|
339 |
|
---|
340 | <hr>
|
---|
341 | <h2><a name="ccmklbtype">CCMklbtype</a></h2>
|
---|
342 | <h3>Description</h3>
|
---|
343 | Task to perform a "mklbtype" command to ClearCase.
|
---|
344 | <h3>Parameters</h3>
|
---|
345 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
346 | <tr>
|
---|
347 | <td><b>Attribute</b></td>
|
---|
348 | <td><b>Values</b></td>
|
---|
349 | <td><b>Required</b></td>
|
---|
350 | </tr>
|
---|
351 | <tr>
|
---|
352 | <td>typename</td>
|
---|
353 | <td>Name of the label type to create</td>
|
---|
354 | <td>Yes</td>
|
---|
355 | <tr>
|
---|
356 | <tr>
|
---|
357 | <td>vob</td>
|
---|
358 | <td>Name of the VOB</td>
|
---|
359 | <td>No</td>
|
---|
360 | <tr>
|
---|
361 | <tr>
|
---|
362 | <td>replace</td>
|
---|
363 | <td>Replace an existing label definition of the same type</td>
|
---|
364 | <td>No</td>
|
---|
365 | <tr>
|
---|
366 | <tr>
|
---|
367 | <td>global</td>
|
---|
368 | <td>Either global or ordinary can be specified, not both. Creates a label type that is global to the VOB or to VOBs that use this VOB</td>
|
---|
369 | <td>No</td>
|
---|
370 | <tr>
|
---|
371 | <tr>
|
---|
372 | <td>ordinary</td>
|
---|
373 | <td>Either global or ordinary can be specified, not both. Creates a label type that can be used only in the current VOB. <B>Default</B></td>
|
---|
374 | <td>No</td>
|
---|
375 | <tr>
|
---|
376 | <tr>
|
---|
377 | <td>pbranch</td>
|
---|
378 | <td>Allows the label type to be used once per branch in a given element's version tree</td>
|
---|
379 | <td>No</td>
|
---|
380 | <tr>
|
---|
381 | <tr>
|
---|
382 | <td>shared</td>
|
---|
383 | <td>Sets the way mastership is checked by ClearCase. See ClearCase documentation for details</td>
|
---|
384 | <td>No</td>
|
---|
385 | <tr>
|
---|
386 | <tr>
|
---|
387 | <td>comment</td>
|
---|
388 | <td>Specify a comment. Only one of comment or cfile may be used.</td>
|
---|
389 | <td>No</td>
|
---|
390 | <tr>
|
---|
391 | <tr>
|
---|
392 | <td>commentfile</td>
|
---|
393 | <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td>
|
---|
394 | <td>No</td>
|
---|
395 | <tr></tr>
|
---|
396 | <tr>
|
---|
397 | <td>failonerr</td>
|
---|
398 | <td>Throw an exception if the command fails. Default is true<br>
|
---|
399 | Since ant 1.6.1</td>
|
---|
400 | <td>No</td>
|
---|
401 | </tr>
|
---|
402 | </table>
|
---|
403 |
|
---|
404 | <h3>Examples</h3>
|
---|
405 | <blockquote>
|
---|
406 | <pre>
|
---|
407 | <ccmklbtype typename="VERSION_1"
|
---|
408 | ordinary="true"
|
---|
409 | comment="Development version 1"/>
|
---|
410 | </pre>
|
---|
411 | </blockquote>
|
---|
412 | <p>Does a ClearCase <i>mklbtype</i> to create a label type named <i>VERSION_1</i>.
|
---|
413 | It is created as <i>ordinary</i> so it is available only to the current VOB.
|
---|
414 | The text <i>Development version 1</i> is added as a comment.</p>
|
---|
415 |
|
---|
416 |
|
---|
417 | <hr>
|
---|
418 | <h2><a name="ccmklabel">CCMklabel</a></h2>
|
---|
419 | <h3>Description</h3>
|
---|
420 | Task to perform a "mklabel" command to ClearCase.
|
---|
421 | <h3>Parameters</h3>
|
---|
422 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
423 | <tr>
|
---|
424 | <td><b>Attribute</b></td>
|
---|
425 | <td><b>Values</b></td>
|
---|
426 | <td><b>Required</b></td>
|
---|
427 | </tr>
|
---|
428 | <tr>
|
---|
429 | <td>typename</td>
|
---|
430 | <td>Name of the label type</td>
|
---|
431 | <td>Yes</td>
|
---|
432 | <tr>
|
---|
433 | <tr>
|
---|
434 | <td>viewpath</td>
|
---|
435 | <td>Path to the ClearCase view file or directory that the command will operate on</td>
|
---|
436 | <td>No</td>
|
---|
437 | <tr>
|
---|
438 | <tr>
|
---|
439 | <td>replace</td>
|
---|
440 | <td>Replace a label of the same type on the same branch</td>
|
---|
441 | <td>No</td>
|
---|
442 | <tr>
|
---|
443 | <tr>
|
---|
444 | <td>recurse</td>
|
---|
445 | <td>Process each subdirectory under viewpath</td>
|
---|
446 | <td>No</td>
|
---|
447 | <tr>
|
---|
448 | <tr>
|
---|
449 | <td>version</td>
|
---|
450 | <td>Identify a specific version to attach the label to</td>
|
---|
451 | <td>No</td>
|
---|
452 | <tr>
|
---|
453 | <tr>
|
---|
454 | <td>vob</td>
|
---|
455 | <td>Name of the VOB</td>
|
---|
456 | <td>No</td>
|
---|
457 | <tr>
|
---|
458 | <tr>
|
---|
459 | <td>comment</td>
|
---|
460 | <td>Specify a comment. Only one of comment or cfile may be used.</td>
|
---|
461 | <td>No</td>
|
---|
462 | <tr>
|
---|
463 | <tr>
|
---|
464 | <td>commentfile</td>
|
---|
465 | <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td>
|
---|
466 | <td>No</td>
|
---|
467 | <tr></tr>
|
---|
468 | <tr>
|
---|
469 | <td>failonerr</td>
|
---|
470 | <td>Throw an exception if the command fails. Default is true<br>
|
---|
471 | Since ant 1.6.1</td>
|
---|
472 | <td>No</td>
|
---|
473 | </tr>
|
---|
474 | </table>
|
---|
475 |
|
---|
476 | <h3>Examples</h3>
|
---|
477 | <blockquote>
|
---|
478 | <pre>
|
---|
479 | <ccmklabel viewpath="c:/views/viewdir/afile"
|
---|
480 | comment="Some comment text"
|
---|
481 | recurse="true"
|
---|
482 | version="\main\2"
|
---|
483 | typename="VERSION_1"/>
|
---|
484 | </pre>
|
---|
485 | </blockquote>
|
---|
486 | <p>Does a ClearCase <i>mklabel</i> on the file <i>c:/views/viewdir/afile</i> under
|
---|
487 | the main branch for version 2 (<i>\main\2</i>). Text <i>Some comment text</i> is added
|
---|
488 | as a comment. It will <i>recurse</i> all subdirectories.
|
---|
489 |
|
---|
490 |
|
---|
491 | <hr>
|
---|
492 | <h2><a name="ccrmtype">CCRmtype</a></h2>
|
---|
493 | <h3>Description</h3>
|
---|
494 | Task to perform a "rmtype" command to ClearCase.
|
---|
495 | <h3>Parameters</h3>
|
---|
496 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
497 | <tr>
|
---|
498 | <td><b>Attribute</b></td>
|
---|
499 | <td><b>Values</b></td>
|
---|
500 | <td><b>Required</b></td>
|
---|
501 | </tr>
|
---|
502 | <tr>
|
---|
503 | <td>typekind</td>
|
---|
504 | <td>The kind of type to create. Valid types are:
|
---|
505 | <table border="0" width="40%" class="layout">
|
---|
506 | <tr>
|
---|
507 | <td><b>attype</b><br>
|
---|
508 | <b>brtype</b><br>
|
---|
509 | <b>eltype</b><br>
|
---|
510 | <b>hltype</b><br>
|
---|
511 | <b>lbtype</b><br>
|
---|
512 | <b>trtype</b>
|
---|
513 | </td>
|
---|
514 | <td>- <br>
|
---|
515 | - <br>
|
---|
516 | - <br>
|
---|
517 | - <br>
|
---|
518 | - <br>
|
---|
519 | -
|
---|
520 | </td>
|
---|
521 | <td>attribute type<br>
|
---|
522 | branch type<br>
|
---|
523 | element type<br>
|
---|
524 | hyperlink type<br>
|
---|
525 | label type<br>
|
---|
526 | trigger type
|
---|
527 | </td>
|
---|
528 | </tr>
|
---|
529 | </table>
|
---|
530 | </td>
|
---|
531 | <td>Yes</td>
|
---|
532 | <tr>
|
---|
533 | <tr>
|
---|
534 | <td>typename</td>
|
---|
535 | <td>The name of the type to remove</td>
|
---|
536 | <td>Yes</td>
|
---|
537 | <tr>
|
---|
538 | <tr>
|
---|
539 | <td>ignore</td>
|
---|
540 | <td>Used with trigger types only. Forces removal of trigger type even if a pre-operation trigger would prevent its removal</td>
|
---|
541 | <td>No</td>
|
---|
542 | <tr>
|
---|
543 | <tr>
|
---|
544 | <td>rmall</td>
|
---|
545 | <td>Removes all instances of a type and the type object itself</td>
|
---|
546 | <td>No</td>
|
---|
547 | <tr>
|
---|
548 | <tr>
|
---|
549 | <td>comment</td>
|
---|
550 | <td>Specify a comment. Only one of comment or cfile may be used.</td>
|
---|
551 | <td>No</td>
|
---|
552 | <tr>
|
---|
553 | <tr>
|
---|
554 | <td>commentfile</td>
|
---|
555 | <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td>
|
---|
556 | <td>No</td>
|
---|
557 | <tr></tr>
|
---|
558 | <tr>
|
---|
559 | <td>failonerr</td>
|
---|
560 | <td>Throw an exception if the command fails. Default is true
|
---|
561 | Since ant 1.6.1</td>
|
---|
562 | <td>No</td>
|
---|
563 | </tr>
|
---|
564 | </table>
|
---|
565 |
|
---|
566 | <h3>Examples</h3>
|
---|
567 | <blockquote>
|
---|
568 | <pre>
|
---|
569 | <ccrmtype typekind="lbtype"
|
---|
570 | typename="VERSION_1"
|
---|
571 | commentfile="acomment.txt"
|
---|
572 | rmall="true"/>
|
---|
573 | </pre>
|
---|
574 | </blockquote>
|
---|
575 | <p>Does a ClearCase <i>rmtype</i> to remove a label type (<i>lbtype</i>) named <i>VERSION_1</i>.
|
---|
576 | Comment text from the file <i>acomment.txt</i> is added as a comment. All instances of the type
|
---|
577 | are removed, including the type object itself.</p>
|
---|
578 | <hr>
|
---|
579 |
|
---|
580 | <h2><a name="cclock">CCLock</a></h2>
|
---|
581 | <h3>Description</h3>
|
---|
582 | Task to perform a "cleartool lock" command to ClearCase.
|
---|
583 | <h3>Parameters</h3>
|
---|
584 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
585 | <tr>
|
---|
586 | <td><b>Attribute</b></td>
|
---|
587 | <td><b>Values</b></td>
|
---|
588 | <td><b>Required</b></td>
|
---|
589 | </tr>
|
---|
590 | <tr>
|
---|
591 | <td>replace</td>
|
---|
592 | <td>Specifies replacing an existing lock</td>
|
---|
593 | <td>No</td>
|
---|
594 | <tr>
|
---|
595 | <tr>
|
---|
596 | <td>nusers</td>
|
---|
597 | <td>Specifies user(s) who can still modify the object</td>
|
---|
598 | <td>No</td>
|
---|
599 | <tr>
|
---|
600 | <tr>
|
---|
601 | <td>obsolete</td>
|
---|
602 | <td>Specifies that the object should be marked obsolete</td>
|
---|
603 | <td>No</td>
|
---|
604 | <tr>
|
---|
605 | <tr>
|
---|
606 | <td>comment</td>
|
---|
607 | <td>Specifies how to populate comments fields</td>
|
---|
608 | <td>No</td>
|
---|
609 | <tr>
|
---|
610 | <tr>
|
---|
611 | <td>pname</td>
|
---|
612 | <td>Specifies the object pathname to be locked.</td>
|
---|
613 | <td>No</td>
|
---|
614 | <tr>
|
---|
615 | <td>objselect</td>
|
---|
616 | <td>This variable is obsolete. Should use <i>objsel</i> instead.</td>
|
---|
617 | <td>No</td>
|
---|
618 | <tr>
|
---|
619 | <tr>
|
---|
620 | <td>objsel</td>
|
---|
621 | <td>Specifies the object(s) to be locked.<br>
|
---|
622 | Since ant 1.6.1</td>
|
---|
623 | <td>No</td>
|
---|
624 | <tr>
|
---|
625 | <tr>
|
---|
626 | <td>failonerr</td>
|
---|
627 | <td>Throw an exception if the command fails. Default is true.<br>
|
---|
628 | Since ant 1.6.1</td>
|
---|
629 | <td>No</td>
|
---|
630 | </tr>
|
---|
631 |
|
---|
632 | </table>
|
---|
633 | <h3>Examples</h3>
|
---|
634 | <blockquote>
|
---|
635 | <pre>
|
---|
636 | <cclock
|
---|
637 | objsel="stream:Application_Integration@\MyProject_PVOB"
|
---|
638 | />
|
---|
639 | </pre>
|
---|
640 | </blockquote>
|
---|
641 | <p>Does a ClearCase <i>lock</i> on the object <i>stream:Application_Integration@\MyProject_PVOB</i>.</p>
|
---|
642 | <hr>
|
---|
643 |
|
---|
644 | <h2><a name="ccunlock">CCUnlock</a></h2>
|
---|
645 | <h3>Description</h3>
|
---|
646 | Task to perform a "cleartool unlock" command to ClearCase.
|
---|
647 | <h3>Parameters</h3>
|
---|
648 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
649 | <tr>
|
---|
650 | <td><b>Attribute</b></td>
|
---|
651 | <td><b>Values</b></td>
|
---|
652 | <td><b>Required</b></td>
|
---|
653 | </tr>
|
---|
654 | <tr>
|
---|
655 | <td>comment</td>
|
---|
656 | <td>Specifies how to populate comments fields</td>
|
---|
657 | <td>No</td>
|
---|
658 | <tr>
|
---|
659 | <tr>
|
---|
660 | <td>pname</td>
|
---|
661 | <td>Specifies the object pathname to be unlocked.</td>
|
---|
662 | <td>No</td>
|
---|
663 | <tr>
|
---|
664 | <td>objselect</td>
|
---|
665 | <td>This variable is obsolete. Should use <i>objsel</i> instead.</td>
|
---|
666 | <td>No</td>
|
---|
667 | <tr>
|
---|
668 | <tr>
|
---|
669 | <td>objsel</td>
|
---|
670 | <td>Specifies the object(s) to be unlocked.<br>
|
---|
671 | Since ant 1.6.1</td>
|
---|
672 | <td>No</td>
|
---|
673 | <tr>
|
---|
674 | <tr>
|
---|
675 | <td>failonerr</td>
|
---|
676 | <td>Throw an exception if the command fails. Default is true.<br>
|
---|
677 | Since ant 1.6.1</td>
|
---|
678 | <td>No</td>
|
---|
679 | </tr>
|
---|
680 |
|
---|
681 | </table>
|
---|
682 | <h3>Examples</h3>
|
---|
683 | <blockquote>
|
---|
684 | <pre>
|
---|
685 | <ccunlock
|
---|
686 | objsel="stream:Application_Integration@\MyProject_PVOB"
|
---|
687 | />
|
---|
688 | </pre>
|
---|
689 | </blockquote>
|
---|
690 | <p>Does a ClearCase <i>unlock</i> on the object <i>stream:Application_Integration@\MyProject_PVOB</i>.</p>
|
---|
691 | <hr>
|
---|
692 |
|
---|
693 | <h2><a name="ccmkbl">CCMkbl</a></h2>
|
---|
694 | <h3>Description</h3>
|
---|
695 | Task to perform a "cleartool mkbl" command to ClearCase.
|
---|
696 | <h3>Parameters</h3>
|
---|
697 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
698 | <tr>
|
---|
699 | <td><b>Attribute</b></td>
|
---|
700 | <td><b>Values</b></td>
|
---|
701 | <td><b>Required</b></td>
|
---|
702 | </tr>
|
---|
703 | <tr>
|
---|
704 | <td>comment</td>
|
---|
705 | <td>Specify a comment. Only one of comment or cfile may be
|
---|
706 | used.</td>
|
---|
707 | <td>No</td>
|
---|
708 | </tr>
|
---|
709 | <tr>
|
---|
710 | <td>commentfile</td>
|
---|
711 | <td>Specify a file containing a comment. Only one of comment or
|
---|
712 | cfile may be used.</td>
|
---|
713 | <td>No</td>
|
---|
714 | </tr>
|
---|
715 | <tr>
|
---|
716 | <td>baselinerootname</td>
|
---|
717 | <td>Specify the name to be associated with the baseline.</td>
|
---|
718 | <td>Yes</td>
|
---|
719 | </tr>
|
---|
720 | <tr>
|
---|
721 | <td>nowarn</td>
|
---|
722 | <td>Suppress warning messages</td>
|
---|
723 | <td>No</td>
|
---|
724 | <tr>
|
---|
725 | <tr>
|
---|
726 | <td>identical</td>
|
---|
727 | <td>Allows the baseline to be created even if it is identical to the
|
---|
728 | previous baseline.</td>
|
---|
729 | <td>No</td>
|
---|
730 | </tr>
|
---|
731 | <tr>
|
---|
732 | <td>full</td>
|
---|
733 | <td>Creates a full baseline.</td>
|
---|
734 | <td>No</td>
|
---|
735 | </tr>
|
---|
736 | <tr>
|
---|
737 | <td>nlabel</td>
|
---|
738 | <td>Allows the baseline to be created without a label.</td>
|
---|
739 | <td>No</td>
|
---|
740 | </tr>
|
---|
741 | <tr>
|
---|
742 | <td>failonerr</td>
|
---|
743 | <td>Throw an exception if the command fails. Default is true.<br>
|
---|
744 | Since ant 1.6.1</td>
|
---|
745 | <td>No</td>
|
---|
746 | </tr>
|
---|
747 | </table>
|
---|
748 | <h3>Examples</h3>
|
---|
749 | <blockquote>
|
---|
750 | <pre>
|
---|
751 | <ccmkbl
|
---|
752 | baselinerootname="Application_Baseline_AUTO"
|
---|
753 | identical="yes"
|
---|
754 | full="no"
|
---|
755 | viewpath="v:\ApplicationCC"
|
---|
756 | />
|
---|
757 | </pre>
|
---|
758 | </blockquote>
|
---|
759 | <p>Does a ClearCase <i>mkbl</i> on the Integration view at <i>v:\ApplicationCC</i>
|
---|
760 | even if it is <i>identical</i> to a previous baseline. The new baseline with be
|
---|
761 | incremental and named "Application_Baseline_AUTO".</p>
|
---|
762 | <hr>
|
---|
763 |
|
---|
764 | <h2><a name="ccmkattr">CCMkattr</a></h2>
|
---|
765 | <h3>Description</h3>
|
---|
766 | Task to perform a "cleartool mkattr" command to ClearCase.<br>
|
---|
767 | Since ant 1.6.1
|
---|
768 | <h3>Parameters</h3>
|
---|
769 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
770 | <tr>
|
---|
771 | <td><b>Attribute</b></td>
|
---|
772 | <td><b>Values</b></td>
|
---|
773 | <td><b>Required</b></td>
|
---|
774 | </tr>
|
---|
775 | <tr>
|
---|
776 | <td>viewpath</td>
|
---|
777 | <td>Path to the ClearCase view file or directory that the command will operate on</td>
|
---|
778 | <td>Yes</td>
|
---|
779 | </tr>
|
---|
780 | <tr>
|
---|
781 | <td>replace</td>
|
---|
782 | <td>Replace the value of the attribute if it already exists</td>
|
---|
783 | <td>No</td>
|
---|
784 | </tr>
|
---|
785 | <tr>
|
---|
786 | <td>recurse</td>
|
---|
787 | <td>Process each subdirectory under viewpath</td>
|
---|
788 | <td>No</td>
|
---|
789 | </tr>
|
---|
790 | <tr>
|
---|
791 | <td>version</td>
|
---|
792 | <td>Identify a specific version to attach the attribute to</td>
|
---|
793 | <td>No</td>
|
---|
794 | </tr>
|
---|
795 | <tr>
|
---|
796 | <td>typename</td>
|
---|
797 | <td>Name of the attribute type</td>
|
---|
798 | <td>Yes</td>
|
---|
799 | </tr>
|
---|
800 | <tr>
|
---|
801 | <td>typevalue</td>
|
---|
802 | <td>Value to attach to the attribute type</td>
|
---|
803 | <td>Yes</td>
|
---|
804 | </tr>
|
---|
805 | <tr>
|
---|
806 | <td>comment</td>
|
---|
807 | <td>Specify a comment. Only one of comment or cfile may be used.</td>
|
---|
808 | <td>No</td>
|
---|
809 | </tr>
|
---|
810 | <tr>
|
---|
811 | <td>commentfile</td>
|
---|
812 | <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td>
|
---|
813 | <td>No</td>
|
---|
814 | </tr>
|
---|
815 | <tr>
|
---|
816 | <td>failonerr</td>
|
---|
817 | <td>Throw an exception if the command fails. Default is true</td>
|
---|
818 | <td>No</td>
|
---|
819 | </tr>
|
---|
820 | </table>
|
---|
821 | <h3>Examples</h3>
|
---|
822 | <blockquote>
|
---|
823 | <pre>
|
---|
824 | <ccmkattr viewpath="c:/views/viewdir/afile"
|
---|
825 | typename="BugFix"
|
---|
826 | typevalue="34445"
|
---|
827 | />
|
---|
828 | </pre>
|
---|
829 | </blockquote>
|
---|
830 | <p>Does a ClearCase <i>mkattr</i> on the file <i>c:/views/viewdir/afile</i> and
|
---|
831 | attaches the attribute <i>BugFix</i> with a value of <i>34445</i> to it.</p>
|
---|
832 | <hr>
|
---|
833 |
|
---|
834 | <h2><a name="ccmkdir">CCMkdir</a></h2>
|
---|
835 | <h3>Description</h3>
|
---|
836 | Task to perform a "cleartool mkdir" command to ClearCase.<br>
|
---|
837 | Since ant 1.6.1
|
---|
838 | <h3>Parameters</h3>
|
---|
839 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
840 | <tr>
|
---|
841 | <td><b>Attribute</b></td>
|
---|
842 | <td><b>Values</b></td>
|
---|
843 | <td><b>Required</b></td>
|
---|
844 | </tr>
|
---|
845 | <tr>
|
---|
846 | <td>viewpath</td>
|
---|
847 | <td>Path to the ClearCase view directory that the command will operate on</td>
|
---|
848 | <td>Yes</td>
|
---|
849 | </tr>
|
---|
850 | <tr>
|
---|
851 | <td>comment</td>
|
---|
852 | <td>Specify a comment. Only one of comment or cfile may be used.</td>
|
---|
853 | <td>No</td>
|
---|
854 | </tr>
|
---|
855 | <tr>
|
---|
856 | <td>commentfile</td>
|
---|
857 | <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td>
|
---|
858 | <td>No</td>
|
---|
859 | </tr>
|
---|
860 | <tr>
|
---|
861 | <td>nocheckout</td>
|
---|
862 | <td>Do not checkout after element creation</td>
|
---|
863 | <td>No</td>
|
---|
864 | </tr>
|
---|
865 | <tr>
|
---|
866 | <td>failonerr</td>
|
---|
867 | <td>Throw an exception if the command fails. Default is true</td>
|
---|
868 | <td>No</td>
|
---|
869 | </tr>
|
---|
870 | </table>
|
---|
871 | <h3>Examples</h3>
|
---|
872 | <blockquote>
|
---|
873 | <pre>
|
---|
874 | <ccmkdir viewpath="c:/views/viewdir/adir"
|
---|
875 | nochcekout="true"
|
---|
876 | comment="Some comment text"/>
|
---|
877 | </pre>
|
---|
878 | </blockquote>
|
---|
879 | <p>Does a ClearCase <i>mkdir</i> on the dir <i>c:/views/viewdir/adir</i> and
|
---|
880 | does not automatically check it out.</p>
|
---|
881 | <hr>
|
---|
882 |
|
---|
883 | <h2><a name="ccmkelem">CCMkelem</a></h2>
|
---|
884 | <h3>Description</h3>
|
---|
885 | Task to perform a "cleartool mkelem" command to ClearCase.<br>
|
---|
886 | Since ant 1.6.1
|
---|
887 | <h3>Parameters</h3>
|
---|
888 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
889 | <tr>
|
---|
890 | <td><b>Attribute</b></td>
|
---|
891 | <td><b>Values</b></td>
|
---|
892 | <td><b>Required</b></td>
|
---|
893 | </tr>
|
---|
894 | <tr>
|
---|
895 | <td>viewpath</td>
|
---|
896 | <td>Path to the ClearCase view file or directory that the command will operate on</td>
|
---|
897 | <td>Yes</td>
|
---|
898 | <tr>
|
---|
899 | <tr>
|
---|
900 | <td>comment</td>
|
---|
901 | <td>Specify a comment. Only one of comment or cfile may be used.</td>
|
---|
902 | <td>No</td>
|
---|
903 | <tr>
|
---|
904 | <tr>
|
---|
905 | <td>commentfile</td>
|
---|
906 | <td>Specify a file containing a comment. Only one of comment or cfile may be used.</td>
|
---|
907 | <td>No</td>
|
---|
908 | <tr>
|
---|
909 | <tr>
|
---|
910 | <td>nowarn</td>
|
---|
911 | <td>Suppress warning messages</td>
|
---|
912 | <td>No</td>
|
---|
913 | <tr>
|
---|
914 | <tr>
|
---|
915 | <td>nocheckout</td>
|
---|
916 | <td>Do not checkout after element creation</td>
|
---|
917 | <td>No</td>
|
---|
918 | <tr>
|
---|
919 | <tr>
|
---|
920 | <td>checkin</td>
|
---|
921 | <td>Checkin element after creation</td>
|
---|
922 | <td>No</td>
|
---|
923 | <tr>
|
---|
924 | <tr>
|
---|
925 | <td>preservetime</td>
|
---|
926 | <td>Preserve the modification time (for checkin)</td>
|
---|
927 | <td>No</td>
|
---|
928 | <tr>
|
---|
929 | <tr>
|
---|
930 | <td>master</td>
|
---|
931 | <td>Assign mastership of the main branch to the current site</td>
|
---|
932 | <td>No</td>
|
---|
933 | <tr>
|
---|
934 | <tr>
|
---|
935 | <td>eltype</td>
|
---|
936 | <td>Element type to use during element creation</td>
|
---|
937 | <td>No</td>
|
---|
938 | <tr>
|
---|
939 | <tr>
|
---|
940 | <td>failonerr</td>
|
---|
941 | <td>Throw an exception if the command fails. Default is true</td>
|
---|
942 | <td>No</td>
|
---|
943 | <tr>
|
---|
944 | </table>
|
---|
945 | <h3>Examples</h3>
|
---|
946 | <blockquote>
|
---|
947 | <pre>
|
---|
948 | <ccmkelem viewpath="c:/views/viewdir/afile"
|
---|
949 | eltype="text_file"
|
---|
950 | checkin="true"
|
---|
951 | comment="Some comment text"/>
|
---|
952 | </pre>
|
---|
953 | </blockquote>
|
---|
954 | <p>Does a ClearCase <i>mkelem</i> on the file <i>c:/views/viewdir/afile</i> with
|
---|
955 | element type <i>text_file</i>. It also checks in the file after creation.</p>
|
---|
956 |
|
---|
957 | </body>
|
---|
958 | </html>
|
---|