You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

clearcase.html 24 KiB

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