Creates or updates a hyperlink type object
Product | Command Type |
---|---|
ClearCase | cleartool subcommand |
ClearCase LT | cleartool subcommand |
Attache | command |
Platform |
---|
UNIX |
Windows |
The mkhltype command creates one or more hyperlink types for future use within a VOB. After creating a hyperlink type, you can connect pairs of objects with hyperlinks of that type, using mkhlink.
Conceptually, a hyperlink is an "arrow" from one VOB-database object (version, branch, element, or VOB symbolic link) to another. To enable objects in two different VOBs to be connected, a hyperlink type with the same name must be created in both VOBs.
For example, you create a hyperlink type named design_spec, for use in linking source code files to the associated design documents. Later, you can use mkhlink to create a hyperlink of this type between my_prog.c and my_prog.dsn.
The following predefined hyperlink types are created in a new VOB:
Merge | Merge hyperlinks record a merge of two or more versions of an element (performed by the merge command) with one or more merge arrows. Each merge arrow is actually a hyperlink of type Merge, connecting one of the contributors to the target version. |
GlobalDefinition | GlobalDefinition hyperlinks record the relationship between a global definition and a local instance of a global type. |
AdminVOB | AdminVOB hyperlinks record a VOB's administrative VOB. |
RelocationVOB | RelocationVOB hyperlinks point from VOBs to which objects have been relocated to the VOBs in which the objects were originally located. These hyperlinks occur only between VOB objects. (See the relocate reference page.) |
Identities: No special identity is required unless you specify the -replace option. For -replace, you must have one of the following identities:
Type owner
VOB owner
root (UNIX)
Member of the ClearCase group (ClearCase on Windows)
Local administrator of the ClearCase LT server host (ClearCase LT on Windows)
Locks: An error occurs if one or more of these objects are locked: VOB, hyperlink type (with -replace only).
Mastership: (Replicated VOBs only) With -replace, your current replica must master the type.
HANDLING OF NAME COLLISIONS. Default: An error occurs if a hyperlink type named type-name already exists in the VOB.
|
|
|
SPECIFYING THE SCOPE OF THE HYPERLINK TYPE. Default: Creates an ordinary hyperlink type that can be used only in the current VOB.
SUGGESTED ATTRIBUTES. (Advisory only, not restrictive) Default: The new hyperlink type has no list of suggested attributes.
MASTERSHIP OF THE HYPERLINK TYPE. Default: Attempts to attach hyperlinks of this type succeed only in the VOB replica that is the current master of the hyperlink type. The VOB replica in which the new hyperlink type is created becomes its initial master.
EVENT RECORDS AND COMMENTS. Default: Creates one or more event records, with commenting controlled by your .clearcase_profile file (default: -cqe). See the comments reference page. Comments can be edited with chevent.
NAMING THE HYPERLINK TYPES. Default: The hyperlink type is created in the VOB that contains the current working directory unless you specify another VOB with the @vob-selector argument.
type-name | Name of the hyperlink type See the cleartool reference page for rules about composing names. | |
vob-selector | Object-selector for a VOB, in the form [vob:]pname-in-vob. The 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) |
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.
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.
Create a hyperlink type named tested_by.
cmd-context mkhltype -nc tested_by
Created hyperlink type "tested_by".
Create a hyperlink type named design_spec in the \docs VOB, and provide a comment on the command line.
cmd-context mkhltype -c "source to design document" design_spec@\docs
Created hyperlink type "design_spec".
Create a hyperlink type named test_script, providing a suggested-attribute list.
cmd-context mkhltype -nc -attype run_overnight,error_rate test_script
Created hyperlink type "test_script".
describe, lstype, mkhlink, rename, rmtype
Feedback on the documentation in this site? We welcome any comments!
Copyright © 2001 by Rational Software Corporation. All rights reserved. |