lsprivate

Lists objects in a dynamic view's private storage area

Applicability

Product

Command type

VersionVault

cleartool subcommand

Platform

UNIX

Linux

Windows

Synopsis

lsp/rivate [ –tag view-tag ] [ –inv/ob vob-selector | dir-pname... ]
[ –l/ong | –s/hort ] [ –siz/e ] [ –age ] [ –co ] [ –do ] [ –oth/er ]

Description

The lsprivate command lists file system objects that belong to a dynamic view:

  • View-private files, links, and directories
  • Derived objects
    • Nonshareable derived objects
    • Unshared derived objects
    • Shared derived objects that are cataloged in (visible through) the dynamic view, even though their data containers are stored in a VOB storage pool
  • Checked-out versions of file elements

Except for the shared derived objects, all of these objects are stored in the dynamic view's private storage area.

This command does not list checked-out directory elements, because such a checkout does not produce a view-private object. To list directory checkouts, use the lscheckout command.

The objects are listed with full path names (thus including the VOB tag), one per line.

Note: lsprivate does not work in a snapshot view. In a snapshot view, (cleartool) ls -recurse -view_only provides output equivalent to that of lsprivate.

Stranded view-private files

lsprivate sometimes lists a view-private file in a special way, because the file has become stranded: it has no name in the VOB namespace, as currently constructed by your dynamic view. There are several possible causes and, hence, several actions you can take.

File still accessible through some directory version

The lsprivate listing for a file can include a version-extended path name to some directory element:

/usr/hw/src@@/main/3/subdir1/canUCme

In this example, file canUCme is stranded because its parent directory, subdir1, is not displayed in the dynamic view as it is currently configured; but the file can be accessed through version /main/3 of directory element src, which contains an entry for subdir1. (You cannot use this path name to access the view-private object. A version-extended path name can refer only to an element, branch, or version, not to a view-private file.)

To make a stranded file visible again, you must make its parent directory visible, by reconfiguring the dynamic view (in this case, to select version /main/3 of directory element src).

VOB is inactive

If a VOB is not currently active on your host, all view-private files corresponding to that VOB are temporarily stranded. lsprivate displays a warning message and prefixes a number sign (#) to path names within that VOB:

cleartool: Warning: VOB not mounted: "M:\jc_vw\jc_hw"
  VOB UUID is 1127d379.428211cd.b3fa.08:00:69:06:af:65
.
.
..
#M:\jc_vw\jc_hw\src\.cmake.state
#M:\jc_vw\jc_hw\src\findmerge.log.18-Mar-99.13:43:27
#M:\jc_vw\jc_hw\src\hello
#M:\jc_vw\jc_hw\src\hello.o
.
.
.

Reactivating the VOB on your host restores lsprivate command output to normal for pathnames within that VOB.

VOB is inaccessible

If a VOB has been unregistered, all view-private files corresponding to that VOB are temporarily stranded; if the VOB has been deleted, the view-private files are stranded permanently. lsprivate cannot distinguish these cases; it may infer the VOB's likely VOB tag, but it lists the view-private files with an Unavailable–VOB prefix:

cleartool: Error: Unable to get VOB object registry information for
  replica uuid "1127d379.428211cd.b3fa.08:00:69:06:af:65".
cleartool: Warning: VOB is unavailable -- using name: "<Unavailable-VOB-1>".
  If it has been deleted use 'recoverview -vob <uuid>'
  VOB UUID is 1127d379.428211cd.b3fa.08:00:69:06:af:65
  Last known location of storage is phobos:/usr/people/avid/tut/tut.vbs
#<Unavailable-VOB-1>/<DIR-3587d464.428211cd.b40c.08:00:69:06:af:65>
		/.cmake.state
#<Unavailable-VOB-1>/<DIR-3587d464.428211cd.b40c.08:00:69:06:af:65>
		/findmerge.log.18-Mar-99.13:43:27

The procedure for cleaning up stranded view-private files is described in the Help.

Directory element has been deleted

If a directory element (or its entire VOB) has been deleted, all the corresponding view-private files are permanently stranded. They are listed with the VOB's UUID, as above, with no remedy possible, except to use recoverview to move the files to the dynamic view's lost+found directory (as described in the Help).

Restrictions

None.

Options and arguments

Specifying the view

Default
The current dynamic view is listed; a working directory view takes precedence over a set view.
–tag view-tag
The view tag of any registered dynamic view to which you have read access.
-dir-pname...
One or more directories in the current view.

Listing style

Default
Checked-out versions are annotated with [checkedout].
–l/ong
Lists objects in the style of ls –long.
–s/hort
Lists path names only, without annotations.
–siz/e
Lists each file's size in bytes. At the end of the listing, lists the total size of view private files and of shared DOs in the view.
–age
Lists the last access time of each file.

Selecting objects to list

Default
All of the dynamic view's objects are listed. You can use -co, -do, and -other in any combination to specify a partial listing.
–inv/ob vob-selector
Restricts the listing to objects for the specified VOB. Specify vob-selector in the form [vob:]pname-in-vob

pname-in-vob

Path name 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)
Note: Specifying a path name within the VOB does not limit the listing to objects in and below that directory.
–dir-pname...
Only objects in the specified directory trees are listed.
–co
Lists checked-out versions of file elements. (Checked-out directory elements are never listed by lsprivate.)
–do
Lists derived objects.
–oth/er
Lists view-private files and directories that are neither checked-out versions of file elements nor derived objects.

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.

  • List the private objects in the dynamic view with view tag jackson_vu, from the VOB identified by the pathname /usr_hw_src.

    cmd-context  lsprivate -tag jackson_vu -invob /usr_hw_src
    /usr_hw_src/bug.report
    /usr_hw_src/convolution.c [checkedout]
    /usr_hw_src/edge.sh
    /usr_hw_src/hello
    /usr_hw_src/hello.c [checkedout]
    /usr_hw_src/hello.h [checkedout]
    /usr_hw_src/hello.o
    /usr_hw_msg.o
    /usr_hw_util.c [checkedout]
    /usr_hw_util.c.contrib
    /usr_hw_util.c.contrib.1
    /usr_hw_util.o

  • On a Windows system, list the private objects in the dynamic view with view tag jc_vw, from the VOB identified by the pathname M:\jc_vw_jc_hw\src.

    cmd-context  lsprivate -tag jc_vw -invob M:\jc_vw_jc_hw\src
    M:\jc_vw_jc_hw\src\bug.report
    M:\jc_vw_jc_hw\src\convolut.c [checkedout]
    M:\jc_vw_jc_hw\src\edge.sh
    M:\jc_vw_jc_hw\src\hello.c [checkedout]
    M:\jc_vw_jc_hw\src\hello.h [checkedout]
    M:\jc_vw_jc_hw\src\hello.o
    M:\jc_vw_jc_hw\msg.o
    M:\jc_vw_jc_hw\util.c [checkedout]
    M:\jc_vw_jc_hw\util.c.contrib
    M:\jc_vw_jc_hw\util.c.contrib.1
    M:\jc_vw_jc_hw\util.o

  • List all checked-out versions of elements in the current dynamic view, from all VOBs.

    cmd-context  lsprivate –co
    /usr/hw/src/convolution.c [checkedout]
    /usr/hw/src/hello.c [checkedout]
    /usr/hw/src/util.c [checkedout]
    /vobs/doc/PLAN/DocumentationProposal[checkedout]
    /vobs/doc/reference_man/test/attest.dat [checkedout]
    /vobs/doc/reference_man/test/testelem.c [checkedout]

  • List all elements in the current dynamic view, from all VOBs, using a long listing.

    cmd-context  lsprivate –long
    view private object   M:\jc_vw\tmp_vob\scd_reach\src
    \findmerge.log.2007-02-04T10:01:01
    view private object   M:\jc_vw\tmp_vob\scd_reach\src\
    findmerge.log.2007-02-04T11:00:59
    version               M:\jc_vw\doc\reqs@@\main\CHECKEDOUT from
    \main\33 Rule: element * CHECKEDOUT
    version               M:\jc_vw\doc\specs@@\main\CHECKEDOUT from
    \main\7 Rule: element * CHECKEDOUT

  • List the size and age of all private objects in the current dynamic view.

    cmd-context lsprivate –size –age
    /tmp/sg_test/.cmake.state
         Size: 2724
         Age: 2007-04-05T16:01:10
    /tmp/sg_test/bar
         Size: 10
         Age: 2007-04-05T16:00:54
    /tmp/sg_test/foo
         Size: 10
         Age: 2007-04-05T16:00:53
    /tmp/sg_test/foobar
         Size: 20
         Age: 2007-04-05T16:00:55
    total size of view private files is 2764
    total size of shared derived objects is 0