Product | Command Type |
---|---|
ClearCase | cleartool subcommand |
ClearCase LT | cleartool subcommand |
Attache | command |
Platform |
---|
UNIX |
Windows |
The lock command creates a lock on an entire VOB, or on one or more file-system objects, type objects, or VOB storage pools. A lock on an object disables operations that modify the object; a lock has no effect on read operations, such as lshistory. (Exception: see the Storage Pool Lock: Cleartext Pool section.)
The VOB does not need to be mounted for you to lock type objects, storage pools, or the VOB itself. However, you need a view context (and therefore a mounted VOB if you're using a dynamic view) to lock elements or versions.
The following sections describe the several kinds of locks.
Locking an entire VOB disables all write operations to that VOB and forces a database checkpoint by causing a state flush. A typical application is locking a VOB to prevent it from being modified during backup.
You must lock a VOB before backing it up, and you cannot use the -nusers option. With -nusers, it is possible that the VOB will be modified during the backup, and the nuser lock does not perform a database checkpoint.
NOTE: Locking a VOB does not lock its cleartext storage pools, because this would prevent read access to text_file, compressed_text_file, and binary_delta_file elements. (For example, it would prevent a locked VOB from being backed up.) To completely lock a VOB, you must also lock its cleartext pools, using one or more lock pool: commands. You may want to do this to move a cleartext pool.
In general, locking a type object disables these kinds of operations:
Operations that create, delete, or modify instances of the type
Operations that delete or modify the type object itself (for example, renaming it)
The following sections describe how these general rules apply to the different kinds of type objects.
Element Type. If an element type is locked, you cannot:
Change an existing element to that type with chtype
Modify the element's version tree with checkout, checkin, or mkbranch
Branch Type. If a branch type is locked, you cannot:
Create a branch of that type with mkbranch
Rename (that is, change the type of) an existing branch to or from that type with chtype
Cancel a checkout using uncheckout
Attach a label using mklabel
You can create a subbranch at any version on a locked branch, using mkbranch. (Creating a subbranch does not modify the branch itself.)
Label Type. If a label type is locked, you cannot:
Attach or remove a version label of that type with mklabel or rmlabel (This includes moving a label from one version to another with mklabel -replace.)
Attribute Type. If an attribute type is locked, you cannot:
Attach or remove an attribute of that type with mkattr or rmattr (This includes moving an attribute from one version to another with mkattr -replace.)
Hyperlink Type. If a hyperlink type is locked, you cannot:
Trigger Type. If a trigger type is locked, you cannot:
(If created with mktrtype -element) Create or remove a trigger of that type with mktrigger or rmtrigger
In general, locking a trigger type does not inhibit triggers of that type from firing. Exception: trigger firing is inhibited if a trigger type created with mktrtype -element -all, mktrtype -ucm -all, or if mktrtype -type is made obsolete (using lock -obsolete).
Locking a VOB storage pool inhibits commands that create or remove the pool's data containers. It also prevents the pool's scrubbing parameters from being modified with mkpool -update. The following sections describe how this principle applies to the different kinds of storage pools.
Source Pool. If a source storage pool is locked, you cannot:
Create an element that would be assigned to that pool, with mkelem or mkdir. (A new element inherits its pool assignments from its parent directory element.)
Change an existing element's pool assignment to/from that pool, with chpool.
Change an element's element type with chtype, if the change would require recreation of source data containers (for example, changing from type file to type text_file).
Check in a new version of an element assigned to that pool.
Create or remove a branch of an element assigned to that pool, with mkbranch or rmbranch.
Remove a version of an element assigned to that pool, or remove the element itself, with rmver or rmelem.
Derived Object Pool. If a derived object storage pool is locked:
clearmake cannot winkin a previously unshared derived object in a directory assigned to that pool. (The invocation of promote_server to copy the data container from view-private storage to the derived object storage pool fails.)
scrubber cannot remove data containers from the pool.
An rmdo command fails for a derived object whose data container is in that pool.
Cleartext Pool. If a cleartext storage pool is locked:
An attempt to read a version of an element assigned to that pool may fail. (It fails if a new cleartext data container for that version would have been created and cached in the cleartext pool.)
Locking or unlocking a global type or one of its local copies locks or unlocks the global type and all local copies. For more information, see the Administrator's Guide.
An object becomes obsolete if it is processed with a lock -obsolete command. An obsolete type object or obsolete storage pool is not only locked, but is also invisible to certain forms of the lstype, lslock, lspool, and lsvtree commands. An obsolete VOB or obsolete VOB object is no different from one with an ordinary lock. You can change an object's status from obsolete to locked by using a lock -replace command:
cmd-context lock -obsolete brtype:test_branch (make a branch type obsolete)
Locked branch type "test_branch".
cmd-context lock -replace brtype:test_branch (change the branch type to 'just locked')
Similarly, you can use a lock -replace command to make a locked object obsolete.
The unlock command removes a lock from an object, reenabling the previously prohibited operations.
Kind of Object to be Locked | Identity Required for ClearCase, ClearCase LT, and Attache on UNIX | Identity Required for ClearCase and Attache on Windows | Identity Required for ClearCase LT on Windows |
Type object | Type owner, VOB owner, root | Type owner, VOB owner, member of the ClearCase group (ClearCase) | Type owner, VOB owner, local administrator of the ClearCase LT server host |
Storage pool | VOB owner, root | VOB owner, member of the ClearCase group | VOB owner, local administrator of the ClearCase LT server host |
VOB | VOB owner, root | VOB owner, member of the ClearCase group | VOB owner, local administrator of the ClearCase LT server host |
Element | Element owner, VOB owner, root | Element owner, VOB owner, member of the ClearCase group | Element owner, VOB owner, local administrator of the ClearCase LT server host |
Branch | Branch creator, element owner, VOB owner, root | Branch creator, element owner, VOB owner, member of the ClearCase group | Branch creator, element owner, VOB owner, local administrator of the ClearCase LT server host |
Locks: An error occurs if one or more of these objects are locked: the VOB containing the object.
Mastership: (Replicated VOBs only) With -obsolete, your current replica must master the object.
REPLACING AN EXISTING LOCK. Default: None.
SPECIFYING THE DEGREE OF LOCKING. Default: Locks an object to all users, but does not make the object obsolete.
EVENT RECORDS AND COMMENTS. Default: Creates one or more event records, with commenting controlled by your .clearcase_profile file (default: -nc). See the comments reference page. Comments can be edited with chevent.
SPECIFYING THE OBJECTS TO BE LOCKED. Default: The final arguments are assumed to be the names of elements and/or branches. To lock another kind of object, you must use an object-selector prefix.
When locking type objects and storage pools, the command processes objects in the VOB containing the current working directory. To lock an entire VOB, you must specify a VOB.
vob-selector | vob:pname-in-vob | |
pname-in-vob can be the pathname of the VOB-tag (whether or not the VOB is mounted) or of any file-system object within the VOB (if the VOB is mounted). It cannot be the pathname of the VOB storage directory. | ||
attribute-type-selector | attype:type-name[@vob-selector] | |
branch-type-selector | brtype:type-name[@vob-selector] | |
element-type-selector | eltype:type-name[@vob-selector] | |
hyperlink-type-selector | hltype:type-name[@vob-selector] | |
label-type-selector | lbtype:type-name[@vob-selector] | |
trigger-type-selector | trtype:type-name[@vob-selector] | |
pool-selector | pool:pool-name[@vob-selector] | |
oid-obj-selector | oid:object-oid[@vob-selector] | |
The following object-selectors apply to the UCM usage model (see NOTE): | ||
activity-selector | activity:actvity-name[@vob-selector] | |
baseline-selector | baseline:baseline-name[@vob-selector] | |
component-selector | component:component-name[@vob-selector] | |
folder-selector | folder:folder-name[@vob-selector] | |
project-selector | project:project-name[@vob-selector] | |
stream-selector | stream:stream-name[@vob-selector] |
NOTE: In UCM object selectors, @vob-selector refers to a UCM project VOB.
The UNIX examples in this section are written for use in csh. If you use another shell, you may need to use different quoting and escaping conventions.
The Windows examples that include wildcards or quoting are written for use in cleartool interactive mode. If you use cleartool single-command mode, you may need to change the wildcards and quoting to make your command interpreter process the command appropriately.
In cleartool single-command mode, cmd-context represents the UNIX shell or Windows command interpreter prompt, followed by the cleartool command. In cleartool interactive mode, cmd-context represents the interactive cleartool prompt. In Attache, cmd-context represents the workspace prompt.
Lock three label types for all users.
cmd-context lock lbtype:REL1 lbtype:REL1.1 lbtype:REL2
Locked label type "REL1".
Locked label type "REL1.1".
Locked label type "REL2".
Obsolete a branch type.
cmd-context lock -obsolete brtype:rel2_bugfix
Locked branch type "rel2_bugfix".
Lock the VOB containing the current working directory.
cmd-context lock vob:.
Locked versioned object base "/usr/hw".
Lock the test branch type for all users except gomez and jackson.
cmd-context lock -nusers gomez,jackson brtype:test
Locked branch type "test".
Lock elements with a .c extension for all users. Then try to check out one of the locked elements.
cmd-context lock *.c
Locked file element "hello.c".
Locked file element "msg.c".
Locked file element "util.c".
cmd-context checkout -nc msg.c
cleartool: Error: Lock on file element prevents operation "checkout".
cleartool: Error: Unable to check out "msg.c".
Feedback on the documentation in this site? We welcome any comments!
Copyright © 2001 by Rational Software Corporation. All rights reserved. |