Product | Command Type |
---|---|
ClearCase | general information |
ClearCase LT | general information |
Attache | general information |
MultiSite | general information |
Platform |
---|
UNIX |
Windows |
Nearly every operation that modifies the VOB creates an event record in the VOB database. For example, if you create a new element, attach a version label, or lock the VOB, an event record marks the change.
Event records are attached to specific objects in VOB databases. Thus, each object (including the VOB object itself) accumulates a chronological event history, which you can display with the command lshistory.
In addition, you can do the following:
Customize event history reports with lshistory -fmt; see the fmt_ccase reference page.
Scrub minor event records from the VOB database to save space; see the vob_scrubber reference page.
Assign triggers to many event-causing operations (mkelem, checkout, and mklabel, for example); see the mktrtype reference page.
Change the comment stored with an event; see the chevent reference page.
An event record stores information for various operations:
obj-name | The object(s) affected |
obj-kind | The kind of object (file element, branch, or label type, for example) |
user-name | The user who changed the VOB database |
host-name | The client host from which the VOB database was changed |
operation | The operation that caused the event (usually a cleartool command like checkout or mklabel) |
date-time | When the operation occurred (reported relative to the local time zone) |
event-kind | A description of the event, derived from a combination of the |
comment | A text string that is generated by ClearCase or ClearCase LT, provided by user-name, or a combination of both |
The following kinds of VOB-database objects have event histories, which you can display with lshistory:
VOB
VOB storage pool
Element
Branch
Version
VOB symbolic link
Hyperlink
Derived Object (no creation event)
Replica
Type
Attribute type
Branch type
Element type
Hyperlink type
Label type
Trigger type
Each time an object from any of these categories is created, it begins its own event history with a creation event. (Derived objects are an exception; ClearCase stores a DO's creation time in its config record, not in an event record.) As time passes, some objects-VOBs and elements, in particular-can accumulate lengthy event histories.
Do not confuse type objects (created with mkattype, mkbrtype, mkeltype, mkhltype, mklbtype, and mktrtype) with the instances of those types (created with mkattr, mkbranch, mkelem, mkhlink, mklabel, and mktrigger). The type objects are VOB-database objects, with their own event histories. Individual branches, elements, and hyperlinks are also VOB-database objects. However, individual attributes, labels, and triggers are not VOB-database objects and, therefore, do not have their own event histories. Their create and delete events (mkattr/rmattr, mklabel/rmlabel, and mktrigger/rmtrigger) are recorded on the objects to which these metadata items are attached.
The following kinds of operations cause event records to be written to the VOB database:
Create or import a new object.
Destroy (remove) an object.
Check out a branch.
Modify or delete version data.
Modify a directory version's list of names.
Attach or remove an attribute, label, hyperlink, or trigger.
Lock or unlock an object.
Change the name or definition of a type or storage pool.
Change a branch or element's type.
Change an element's storage pool.
Change the protections for an element or derived object.
Table 7 lists event-causing operations as you may see them in lshistory output that has been formatted with the -fmt option's %o (operation) specifier. Note that most operations correspond exactly to cleartool subcommands.
Key to Table 7
Symbol | Meaning |
---|---|
M | Causes a minor event (see lshistory -minor) |
T | Can have a trigger (see mktrtype) |
S | Resulting event records can be scrubbed (see vob_scrubber) |
C | Generates a comment (see the comments reference page) |
Operation that Generates the Event Record | Notes (see key above) | Commands that Always Cause the Operation | Commands that May Cause the Operation | Object to Which Event Record Is Attached | |||
---|---|---|---|---|---|---|---|
checkin | T | Newly created version | |||||
checkout | T | Checked-out branch (event deleted automatically at checkin or uncheckout) | |||||
chmaster | T | C | Object whose mastership was changed | ||||
chpool | M | S | C | Element | |||
chtype | M | T | S | C | Element or branch | ||
exportsync | C | syncreplica -export | Replica | ||||
import | Imported element or type | ||||||
importsync | C | syncreplica -import | Replica | ||||
lnname | M | T | S | C | Directory version | ||
lock | T | S | C | (Various) | Locked object (type, pool, VOB, element, or branch) | ||
mkattr | M | T | S | C | Element, branch, version, hlink, or VOB symlink | ||
mkbranch | T | New branch | |||||
mkelem | T | C | New element | ||||
mkhlink | M | T | S | C | Hyperlink object and from-object, and for bidirectional hyperlinks, to-object (unless cross-VOB hyperlink) | ||
mklabel | M | T | S | C | Version | ||
mkpool | Storage pool object | ||||||
mkreplica | Replica | ||||||
mkslink | T | ln -s | Directory version | ||||
mktrigger | M | T | S | Element | |||
mktype | T | mk**type | Newly created type object | ||||
mkvob | VOB | ||||||
modpool | M | S | C | mkpool -update | Storage pool | ||
modtype | M | S | C | mk**type -replace | Type object | ||
protect | M | S | C | Element or DO | |||
reconstruct | M | S | checkvob -fix | Element | |||
reformatvob | VOB | ||||||
rename (pool) | M | C | Storage pool | ||||
rename (type) | M | T | C | Type object | |||
reserve | M | T | Checked-out version | ||||
rmattr | M | T | S | (See mkattr) | |||
rmbranch | T | S | C | Parent branch | |||
rmelem | T | S | C | VOB | |||
rmhlink | M | T | S | C | From-object, to-object (unless cross-VOB, unidirectional), VOB | ||
rmlabel | M | T | S | Version | |||
rmname | M | T | S | C | Directory version(s) | ||
rmpool | S | C | VOB | ||||
rmtrigger | M | T | S | Element | |||
rmtype | T | S | C | VOB | |||
rmver | M | T | S | C | checkvob -fix | Element | |
unlock | T | S | (various) | Unlocked object | |||
unreserve | M | T | Checked-out version |
Each of the following superoperations represents a group of the above event-causing operations. See mktrtype for information on how to use the following keywords to write triggers for groups of operations.
MODIFY_TYPE MODIFY_DATA
MODIFY_ELEM MODIFY_MD
Table 7 omits the triggerable operations uncheckout and chevent; as these operations do not cause event records to be stored in the VOB database.
This section describes where, directly or indirectly, you may encounter event record contents. The following commands include event history information in their output, which can be formatted with the -fmt option:
lstype -long |
The set of ClearCase and ClearCase LT commands named in Table 7 matches almost exactly the set of commands that accept user comments as input. (reformatvob, which takes no comment, is the only exception.) When you supply comments to a ClearCase or ClearCase LT command, your comment becomes part of an event record.
Some cleartool commands create a comment even if you do not provide one. These generated comments describe the operation in general terms, such as "modify metadata" or "create directory element." User comments, if any, are appended to generated comments. For a complete description of comment-related command options and comment processing, see the comments reference page.
chevent, cleartool, comments, fmt_ccase, lshistory, mktrtype, vob_scrubber
Feedback on the documentation in this site? We welcome any comments!
Copyright © 2001 by Rational Software Corporation. All rights reserved. |