view_scrubber

Remove derived object data containers from dynamic view storage

APPLICABILITY

ClearCase (administrative command)

SYNOPSIS

view_scrubber [ -p ] [ -k ] [ -n ] [ DO-pname ... ]

DESCRIPTION

The view_scrubber program cleans a view's private storage area by removing data containers for derived objects (DOs). view_scrubber scrubs only the files that are piped to its stdin stream. See the EXAMPLES section for an example.

NOTE: This command does not apply to snapshot views because derived objects can be created only in dynamic views.

WARNING: This command modifies the way in which view-resident objects are combined with VOB-resident objects to produce a virtual workspace. To avoid errors, make sure that no application or development tool is using the view's files when this command is executed.

Scrubbing is useful in the situations described in the following sections.

Cleaning Up after a Winkin

When a clearmake or omake build winks in a shareable DO for the first time, the DO's data container is copied from the private storage area of the view in which it was built to the VOB storage pool. At this point:

• The view where the DO was originally built continues to use the data container in view storage.
• Any other view to which the DO is subsequently winked in uses the data container in VOB storage.

Running view_scrubber in the view where the DO was built simplifies the situation. view_scrubber performs the following steps:

1. Removes the DO with del. This deletes the data container from view storage.
2. Winks in the DO to the view, which establishes a link to the data container in VOB storage.

Now, all views that share the DO access the data container in VOB storage. This eliminates the redundant, space-consuming data container in view storage.

Self-Winkin

By default, the data container for a nonshareable DO or an unshared DO remains in view storage until the DO is deleted or overwritten. view_scrubber -p transfers the data container to VOB storage, thus freeing space in the view storage area. In essence, this involves winking in the DO to the same view. view_scrubber -p performs the following steps:

1. (Nonshareable DO only) Converts the DO to a shareable DO by writing information about the DO into the VOB.

   If the DO has any sub-DOs or siblings, view_scrubber -p makes them shareable.

2. Promotes the data container from view storage to VOB storage.
3. Removes the DO with del, which deletes the data container from view storage.
4. Winks in the DO to the view, which establishes a link to the data container in VOB storage.

You can also use the winkin command to accomplish this scenario.

NOTE: When a nonshareable DO is converted to a shareable DO, its DO-ID changes. For more information, see Derived Objects and Configuration Records in Building Software with ClearCase.

OPTIONS AND ARGUMENTS

PREPROCESSING WITH A PROMOTION.  Default: view_scrubber removes view-resident data containers, then restores the derived objects to the view through winkin. Requirement: The derived objects' data containers must already be in VOB storage.

-p

Before performing the default processing described above, promotes (copies) the derived objects' data containers from view storage to VOB storage. This removes the requirement that the data containers be in VOB storage.

ERROR RECOVERY.  Default: view_scrubber aborts if it is unable to complete its work on any derived object.

-k

Keeps going, even if one or more derived objects cannot be processed successfully.

NO-EXECUTE OPTION.  Default: view_scrubber performs its work and displays appropriate messages.

-n

Suppresses the actual processing of data containers. view_scrubber displays messages describing the work it would have performed.

DERIVED OBJECTS TO PROCESS.  Default: If you don't specify any DOs as command arguments, view_scrubber reads a one-per-line list of pathnames from stdin, which must be a pipe.

DO-pname ...

One or more standard pathnames of derived objects.

EXAMPLES

• Make the view to be scrubbed the current working view, and move to the directory of interest. Then scrub DO containers for the entire directory tree, using a pipe.

C:\> Z: (change to a view drive)

Z:\> cd \vob_src\pr1

Z:\vob_src\pr1> dir /s /b *.obj | view_scrubber

• Scrub two DOs, promoting the data containers to VOB storage.

> view_scrubber -p e:\devel\lib\cmd.h g:\devel\lib\cmd_api.h

SEE ALSO

clearmake, promote_server, scrubber, winkin