@@ -6,19 +6,45 @@
</head>
</head>
<body>
<body>
<h1>Ant ClearCase Tasks</h1>
<p>by:<br>
Curtis White (cwhite at aracnet dot com),<br>
Sean P. Kane (spkane at genomatica dot com), and<br>
Rob Anderson (Anderson.Rob at vectorscm dot com)</p>
<p>Version 1.6 - 02/25/2003</p>
<h1>ClearCase Support</h1>
<h1>ClearCase Support</h1>
<h2>Table of Contents</h2>
<ul>
<ul>
<li><a href="#cccheckin">CCCheckin</a></li>
<li><a href="#cccheckout">CCCheckout</a></li>
<li><a href="#ccuncheckout">CCUnCheckout</a></li>
<li><a href="#ccupdate">CCUpdate</a></li>
<li><A href="#introduction">Introduction</a>
<li><A href="#cccheckin">CCCheckin</a>
<li><A href="#cccheckout">CCCheckout</a>
<li><A href="#ccuncheckout">CCUnCheckout</a>
<li><A href="#ccupdate">CCUpdate</a>
<li><A href="#ccmklbtype">CCMklbtype</a>
<li><A href="#ccmklabel">CCMklabel</a>
<li><A href="#ccrmtype">CCRmtype</a>
<li><A href="#cclock">CCLock</a>
<li><A href="#ccunlock">CCUnlock</a>
<li><A href="#ccmkbl">CCMkbl</a></li>
</ul>
</ul>
<hr>
<h2><a name="introduction">Introduction</a></h2>
<p>Ant provides several optional tasks for working with ClearCase. These tasks correspond to various
ClearCase commands using the Cleartool program. The current tasks avaliable for Ant correspond to only
a few of the significant ClearCase commands.</p>
<p>More tasks can be easily added by deriving from the ClearCase class and then adding
functionality that is specific to that ClearCase command.</p>
<hr>
<hr>
<h2><a name="cccheckin">CCCheckin</a></h2>
<h2><a name="cccheckin">CCCheckin</a></h2>
<h3>Description</h3>
<h3>Description</h3>
Task to perform a Checkin command to ClearCase.
Task to perform a "cleartool checkin" command to ClearCase.
<h3>Parameters</h3>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<tr>
@@ -28,7 +54,7 @@ Task to perform a Checkin command to ClearCase.
</tr>
</tr>
<tr>
<tr>
<td>viewpath</td>
<td>viewpath</td>
<td>Path to the ClearCase view file or directory that the command
<td>Path to the ClearCase view file or directory that the command
will operate on</td>
will operate on</td>
<td>No</td>
<td>No</td>
</tr>
</tr>
@@ -39,7 +65,7 @@ Task to perform a Checkin command to ClearCase.
</tr>
</tr>
<tr>
<tr>
<td>commentfile</td>
<td>commentfile</td>
<td>Specify a file containing a comment. Only one of comment or commentfile
<td>Specify a file containing a comment. Only one of comment or commentfile
may be used.</td>
may be used.</td>
<td>No</td>
<td>No</td>
</tr>
</tr>
@@ -60,7 +86,7 @@ Task to perform a Checkin command to ClearCase.
</tr>
</tr>
<tr>
<tr>
<td>identical</td>
<td>identical</td>
<td>Allows the file to be checked in even if it is identical
<td>Allows the file to be checked in even if it is identical
to the original</td>
to the original</td>
<td>No</td>
<td>No</td>
</tr>
</tr>
@@ -68,20 +94,20 @@ Task to perform a Checkin command to ClearCase.
<h3>Examples</h3>
<h3>Examples</h3>
<blockquote>
<blockquote>
<pre>
<pre>
<cccheckin viewpath="c:/views/viewdir/afile"
commentfile="acomment.txt"
nowarn="true"
identical="true" />
<cccheckin viewpath="c:/views/viewdir/afile"
commentfile="acomment.txt"
nowarn="true"
identical="true" />
</pre>
</pre>
</blockquote>
</blockquote>
<p>Does a ClearCase <i>checkin</i> on the file <i>c:/views/viewdir/afile</i>.
<p>Does a ClearCase <i>checkin</i> on the file <i>c:/views/viewdir/afile</i>.
Comment text from the file <i>acomment.txt</i> is added to ClearCase as a comment.
Comment text from the file <i>acomment.txt</i> is added to ClearCase as a comment.
All warning messages are suppressed. The file is checked in even if it is
All warning messages are suppressed. The file is checked in even if it is
<i>identical</i> to the original.</p>
<i>identical</i> to the original.</p>
<hr>
<hr>
<h2><a name="cccheckout">CCCheckout</a></h2>
<h2><a name="cccheckout">CCCheckout</a></h2>
<h3>Description</h3>
<h3>Description</h3>
Task to perform a Checkout command to ClearCase.
Task to perform a "cleartool checkout" command to ClearCase.
<h3>Parameters</h3>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<tr>
@@ -91,7 +117,7 @@ Task to perform a Checkout command to ClearCase.
</tr>
</tr>
<tr>
<tr>
<td>viewpath</td>
<td>viewpath</td>
<td>Path to the ClearCase view file or directory that the command
<td>Path to the ClearCase view file or directory that the command
will operate on</td>
will operate on</td>
<td>No</td>
<td>No</td>
</tr>
</tr>
@@ -107,7 +133,7 @@ Task to perform a Checkout command to ClearCase.
</tr>
</tr>
<tr>
<tr>
<td>nodata</td>
<td>nodata</td>
<td>Checks out the file but does not create an editable file
<td>Checks out the file but does not create an editable file
containing its data</td>
containing its data</td>
<td>No</td>
<td>No</td>
</tr>
</tr>
@@ -133,7 +159,7 @@ Task to perform a Checkout command to ClearCase.
</tr>
</tr>
<tr>
<tr>
<td>commentfile</td>
<td>commentfile</td>
<td>Specify a file containing a comment. Only one of comment or
<td>Specify a file containing a comment. Only one of comment or
commentfile may be used.</td>
commentfile may be used.</td>
<td>No</td>
<td>No</td>
</tr>
</tr>
@@ -141,16 +167,16 @@ Task to perform a Checkout command to ClearCase.
<h3>Examples</h3>
<h3>Examples</h3>
<blockquote>
<blockquote>
<pre>
<pre>
<cccheckout viewpath="c:/views/viewdir/afile"
reserved="true"
branch="abranch"
nowarn="true"
comment="Some comment text" />
<cccheckout viewpath="c:/views/viewdir/afile"
reserved="true"
branch="abranch"
nowarn="true"
comment="Some comment text" />
</pre>
</pre>
</blockquote>
</blockquote>
<p>Does a ClearCase <i>checkout</i> on the file <i>c:/views/viewdir/afile</i>.
It is checked out as <i>reserved</i> on branch called <i>abranch</i>. All
warning messages are suppressed. A <i>Some comment text</i> is added to
<p>Does a ClearCase <i>checkout</i> on the file <i>c:/views/viewdir/afile</i>.
It is checked out as <i>reserved</i> on branch called <i>abranch</i>. All
warning messages are suppressed. A <i>Some comment text</i> is added to
ClearCase as a comment.</p>
ClearCase as a comment.</p>
<hr>
<hr>
<h2><a name="ccuncheckout">CCUnCheckout</a></h2>
<h2><a name="ccuncheckout">CCUnCheckout</a></h2>
@@ -165,13 +191,13 @@ Task to perform a UnCheckout command to ClearCase.
</tr>
</tr>
<tr>
<tr>
<td>viewpath</td>
<td>viewpath</td>
<td>Path to the ClearCase view file or directory that the command
<td>Path to the ClearCase view file or directory that the command
will operate on</td>
will operate on</td>
<td>No</td>
<td>No</td>
</tr>
</tr>
<tr>
<tr>
<td>keepcopy</td>
<td>keepcopy</td>
<td>Specifies whether to keep a copy of the file with a .keep
<td>Specifies whether to keep a copy of the file with a .keep
extension or not</td>
extension or not</td>
<td>No</td>
<td>No</td>
</tr>
</tr>
@@ -179,16 +205,16 @@ Task to perform a UnCheckout command to ClearCase.
<h3>Examples</h3>
<h3>Examples</h3>
<blockquote>
<blockquote>
<pre>
<pre>
<ccuncheckout viewpath="c:/views/viewdir/afile"
keepcopy="true" />
<ccuncheckout viewpath="c:/views/viewdir/afile"
keepcopy="true" />
</pre>
</pre>
</blockquote>
</blockquote>
<p>Does a ClearCase <i>uncheckout</i> on the file <i>c:/views/viewdir/afile</i>.
<p>Does a ClearCase <i>uncheckout</i> on the file <i>c:/views/viewdir/afile</i>.
A copy of the file called <i>c:/views/viewdir/afile.keep</i> is kept.</p>
A copy of the file called <i>c:/views/viewdir/afile.keep</i> is kept.</p>
<hr>
<hr>
<h2><a name="ccupdate">CCUpdate</a></h2>
<h2><a name="ccupdate">CCUpdate</a></h2>
<h3>Description</h3>
<h3>Description</h3>
Task to perform an Update command to ClearCase.
Task to perform an "cleartool update" command to ClearCase.
<h3>Parameters</h3>
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<tr>
@@ -198,7 +224,7 @@ Task to perform an Update command to ClearCase.
</tr>
</tr>
<tr>
<tr>
<td>viewpath</td>
<td>viewpath</td>
<td>Path to the ClearCase view file or directory that the command
<td>Path to the ClearCase snapshot view file or directory that the command
will operate on</td>
will operate on</td>
<td>No</td>
<td>No</td>
</tr>
</tr>
@@ -224,15 +250,15 @@ Task to perform an Update command to ClearCase.
</tr>
</tr>
<tr>
<tr>
<td>currenttime</td>
<td>currenttime</td>
<td>Specifies that modification time should be written as the
current time. Either currenttime or preservetime can be
<td>Specifies that modification time should be written as the
current time. Either currenttime or preservetime can be
specified.</td>
specified.</td>
<td>No</td>
<td>No</td>
</tr>
</tr>
<tr>
<tr>
<td>preservetime</td>
<td>preservetime</td>
<td>Specifies that modification time should preserved from the
VOB time. Either currenttime or preservetime can be
<td>Specifies that modification time should preserved from the
VOB time. Either currenttime or preservetime can be
specified.</td>
specified.</td>
<td>No</td>
<td>No</td>
</tr>
</tr>
@@ -240,22 +266,399 @@ Task to perform an Update command to ClearCase.
<h3>Examples</h3>
<h3>Examples</h3>
<blockquote>
<blockquote>
<pre>
<pre>
<ccupdate viewpath="c:/views/viewdir"
graphical="false"
log="log.log"
overwrite="true"
currenttime="true"
rename="false" />
<ccupdate viewpath="c:/views/viewdir"
graphical="false"
log="log.log"
overwrite="true"
currenttime="true"
rename="false" />
</pre>
</pre>
</blockquote>
</blockquote>
<p>Does a ClearCase <i>update</i> on the directory <i>c:/views/viewdir</i>.
A graphical dialog will be displayed. The output will be logged to
<i>log.log</i> and it will overwrite any hijacked files. The modified
<p>Does a ClearCase <i>update</i> on the snapshot view directory <i>c:/views/viewdir</i>.
A graphical dialog will be displayed. The output will be logged to
<i>log.log</i> and it will overwrite any hijacked files. The modified
time will be set to the current time.</p>
time will be set to the current time.</p>
<hr>
<hr>
<p align="center">Copyright © 2000-2002 Apache Software Foundation. All rights
Reserved.</p>
</body>
<h2><a name="ccmklbtype">CCMklbtype</a></h2>
<h3>Description</h3>
Task to perform a "mklbtype" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
<td>typename</td>
<td>Name of the label type to create</td>
<td>Yes</td>
<tr>
<tr>
<td>vob</td>
<td>Name of the VOB</td>
<td>No</td>
<tr>
<tr>
<td>replace</td>
<td>Replace an existing label definition of the same type</td>
<td>No</td>
<tr>
<tr>
<td>global</td>
<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>
<td>No</td>
<tr>
<tr>
<td>ordinary</td>
<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>
<td>No</td>
<tr>
<tr>
<td>pbranch</td>
<td>Allows the label type to be used once per branch in a given element's version tree</td>
<td>No</td>
<tr>
<tr>
<td>shared</td>
<td>Sets the way mastership is checked by ClearCase. See ClearCase documentation for details</td>
<td>No</td>
<tr>
<tr>
<td>comment</td>
<td>Specify a comment. Only one of comment or cfile may be used.</td>
<td>No</td>
<tr>
<tr>
<td>commentfile</td>
<td>Specify a file containing a comment. Only one of comment or cfile may be used.</td>
<td>No</td>
<tr></tr>
</table>
<h3>Examples</h3>
<blockquote>
<pre>
<ccmklbtype typename="VERSION_1"
ordinary="true"
comment="Development version 1"/>
</pre>
</blockquote>
<p>Does a ClearCase <i>mklbtype</i> to create a label type named <i>VERSION_1</i>.
It is created as <i>ordinary</i> so it is available only to the current VOB.
The text <i>Development version 1</i> is added as a comment.</p>
<hr>
<h2><a name="ccmklabel">CCMklabel</a></h2>
<h3>Description</h3>
Task to perform a "mklabel" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
<td>typename</td>
<td>Name of the label type</td>
<td>Yes</td>
<tr>
<tr>
<td>viewpath</td>
<td>Path to the ClearCase view file or directory that the command will operate on</td>
<td>No</td>
<tr>
<tr>
<td>replace</td>
<td>Replace a label of the same type on the same branch</td>
<td>No</td>
<tr>
<tr>
<td>recurse</td>
<td>Process each subdirectory under viewpath</td>
<td>No</td>
<tr>
<tr>
<td>version</td>
<td>Identify a specific version to attach the label to</td>
<td>No</td>
<tr>
<tr>
<td>vob</td>
<td>Name of the VOB</td>
<td>No</td>
<tr>
<tr>
<td>comment</td>
<td>Specify a comment. Only one of comment or cfile may be used.</td>
<td>No</td>
<tr>
<tr>
<td>commentfile</td>
<td>Specify a file containing a comment. Only one of comment or cfile may be used.</td>
<td>No</td>
<tr></tr>
</table>
<h3>Examples</h3>
<blockquote>
<pre>
<ccmklabel viewpath="c:/views/viewdir/afile"
comment="Some comment text"
recurse="true"
version="\main\2"
typename="VERSION_1"/>
</pre>
</blockquote>
<p>Does a ClearCase <i>mklabel</i> on the file <i>c:/views/viewdir/afile</i> under
the main branch for version 2 (<i>\main\2</i>). Text <i>Some comment text</i> is added
as a comment. It will <i>recurse</i> all subdirectories.
<hr>
<h2><a name="ccrmtype">CCRmtype</a></h2>
<h3>Description</h3>
Task to perform a "rmtype" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
<td>typekind</td>
<td>The kind of type to create. Valid types are:
<table border="0" width="40%">
<tr>
<td width="15%"> </td>
<td><b>attype</b><br>
<b>brtype</b><br>
<b>eltype</b><br>
<b>hltype</b><br>
<b>lbtype</b><br>
<b>trtype</b>
</td>
<td>- <br>
- <br>
- <br>
- <br>
- <br>
-
</td>
<td>attribute type<br>
branch type<br>
element type<br>
hyperlink type<br>
label type<br>
trigger type
</td>
</tr>
</table>
</td>
<td>Yes</td>
<tr>
<tr>
<td>typename</td>
<td>The name of the type to remove</td>
<td>Yes</td>
<tr>
<tr>
<td>ignore</td>
<td>Used with trigger types only. Forces removal of trigger type even if a pre-operation trigger would prevent its removal</td>
<td>No</td>
<tr>
<tr>
<td>rmall</td>
<td>Removes all instances of a type and the type object itself</td>
<td>No</td>
<tr>
<tr>
<td>comment</td>
<td>Specify a comment. Only one of comment or cfile may be used.</td>
<td>No</td>
<tr>
<tr>
<td>commentfile</td>
<td>Specify a file containing a comment. Only one of comment or cfile may be used.</td>
<td>No</td>
<tr></tr>
</table>
<h3>Examples</h3>
<blockquote>
<pre>
<ccrmtype typekind="lbtype"
typename="VERSION_1"
commentfile="acomment.txt"
rmall="true"/>
</pre>
</blockquote>
<p>Does a ClearCase <i>rmtype</i> to remove a label type (<i>lbtype</i>) named <i>VERSION_1</i>.
Comment text from the file <i>acomment.txt</i> is added as a comment. All instances of the type
are removed, including the type object itself.</p>
<hr>
<h2><a name="cclock">CCLock</a></h2>
<h3>Description</h3>
Task to perform a "cleartool lock" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
<td>replace</td>
<td>Specifies replacing an existing lock</td>
<td>No</td>
<tr>
<tr>
<td>nusers</td>
<td>Specifies user(s) who can still modify the object</td>
<td>No</td>
<tr>
<tr>
<td>obsolete</td>
<td>Specifies that the object should be marked obsolete</td>
<td>No</td>
<tr>
<tr>
<td>comment</td>
<td>Specifies how to populate comments fields</td>
<td>No</td>
<tr>
<tr>
<td>pname</td>
<td>Specifies the object pathname to be locked.</td>
<td>Yes</td>
<tr>
<td>objselect</td>
<td>Specifies the object(s) to be locked.</td>
<td>Yes</td>
<tr>
</table>
<h3>Examples</h3>
<blockquote>
<pre>
<cclock
objselect="stream:Application_Integration@\MyProject_PVOB"
/>
</pre>
</blockquote>
<p>Does a ClearCase <i>lock</i> on the object <i>stream:Application_Integration@\MyProject_PVOB</i>.</p>
<hr>
<h2><a name="ccunlock">CCUnlock</a></h2>
<h3>Description</h3>
Task to perform a "cleartool unlock" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
<td>comment</td>
<td>Specifies how to populate comments fields</td>
<td>No</td>
<tr>
<tr>
<td>pname</td>
<td>Specifies the object pathname to be unlocked.</td>
<td>Yes</td>
<tr>
<td>objselect</td>
<td>Specifies the object(s) to be unlocked.</td>
<td>Yes</td>
<tr>
</table>
<h3>Examples</h3>
<blockquote>
<pre>
<ccunlock
objselect="stream:Application_Integration@\MyProject_PVOB"
/>
</pre>
</blockquote>
<p>Does a ClearCase <i>unlock</i> on the object <i>stream:Application_Integration@\MyProject_PVOB</i>.</p>
<hr>
<h2><a name="ccmkbl">CCMkbl</a></h2>
<h3>Description</h3>
Task to perform a "cleartool mkbl" command to ClearCase.
<h3>Parameters</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Values</th>
<th>Required</th>
</tr>
<tr>
<td>comment</td>
<td>Specify a comment. Only one of comment or cfile may be
used.</td>
<td>No</td>
</tr>
<tr>
<td>commentfile</td>
<td>Specify a file containing a comment. Only one of comment or
cfile may be used.</td>
<td>No</td>
</tr>
<tr>
<td>baselinerootname</td>
<td>Specify the name to be associated with the baseline.</td>
<td>Yes</td>
</tr>
<tr>
<td>nowarn</td>
<td>Suppress warning messages</td>
<td>No</td>
<tr>
<tr>
<td>identical</td>
<td>Allows the baseline to be created even if it is identical to the
previous baseline.</td>
<td>No</td>
</tr>
<tr>
<td>full</td>
<td>Creates a full baseline.</td>
<td>No</td>
</tr>
<tr>
<td>nlabel</td>
<td>Allows the baseline to be created without a label.</td>
<td>No</td>
</tr>
</table>
<h3>Examples</h3>
<blockquote>
<pre>
<ccmkbl
baselinerootname="Application_Baseline_AUTO"
identical="yes"
full="no"
viewpath="v:\ApplicationCC"
/>
</pre>
</blockquote>
<p>Does a ClearCase <i>mkbl</i> on the Integration view at <i>v:\ApplicationCC</i>
even if it is <i>identical</i> to a previous baseline. The new baseline with be
incremental and named "Application_Baseline_AUTO".</p>
<hr>
<p align="center">Copyright © 2000-2003 Apache Software Foundation. All rights
reserved.</p>
</body>
</html>
</html>