ClearCase Reference Manual, Release 4.0, UNIX

describe

Describes an object

APPLICABILITY

ClearCase (cleartool subcommand), MultiSite (multitool subcommand), Attache (command)

SYNOPSIS

Describe objects in graphical format:

des·cribe -g·raphical { object-selector | pname } ...
Describe objects in nongraphical format:

des·cribe [ -local ] [ -l·ong | -s·hort | -fmt format-string ]

[ -ala·bel { label-type-selector [,...] | -all } ]
[ -aat·tr { attr-type-selector [,...] | -all } ]
[ -ahl·ink { hlink-type-selector [,...] | -all } ]
{ [ -cvi·ew ] [ -ver·sion version-selector | -anc·estor ]
[ -ihl·ink { hlink-type-selector [,...] | -all } ]
[ -pre·decessor ] [ -pna·me ] pname ...
| -typ·e type-selector ...
| -cact
| object-selector ...
}

DESCRIPTION

The describe command lists information about VOBs and the objects they contain. For example:

Attributes and/or version labels attached to a particular version
Hyperlinks attached to a particular object
Predecessor version of a particular version
Views that have checkouts or unshared derived objects in a particular VOB (describe -long vob:)
Family feature level of a VOB or the replica feature level of a MultiSite VOB replica.

describe produces several kinds of listings:

File-system data - Provides information on elements, branches, versions, derived objects, and VOB symbolic links.
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.
Type object - Provides information on a VOB's type objects (for example, on a specified list of label types). This form of the command displays the same information as lstype -long.
Hyperlink object - Provides information on a hyperlink object.
Storage pool - Provides information on a VOB's source, derived object, and cleartext storage pools. This form of the command displays the same information as lspool -long.
VOB object - Provides information on the object that represents the VOB itself. This includes such information as its storage area, creation date, owner, and related views.
VOB replica - Provides information on the object that represents a VOB replica, including the replica's mastering replica, host, mastership request setting, and feature level. For more information on replicas, see ClearCase MultiSite Manual.
UCM objects - Provides information on UCM objects: activities, baselines, components, folders, projects, and streams. This form of the command displays information similar to that displayed by the UCM commands lsactivity -long, lsbl -long, lscomp -long, lsfolder -long, lsproject -long, and lsstream -long.

Access Control Information

For an MVFS object, describe expands the output to include the object's access mode. (An access mode defines read, write, and execute privileges for the three user categories: owner, group, and others.) For more information on access control, see Administering ClearCase.

Unavailable Remote VOB

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:

cleartool: Error: Unable to locate versioned object base with object id: "51023fa9.68b711cc.b358.08:00:69:02:1d:c7". . . .

Hyperlinks: @183@/usr/proj /usr/proj/elem2.c@@/main/2 -> <object not available>

Versions Without Data

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.

Hyperlink Inheritance

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 descendents if it is superseded by another hyperlink of the same type, explicitly attached to some descendent version. You can use a null-ended hyperlink (from-object, but no to-object ) as the superseding hyperlink to effectively cancel hyperlink inheritance.

DOs in Unavailable 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.

For more information, see CACHING UNAVAILABLE VIEWS in the clearmake reference page.

ClearCase Objects in Replicated VOBs

The describe command shows additional information for objects in replicated VOBs:

For objects that have mastership, describe shows the mastering replica of the object.
NOTE: If the object is a local instance of a global type and you do not specify -local, describe shows the mastering replica of the global type.
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).
For branches and branch types, describe shows the mastership request setting of the object. This setting controls whether users at other sites can request mastership of instances of the type.

For more information about replicated VOBs, see ClearCase MultiSite Manual.

PERMISSIONS AND LOCKS

Permissions Checking: No special permissions required. Locks: No locks apply.

OPTIONS AND ARGUMENTS

DESCRIBING OBJECTS GRAPHICALLY. Default: Describes objects in nongraphical form.

-g·raphical: Starts a properties browser (cleardescribe) to describe objects.

DESCRIBING LOCAL COPIES OF GLOBAL TYPES. Default: describe displays information about the global type object for the specified object-selector.

-local: Displays information for the local copy of the specified object-selector. For more information about global types, see Administering ClearCase.

REPORT FORMAT. Default: Lists the object's name and some additional information.

-l·ong: Expands the listing. With vob:, for example, lists all views that have checkouts or unshared derived objects associated with the specified VOB. This listing includes the UUIDs of those views, which can be used with rmview.

-s·hort: Lists only an object's pathname. The effect is slightly different when used in combination with -alabel, -aattr, -ahlink, -ihlink, or -predecessor.

-fmt format-string: Lists information using the specified format string. See the fmt_ccase reference page for details on using this report-writing facility.

DESCRIBING OBJECTS IN OTHER VIEWS. Default: If you use a view-extended pathname to specify an object in (or as seen through) another view, describe lists that view's name for the object:

version: "/view/gamma/usr/project/src/util.c"

-cvi·ew: Lists an object using the current view's name for it.

: version: "/usr/project/src/all_utils.c"

: This option is useful when different views select different directory versions, in which elements have been renamed.

-cact: Describes the current activity for your view.

EXCERPTING DESCRIPTION INFORMATION. Default: describe lists the predecessor (if the object is a version), and reports on all of the object's version labels, attributes, and hyperlinks. With one or more of the following options, the report includes the extended pathname of the object and the requested information only-for example, only a listing of the predecessor version and version label.

-ala·bel { label-type-selector[,...] | -all }

-aat·tr { attr-type-selector[,...] | -all }

-ahl·ink { hlink-type-selector[,...] | -all }

-ihl·ink { hlink-type-selector[,...] | -all }

-pre·decessor: Specify one or more of these options to excerpt information from the overall description of an object. A list of names of type objects must be comma-separated, with no white space; you can use the special keyword -all to specify all types of a particular kind.

: 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.

-predecessor	Only the version-ID of the predecessor version is listed.
-alabel	Only the version labels are listed.
-aattr	Only the attribute values are listed.
-ahlink	The listing includes the pathnames of the objects hyperlinked to `pname`, annotated with "`->`" (listed object is the to- object) or "`<-`" (listed object is the from-object). For example:
	`-> /usr/proj/include/db.h@@/main/52 <- /usr/proj/bin/vega@@/main/5`
	Inherited hyperlinks are not included in this listing.
-ihlink	The listing includes the hyperlinks inherited by `pname`, which must specify a version. Pathnames of the from-object and to- object are listed, one of which is an ancestor of `pname`, or is `pname` itself. (That is, -ihlink also includes hyperlinks that are attached to `pname` itself.)

SPECIFYING THE OBJECTS TO BE DESCRIBED. Default: describe expects at least one argument that names an element, branch, version, VOB link, derived object, or hyperlink (pname, DO-name, or hlink-selector). You can use -version or -ancestor to control the way pname arguments are interpreted.

[ -pna·me ] pname ...: One or more pathnames, indicating objects to be described: elements, branches, versions, or derived objects. If pname has the form of an object selector, you must include the -pname option to indicate that pname is a pathname.

A standard or view-extended pathname to an element specifies the version selected by the view.
A standard or view-extended pathname to a derived object specifies the DO in the view.
An extended pathname specifies an element, branch, version, or derived object, different from the one selected by the view. For example:

`foo.c`	`(version of foo.c selected by current view)`
`foo.o`	`(derived object foo.o built in or winked in to current view)`
`/view/gamma/usr/proj/src/foo.c`	`(version of foo.c selected by another view; however, the current view must select some version of foo.c)`
`/view/gamma/usr/proj/src/foo.o`	`(derived object foo.o built in another view)`
`foo.c@@/main/5`	`(version 5 on main branch of foo.c)`
`foo.o@@11-Nov.09:19.219`	`(derived object, specified by DO-ID)`
`foo.c@@/REL3`	`(version of foo.c with version label REL3; however, the view must select some version of foo.c)`
`foo.c@@`	`(the element foo.c)`
`foo.c@@/main`	`(the main branch of element foo.c)`

: For versions, -version overrides these interpretations of pname.

-ver·sion version-selector: (For use with versions only) For each pname, describes the version specified by version-selector. This option overrides both version selection by the view and version-extended naming. See the version_selector reference page for syntax details.

-anc·estor: (For use with elements and versions only) Describes the closest common ancestor version of all the pname arguments, which must all be versions of the same element. See the merge reference page for a information about closest common ancestors.

-typ·e type-selector ...: Lists information about the type objects specified by the type-name arguments. If there are multiple types with the same name (for example, a label type and a hyperlink type are both named REL3), all of them are listed. Use one of the type-selectors shown in the description of the object-selector argument.

object-selector ...: One or more object-selectors, indicating objects to be described. Specify object-selector in one of the following forms:

`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`]
`hlink-selector`	hlink:`hlink-id`[@`vob-selector`]
`oid-obj-selector`	oid:`object-oid`[@`vob-selector`]

The following object selector is valid only if you use MultiSite:
`replica-selector`	replica:`replica-name`[@`vob-selector`]

The following object selectors are valid only if you use UCM:
`activity-selector`	activity:`activity`-`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`]

EXAMPLES

These examples are written for use in csh. If you use another shell, you may need to use different quoting and escaping conventions.

In cleartool single-command mode, cmd-context represents the shell prompt. In cleartool interactive mode, cmd-context represents the interactive cleartool prompt. In Attache, cmd-context represents the workspace prompt.

Describe the version of element msg.c selected by your view.

cmd-context describe msg.c version "msg.c@@/main/3" created 08-Dec-98.12:12:55 by Chuck Jackson (test user) (cj.dvt@oxygen) Element Protection: User : sgd : r-- Group: user : r-- Other: : r-- element type: c_source predecessor version: /main/2 Labels: REL6 REL1

Describe a branch of an element, specifying it with an extended pathname.

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

Describe the label type REL3.

cmd-context describe lbtype:REL3 label type "REL3" created 08-Dec-98.12:13:36 by Bev Jackson (test user) (bev.dvt@oxygen) owner: bev group: dvt scope: this VOB (ordinary type) constraint: one version per branch

Create a Tested attribute type and apply the attribute to the version of element util.c selected by your current view. Then, use describe to display the newly applied attribute value, and use the -fmt option to format the output.

cmd-context mkattype -nc -default '"TRUE"' Tested

cmd-context mkattr -default Tested util.c

cmd-context describe -aattr -all -fmt "Name: %Xn\nType of object: %m\n" util.c Name: util.c@@/main/CHECKEDOUT Type of object: version Attributes: Tested = "TRUE"

Describe ddft, the current VOB's default derived object storage pool.

cmd-context describe pool:ddft pool "ddft" created 15-Dec-98.09:34:00 by jenny.adm@oxygen "Predefined pool used to store derived objects." owner: jenny group: dvt kind: derived pool pool storage global pathname "/net/oxygen/usr/vobstore/tut/tut.vbs/d/ddft" maximum size: 0 reclaim size: 0 age: 96

Describe how the current view names an element that is named hello.mod in the jackson_fix view.

cmd-context describe -cview /view/jackson_fix/usr/hw/src/hello.mod version "/usr/hw/src/hello.c@@/main/4" created 08-Dec-98.12:16:29 by Chuck Jackson (test user) (cj.dvt@oxygen) Element Protection: User : sgd : r-- Group: user : r-- Other: : r-- element type: text_file predecessor version: /main/3

Describe the VOB containing the current working directory. List views with checkouts or unshared derived objects in that VOB.

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:/usr/vobstore/tut/tut.vbs" VOB storage global pathname "/usr/vobstore/tut/tut.vbs" VOB ownership: owner jackson group dvt VOB holds objects from the following views: oxygen:/usr/vobstore/tut/old.vws [uuid 249356fe.d50f11cb.a3fd.00:01:56:01:0a:4f]

Describe a hyperlink.

cmd-context describe hlink:Merge@516262@/vobs/proj hyperlink "Merge@516262@/vobs/proj" created 14-Jul-98.16:43:35 by Bill Bo (bill.user@uranus) Merge@516262@/vobs/proj /vobs/proj/lib/cvt/cvt_cmd.c@@/main/v1.1_port/8 -> /vobs/proj/lib/cvt/cvt_cmd.c@@/main/71

Describe a derived object in the current view.

cmd-context describe -cview util.o derived object "util.o@@11-Apr.12:03.33" created 11-Apr-98.12:03:33 by Anne Duvo (anne.dev@oxygen) references: 2 (shared) derived pool: ddft => saturn:/usr/anne/views/anne_main.vws => oxygen:/usr/jackson/views/jackson_proj2.vws

For a particular element, list its name, element type, attached triggers, and cleartext and source pools.

cmd-context describe -fmt \ "%n\n\t%[type]p\n\t%[triggers]p\n\t%[pool]Cp,%[pool]p\n" file.txt@@ file.txt@@ text_file (CI_TRIG, CO_TRIG) cdft,sdft

For a branch type in a replicated VOB, list the mastering replica of the branch type.

cmd-context describe -fmt "%n\t%[master]p\n" brtype:main main lex@/vobs/dev

For the current VOB, list the OID, replication status, MS-DOS text mode setting, and creation comment.

cmd-context describe -fmt "%On\n%[vob_replication]p\n%[msdostext_mode]p\n%c" \ vob:. 46cf5bfd.240d11d3.a37e.00:01:80:7b:09:69 unreplicated disabled storage of header files

Describe the local copy of global label type REL6.

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"." owner: smg group: user scope: this VOB (local copy of global type) constraint: one version per element Hyperlinks: GlobalDefinition -> lbtype:REL6@/vobs/admin

Describe the current VOB, its hyperlinks being of particular interest.

cmd-context describe -long vob:.

versioned object base "/vobs/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 "/net/mercury/usr3/vobstorage/doc_vob" VOB storage host:pathname mercury:\usr3\vobstorage\doc_vob VOB storage global pathname \\mercury\usr3\vobstorage\doc_vob VOB ownership: owner ratl group user Hyperlinks: AdminVOB -> vob:/vobs/admin

This VOB has a hyperlink named AdminVOB; it points from the current VOB to the VOB vob:/vobs/admin. If it were pointing to the current VOB, the listing would show

Hyperlinks: AdminVOB <- vob:/vobs/admin

Now describe the hyperlink AdminVOB.

cmd-context describe hltype:AdminVOB

hyperlink type "AdminVOB" created 07-Nov-91.16:46:28 by ratl.user "Predefined hyperlink type used to link a VOB to another VOB with administrative information." owner: ratl group: user scope: this VOB (ordinary type)