diff --git a/docs/manual/OptionalTasks/clearcase.html b/docs/manual/OptionalTasks/clearcase.html index 9bc26f042..164c52ffe 100644 --- a/docs/manual/OptionalTasks/clearcase.html +++ b/docs/manual/OptionalTasks/clearcase.html @@ -6,19 +6,45 @@
+by:
+Curtis White (cwhite at aracnet dot com),
+Sean P. Kane (spkane at genomatica dot com), and
+Rob Anderson (Anderson.Rob at vectorscm dot com)
Version 1.6 - 02/25/2003
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.
+ +More tasks can be easily added by deriving from the ClearCase class and then adding +functionality that is specific to that ClearCase command.
+ +viewpath | -Path to the ClearCase view file or directory that the command + | Path to the ClearCase view file or directory that the command will operate on | No | |||
commentfile | -Specify a file containing a comment. Only one of comment or commentfile + | Specify a file containing a comment. Only one of comment or commentfile may be used. | No | |||
identical | -Allows the file to be checked in even if it is identical + | Allows the file to be checked in even if it is identical to the original | No |
viewpath | -Path to the ClearCase view file or directory that the command + | Path to the ClearCase view file or directory that the command will operate on | No | |||
nodata | -Checks out the file but does not create an editable file + | Checks out the file but does not create an editable file containing its data | No | |||
commentfile | -Specify a file containing a comment. Only one of comment or + | Specify a file containing a comment. Only one of comment or commentfile may be used. | No | |||
viewpath | -Path to the ClearCase view file or directory that the command + | Path to the ClearCase view file or directory that the command will operate on | No | |||
keepcopy | -Specifies whether to keep a copy of the file with a .keep + | Specifies whether to keep a copy of the file with a .keep extension or not | No |
viewpath | -Path to the ClearCase view file or directory that the command + | Path to the ClearCase snapshot view file or directory that the command will operate on | No | |||
currenttime | -Specifies that modification time should be written as the - current time. Either currenttime or preservetime can be + | Specifies that modification time should be written as the + current time. Either currenttime or preservetime can be specified. | No | |||
preservetime | -Specifies that modification time should preserved from the - VOB time. Either currenttime or preservetime can be + | Specifies that modification time should preserved from the + VOB time. Either currenttime or preservetime can be specified. | No |
Attribute | +Values | +Required | +
---|---|---|
typename | +Name of the label type to create | +Yes | +
vob | +Name of the VOB | +No | +
replace | +Replace an existing label definition of the same type | +No | +
global | +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 | +No | +
ordinary | +Either global or ordinary can be specified, not both. Creates a label type that can be used only in the current VOB. Default | +No | +
pbranch | +Allows the label type to be used once per branch in a given element's version tree | +No | +
shared | +Sets the way mastership is checked by ClearCase. See ClearCase documentation for details | +No | +
comment | +Specify a comment. Only one of comment or cfile may be used. | +No | +
commentfile | +Specify a file containing a comment. Only one of comment or cfile may be used. | +No | +
+++<ccmklbtype typename="VERSION_1" + ordinary="true" + comment="Development version 1"/> ++
Does a ClearCase mklbtype to create a label type named VERSION_1. +It is created as ordinary so it is available only to the current VOB. +The text Development version 1 is added as a comment.
+ + +Attribute | +Values | +Required | +
---|---|---|
typename | +Name of the label type | +Yes | +
viewpath | +Path to the ClearCase view file or directory that the command will operate on | +No | +
replace | +Replace a label of the same type on the same branch | +No | +
recurse | +Process each subdirectory under viewpath | +No | +
version | +Identify a specific version to attach the label to | +No | +
vob | +Name of the VOB | +No | +
comment | +Specify a comment. Only one of comment or cfile may be used. | +No | +
commentfile | +Specify a file containing a comment. Only one of comment or cfile may be used. | +No | +
+++<ccmklabel viewpath="c:/views/viewdir/afile" + comment="Some comment text" + recurse="true" + version="\main\2" + typename="VERSION_1"/> ++
Does a ClearCase mklabel on the file c:/views/viewdir/afile under +the main branch for version 2 (\main\2). Text Some comment text is added +as a comment. It will recurse all subdirectories. + + +
Attribute | +Values | +Required | +||||
---|---|---|---|---|---|---|
typekind | +The kind of type to create. Valid types are:
+
|
+ Yes | +||||
typename | +The name of the type to remove | +Yes | +||||
ignore | +Used with trigger types only. Forces removal of trigger type even if a pre-operation trigger would prevent its removal | +No | +||||
rmall | +Removes all instances of a type and the type object itself | +No | +||||
comment | +Specify a comment. Only one of comment or cfile may be used. | +No | +||||
commentfile | +Specify a file containing a comment. Only one of comment or cfile may be used. | +No | +||||
+++<ccrmtype typekind="lbtype" + typename="VERSION_1" + commentfile="acomment.txt" + rmall="true"/> ++
Does a ClearCase rmtype to remove a label type (lbtype) named VERSION_1. +Comment text from the file acomment.txt is added as a comment. All instances of the type +are removed, including the type object itself.
+Attribute | +Values | +Required | +
---|---|---|
replace | +Specifies replacing an existing lock | +No | +
nusers | +Specifies user(s) who can still modify the object | +No | +
obsolete | +Specifies that the object should be marked obsolete | +No | +
comment | +Specifies how to populate comments fields | +No | +
pname | +Specifies the object pathname to be locked. | +Yes | +
objselect | +Specifies the object(s) to be locked. | +Yes | +
+++<cclock + objselect="stream:Application_Integration@\MyProject_PVOB" + /> ++
Does a ClearCase lock on the object stream:Application_Integration@\MyProject_PVOB.
+Attribute | +Values | +Required | +
---|---|---|
comment | +Specifies how to populate comments fields | +No | +
pname | +Specifies the object pathname to be unlocked. | +Yes | +
objselect | +Specifies the object(s) to be unlocked. | +Yes | +
+++<ccunlock + objselect="stream:Application_Integration@\MyProject_PVOB" + /> ++
Does a ClearCase unlock on the object stream:Application_Integration@\MyProject_PVOB.
+Attribute | +Values | +Required | +
---|---|---|
comment | +Specify a comment. Only one of comment or cfile may be +used. | +No | +
commentfile | +Specify a file containing a comment. Only one of comment or +cfile may be used. | +No | +
baselinerootname | +Specify the name to be associated with the baseline. | +Yes | +
nowarn | +Suppress warning messages | +No | +
identical | +Allows the baseline to be created even if it is identical to the +previous baseline. | +No | +
full | +Creates a full baseline. | +No | +
nlabel | +Allows the baseline to be created without a label. | +No | +
+++<ccmkbl + baselinerootname="Application_Baseline_AUTO" + identical="yes" + full="no" + viewpath="v:\ApplicationCC" + /> ++
Does a ClearCase mkbl on the Integration view at v:\ApplicationCC +even if it is identical to a previous baseline. The new baseline with be +incremental and named "Application_Baseline_AUTO".
+Copyright © 2000-2003 Apache Software Foundation. All rights +reserved.
+