Product | Command type |
---|---|
ClearCase | cleartool subcommand |
ClearCase LT | cleartool subcommand |
MultiSite | multitool subcommand |
The describe command lists information about VOBs and the objects they contain. For example:
describe produces several kinds of listings:
The description of an element (for example, describe hello.h@@) includes a listing of the storage pools to which the element is currently assigned. (See mkpool and chpool for more information.)
A version's description includes the version ID of its predecessor version.
An ordinary derived object is listed with derived object in its header. A derived object that has been checked in as a version of an element (DO version) is listed with derived object version in its header.
For attribute types, hyperlink types, and label types, describe shows the instance mastership of the type (whether the type's mastership can be shared by multiple replicas), even if the VOB is not replicated.
For an MVFS object, describe lists the object's protections. For information about access control, see the Administrator's Guide and the reference pages for protect and protectvob.
File system objects can be hyperlinked to objects in another VOB. If the other VOB is currently unavailable (perhaps it has been unmounted), describe tries to be helpful:
The description of a version can include the annotation [version has no data]. A file element version can be created without data, using checkin –cr; an existing version's data can be removed with rmver –data.
By default, a version inherits a hyperlink attached to any of its ancestor versions, on the same branch or on a parent branch. Inherited hyperlinks are listed only if you use the –ihlink option.
A hyperlink stops being passed down to its descendants if it is superseded by another hyperlink of the same type, explicitly attached to some descendant version. You can use a null-ended hyperlink (from-object, but no to-object ) as the superseding hyperlink to effectively cancel hyperlink inheritance.
Note: Derived objects may be present only in ClearCase dynamic views.
describe maintains a cache of tags of inaccessible views. For each view tag, describe records the time of the first unsuccessful contact. Before trying to access a view, describe checks the cache. If the view's tag is not listed in the cache, describe tries to contact the view. If the view's tag is listed in the cache, describe compares the time elapsed since the last attempt with the time-out period specified by the CCASE_DNVW_RETRY environment variable. If the elapsed time is greater than the time-out period, describe removes the view tag from the cache and tries to contact the view again.
The default timeout period is 60 minutes. To specify a different time-out period, set CCASE_DNVW_RETRY to another integer value (representing minutes). To disable the cache, set CCASE_DNVW_RETRY to 0.
The describe command shows additional information for objects in MultiSite replicated VOBs:
Note: If the object is a local instance of a global type and you do not specify –local, describe shows the master replica of the global type.
For more information about replicated VOBs, see the Administrator's Guide.
If you combine –fmt with any of these options, describe uses the format-string to construct and display the object's extended pathname.
For the type-selector arguments, use one of the type selectors shown in the object-selector description.
If you specify –short as well, the listing is restricted even further.
For versions, –version overrides these interpretations of pname.
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.
Note: In the UNIX examples that follow, arguments and output that show multicomponent VOB tags are not applicable to ClearCase LT, which recognizes only single-component VOB tags. In this manual, a multicomponent VOB tag is by convention a two-component VOB tag of the form /vobs/vob-tag-leaf—for example, /vobs/src. A single-component VOB tag consists of a leaf only—for example, /src. In all other respects, the examples are valid for ClearCase LT.
cmd-context describe util.c@@\main\rel2_bugfix
branch "util.c@@\main\rel2_bugfix"
created 08-Dec-98.12:15:40 by Bev Jackson (test user) (bev.dvt@oxygen)
branch type: rel2_bugfix
Element Protection:
User : sgd : r--
Group: user : r--
Other: : r--
element type: text_file
branched from version: \main\31
cmd-context describe -long vob:.
versioned object base "\hw"
created 15-Dec-98.09:34:00 by jenny.adm@oxygen
"VOB dedicated to development of "hello, world" program"
VOB family feature level: 2
VOB storage host:pathname "oxygen:c:\users\vb_store\tut\tut.vbs"
VOB storage global pathname "\\oxygen\users\vb_store\tut\tut.vbs"
VOB ownership:
owner jackson
group dvt
VOB holds objects from the following views:
oxygen:\vb_store\tut\old.vws [uuid 249356fe.d50f11cb.a3fd.00:01:56:01:0a:4f]
cmd-context describe –local lbtype:REL6
label type "REL6"
created 28-Jul-99.14:00:26 by Suzanne Gets (smg.user@neon)
"Automatically created label type from global definition in
VOB "/vobs/admin"."
instance mastership: unshared
owner: smg
group: user
scope: this VOB (local copy of global type)
constraint: one version per element
Hyperlinks:
GlobalDefinition -> lbtype:REL6@/vobs/admin
cmd-context describe –long vob:.
versioned object base "\doc"
created 07-Nov-91.16:46:28 by ratl.user
"ClearCase documentation VOB."
VOB family feature level: 1
VOB storage host:pathname "mercury:\usr3\vobstorage\doc_vob"
VOB storage global pathname "\\mercury\usr3\vobstorage\doc_vob"
VOB ownership:
owner 4294967294
group user
Hyperlinks:
AdminVOB -> vob:\admin
This VOB has a hyperlink named AdminVOB; it points from the current VOB to the VOB vob:\admin. If it were pointing to the current VOB, the listing would show
Now describe the hyperlink AdminVOB.
Copyright© 2003 Rational Software. All Rights Reserved.