Rational ClearCase Commands Reference: rmbranch

Commands Index:

  * intro
  annotate
  apropos
  catcr
  catcs
  cc.icon
  cc.magic
  cd
  chactivity
  chbl
  checkin
  checkout
  checkvob
  chevent
  chflevel
  chfolder
  chmaster
  chpool
  chproject
  chstream
  chtype
  chview
  clearaudit
  clearbug
  cleardescribe
  cleardiffbl
  cleardiff
  clearexport_ccase
  clearexport_cvs
  clearexport_pvcs
  clearexport_rcs
  clearexport_sccs
  clearexport_ssafe
  clearfsimport
  cleargetlog
  clearhistory
  clearimport
  clearjoinproj
  clearlicense
  clearmake
  clearmake.options
  clearmrgman
  clearprojexp
  clearprompt
  cleartool
  clearviewupdate
  clearvobadmin
  comments
  config_ccase
  config_spec
  cptype
  credmap
  creds
  deliver
  describe
  diffbl
  diffcr
  diff
  dospace
  edcs
  endview
  env_ccase
  events_ccase
  export_mvfs
  exports_ccase
  file
  find
  findmerge
  fmt_ccase
  getcache
  get
  getlog
  help
  hostinfo
  init_ccase
  ln
  lock
  lsactivity
  lsbl
  lscheckout
  lsclients
  lscomp
  lsdo
  lsfolder
  lshistory
  ls
  lslock
  lsmaster
  lspool
  lsprivate
  lsproject
  lsregion
  lsreplica
  lssite
  lsstgloc
  lsstream
  lstype
  lsview
  lsvob
  lsvtree
  makefile_aix
  makefile_ccase
  makefile_gnu
  makefile_pmake
  makefile_smake
  makefile_sun
  man
  merge
  mkactivity
  mkattr
  mkattype
  mkbl
  mkbranch
  mkbrtype
  mkcomp
  mkdir
  mkelem
  mkeltype
  mkfolder
  mkhlink
  mkhltype
  mklabel
  mklbtype
  mkpool
  mkproject
  mkregion
  mkstgloc
  mkstream
  mktag
  mktrigger
  mktrtype
  mkview
  mkvob
  mount_ccase
  mount
  msdostext_mode
  mvfslog
  mvfsstorage
  mvfstime
  mvfsversion
  mv
  omake
  pathnames_ccase
  permissions
  profile_ccase
  promote_server
  protect
  protectvob
  pwd
  pwv
  query_language
  quit
  rebase
  recoverview
  reformatview
  reformatvob
  register
  relocate
  rename
  reqmaster
  reserve
  rgy_backup
  rgy_check
  rgy_passwd
  rgy_switchover
  rmactivity
  rmattr
  rmbl
  rmbranch
  rmcomp
  rmdo
  rmelem
  rmfolder
  rmhlink
  rmlabel
  rmmerge
  rmname
  rmpool
  rmproject
  rmregion
  rmstgloc
  rmstream
  rmtag
  rmtrigger
  rmtype
  rmver
  rmview
  rmvob
  schedule
  schemes
  scrubber
  setactivity
  setcache
  setcs
  setplevel
  setsite
  setview
  shell
  snapshot.conf
  softbench_ccase
  space
  startview
  type_manager
  umount
  uncheckout
  unlock
  unregister
  unreserve
  update
  version_selector
  view_scrubber
  vob_restore
  vob_scrubber
  vob_sidwalk
  vob_snapshot
  vob_snapshot_setup
  wildcards_ccase
  winkin
  xclearcase
  xcleardiff
  xmldiffmrg

rmbranch

Removes a branch from the version tree of an element

APPLICABILITY

Product	Command type
ClearCase	cleartool subcommand
ClearCase LT	cleartool subcommand

Platform
UNIX
Windows

SYNOPSIS

rmbranch [ –c·omment comment | –cfi·le comment-file-pname |–cq·uery: | –cqe·ach | –nc·omment ]
[ –f·orce ] pname ...

DESCRIPTION

This command destroys information irretrievably. Using it carelessly may compromise your organization's ability to support old releases.

The rmbranch command deletes one or more branches from their elements. For each branch, deletion entails the following:

Removal from the entire branch structure from the VOB database: branch object and version objects
Removal of all metadata items (labels, attributes, hyperlinks, and triggers) that were attached to the deleted objects
Removal of all event records for the deleted objects
(File elements only) Removal of the data containers that hold the file system data of the deleted versions
Creation of a destroy sub-branch event record for the parent branch of the deleted branch

Note: If all of an element's versions are stored in a single data container, the deleted versions are removed logically, not physically.

To delete all instances of a branch and the branch type object, use the rmtype command.

RESTRICTIONS

Identities

You must have one of the following identities:

Branch creator
Element owner
VOB owner
root (UNIX)
Member of the ClearCase administrators 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, element type, element, branch type, branch, pool (nondirectory elements only).

Mastership

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

Other

You cannot delete an element's main branch or a branch with checkouts. See the reference page for uncheckout.

OPTIONS AND ARGUMENTS

Event Records and Comments

Default: Creates one or more event records, with commenting controlled by your .clearcase_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.

Confirmation Step

Default: rmbranch prompts for confirmation before deleting anything.

–f·orce: Suppresses the confirmation step.

Specifying the Branches to Be Removed

Default: None.
pname ...: One or more VOB-extended pathnames, indicating the branches to be deleted. Examples:
foo.c@@/main/bugfix /vobs/proj/include/proj.h@@/main/temp_482

EXAMPLES

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.

Delete the maintenance branch of element util.c.
cmd-context rmbranch util.c@@/main/maintenanceBranch "util.c@@/main/maintenance" has 0 sub-branches, 2 sub-versions Remove branch, all its sub-branches and sub-versions? [no] yes
Removed branch "util.c@@/main/maintenance".
Verify, with the lsvtree command, that element msg.c has a patch2 branch. Then, delete that branch without prompting for confirmation.
cmd-context lsvtree –branch \main\patch2 msg.c
msg.c@@\main\patch2 msg.c@@\main\patch2\1cmd-context rmbranch –force msg.c@@\main\patch2Removed branch "msg.c@@\main\patch2".

Rational ClearCase Commands Reference