rmtype

Removes a type object from a VOB

Applicability

Product

Command type

VersionVault

cleartool subcommand

VersionVault Remote Client

rcleartool subcommand

Platform

UNIX®

Linux®

Windows®

Synopsis

rmtype [ –ign/ore ] [ –rma/ll] [ –f/orce ]
[ –c/omment comment | –cfi/le comment-file-pname | –cq/uery | –cqe/ach | –nc/omment ]
type-selector ...

Description

The rmtype command removes one or more type objects from a VOB.

The file vista.tjf records updates to the VOB that result from rmtype operations. vista.tjf can grow very large. For information about limiting its size, read about the file db.conf in the config_ccase reference page.

Restrictions

Identities

You must have one of the following identities:

  • Type owner
  • VOB owner
  • root (UNIX® and Linux®)
  • Member of the VersionVault administrators group (VersionVault on Windows®)

Locks

An error occurs if one or more of these objects are locked: VOB, type.

Mastership

(Replicated VOBs only) Your current replica must master the type.

Other

You cannot remove a type object if there are any instances of that type. For example, if any version of any element is labeled REL1, you cannot remove the REL1 label type. You can bypass this restriction by specifying the –rmall option.

You cannot remove an element type from a replicated VOB.

Options and arguments

Removing instances of the type

Default
If there are any instances of a specified type object, rmtype does not remove the type object.
–rma/ll
Removes all instances of a type, and then proceeds to remove the type object itself. If the type object is a global type or is a local copy of a global type, rmtype removes the global type and all local copies of the type.
Important: This option potentially destroys a great deal of data.

rmtype fires triggers of type trigger type, but not triggers of element trigger type. For example, if you have a trigger attached to a branch, running rmtype –rmall –brtype won't fire the trigger. See the mktrtype reference page.

If the rmtype –rmall command fails for any reason, you must address the causes of the failure and enter the command again. You must persist until the command completes successfully and the type is removed. Failure to do so results in inconsistent metadata.

–f/orce (for use with –rmall only)
By default, rmtype prompts for confirmation when you use the –rmall option to request removal of all instances of a type. The –force option suppresses the confirmation step.
–ign/ore (for use with trigger types only)
Removes a trigger type even if a previously defined preoperation trigger would otherwise prevent it from being removed.

Event records and comments

Default
Creates one or more event records, with commenting controlled by your .versionvault_profile file (default: –nc). See the comments reference page. Comments can be edited with chevent.
–c/omment comment | –cfi/le comment-file-pname |–cq/uery | –cqe/ach | –nc/omment
Overrides the default with the option you specify. See the comments reference page.

Specifying the type objects to be removed

Default
Removes types from the VOB that contains the current working directory unless you specify another VOB with the @vob-selector suffix.
type-selector ...
One or more names of existing type objects, of the specified kind. Specify type-selector in the form type-kind:type-name[@vob-selector]

type-selector

type-kind

One of
attype Attribute type
brtype Branch type
eltype Element type
hltype Hyperlink type
lbtype Label type
trtype Trigger type

type-name

Name of the type object

vob-selector

VOB specifier

Specify vob-selector in the form [vob:]pname-in-vob

pname-in-vob

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)

Examples

The UNIX system and Linux 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 system and Linux shells or Windows command interpreter prompt, followed by the cleartool command. In cleartool interactive mode, cmd-context represents the interactive cleartool prompt.

  • Delete the branch type patch3.

    cmd-context  rmtype brtype:patch3
    Removed attribute type "patch3".

  • Delete the attribute type QA_date in the VOB \tests.

    cmd-context  rmtype attype:QA_date@\tests
    Removed attribute type "QA_date".

  • Delete all branches of type expmnt3 (along with all the versions on those branches and any subbranches); then delete the expmnt3 branch type itself.

    cmd-context  rmtype –rmall brtype:expmnt3
    There are 1 branches of type "expmnt3".
    Remove branches (including all sub-branches and sub-versions)? [no]     yes

    Removed branches of type "expmnt3".
    Removed branch type "expmnt3".

  • Delete the hyperlink type design_doc.

    cmd-context  rmtype hltype:design_doc
    Removed hyperlink type "design_doc".

  • Remove all instances of the label type REL2; then delete the label type.

    cmd-context  rmtype –rmall lbtype:REL2
    There are 7 labels of type "REL2".
    Remove labels? [no]     yes

    Removed labels of type "REL2".
    Removed label type "REL2".

  • Delete the trigger type trig1. Use the –ignore option to ensure that the command executes without interference from a previously defined trigger.

    cmd-context  rmtype –ignore trtype:trig1
    Removed trigger type "trig1".