rmstream

Removes a stream

Applicability

Product

Command type

VersionVault

cleartool subcommand

Platform

UNIX

Linux

Windows

Synopsis

  • Remove a stream:
    rmstream [ –c/omment comment | –cfi/le comment-file-pname | –cq/uery
    | –cqe/ach | –nc/omment ] [ –f/orce ] stream-selector ...
  • Remove an integration stream template:
    rmstream –template
    [ –f/orce ]

Description

The rmstream command deletes one or more streams or an integration stream template.

Restrictions

Identities

You must have one of the following identities:

  • Stream owner
  • Project VOB owner
  • root (UNIX and Linux)
  • Member of the VersionVault administrators group (VersionVault on Windows only)

Locks

An error occurs if one or more of these objects are locked: stream.

Mastership

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

Other

The following restrictions apply:

  • The stream cannot contain activities.
  • The stream can have no baselines other than the set of initial baselines associated with it.
  • No views can be attached to the stream.
  • A project's integration stream cannot be removed while other project streams exist.

Options and arguments

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.

Confirmation step

Default
Prompts for confirmation that the specified stream is to be deleted.
–f/orce
Suppresses the confirmation step.

Specify the stream to be removed

Default
None.
stream-selector ...
Specifies one or more streams to delete.

You can specify the stream as a simple name or as an object selector of the form [stream:]name@vob-selector, where vob-selector specifies a project VOB (see the cleartool reference page). If you specify a simple name and the current directory is not a project VOB, this command assumes that the stream resides in the project VOB associated with the current view. If the current directory is a project VOB, that project VOB is the context for identifying the stream.

Removing an integration stream template

Default
None.
–template
Removes the integration stream template for a project VOB. The command must be used from the project VOB directory and you must have administrator privileges.

Examples

The UNIX system and Linux examples in this section are written for use in csh. If you use another shell, you might 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 might 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.

  • Remove a stream that has a view attached to it.
    1. Issue the rmstream command. You are told that the stream cannot be removed because a view is still attached to it:

      cmd-context rmstream -f html_parser_int
      cleartool: Error: Cannot remove stream that has a view
          ("html_parser_int_view") attached to it.
      cleartool: Error: Unable to remove stream "html_parser_int".

    2. Display a description of the stream to see what views are attached to it:

      cmd-context describe stream:html_parser_int
      stream "html_parser_int"
      created 2007-09-11T11:27:01 by JFMuggs
        owner: jfm
        group: user
        project: html_parser
        title: html_parser_int
        contains activities:
        foundation baselines:
        views:
          html_parser_int_view

      Guarding: brtype:html_parser_int@/usr1/tmp/foo_project

    3. Remove the view:

      cmd-context  rmview -tag html_parser_int_view
      Removing references from VOB "/usr1/tmp/foo_project" ...
      Removed references to view "/net/propane/usr1/tmp/html_parser_int.vws"
      from VOB "/usr1/tmp/foo_project".

    4. Reissue the rmstream command:

      cmd-context  rmstream -f html_parser_int
      Removed stream "html_parser_int".