lshistory

Lists event records for VOB database objects

Applicability

Product

Command type

VersionVault

cleartool subcommand

VersionVault Remote Client

rcleartool subcommand

Platform

UNIX

Linux

Windows

Synopsis

  • VersionVault–display event records graphically:
    lsh/istory –g/raphical [ –nop/references [ [ –min/or ] [ –nco ]
    [ –use/r login-name ] [ –bra/nch branch-type-selector ] ] ]

    [ [ –r/ecurse | –d/irectory | –a/ll | –avo/bs ]

    [ –pna/me ] pname ...

    | object-selector ...

    ]

    Note: If the environment variable CCASE_USE_GUI is set, options other than –graphical are not supported.
  • VersionVault–display event records in the command window:
    lsh/istory [ –l/ong | –s/hort | –fmt format-string ] [ –eve/ntid ]
    [ –min/or ] [ –nco ] [ –las/t [ num-events ] ] [ –sin/ce date-time ]

    [ –me | –use/r login-name ] [ –bra/nch branch-type-selector ]

    [ [ –r/ecurse | –d/irectory | –a/ll | –avo/bs | –local ]

    [ –pna/me ] pname ... | object-selector ... ]

  • VersionVault Remote Client–display event records in the command window:
    lsh/istory [ –l/ong | –s/hort | –fmt format-string ] [ –eve/ntid ]
    [ –min/or ] [ –nco ] [ –las/t [ num-events ] ] [ –sin/ce date-time ]

    [ –me | –use/r login-name ] [ –bra/nch branch-type-selector ]

    [ [ –r/ecurse | –d/irectory | –a/ll | –local ]

    [ –pna/me ] pname ... | object-selector ... ]

Description

The lshistory command lists event records in reverse chronological order, describing operations that have affected a VOB's data. There are several kinds of listing:

  • File system data history. Lists events concerning elements, branches, versions, and VOB links. This includes records for creation and deletion of objects, and records for attaching and removal of annotations: version labels, attributes, and hyperlinks.
  • Hyperlink history. Lists events concerning hyperlink objects: creation, deletion, attachment or removal of attributes.
  • Type history. Lists events concerning type objects that have been defined in the VOB.
  • Storage pool history. Lists events concerning the VOB's storage pools.
  • VOB history. Lists events concerning the VOB object itself. This includes the deletion of type objects and elements from the VOB.
  • VOB replica history. Lists events concerning a VOB replica, including synchronization updates.
Note: Version 8.0 clients that are accessing a project VOB at feature level 7 can list the operation kinds, modtimeline, modcomp, setstream, unsetstream, mktimeline, rmtimeline, modstream_cspec, mkview_stream.

Restrictions

None.

Options and arguments

Default. If you do not specify any objects to be listed, lshistory displays events for the file system objects in the current working directory and events for the directory element itself. (This is equivalent to specifying "." and ".@@" as the pname arguments.) The following sections describe how to produce a report on other file system objects, or on other kinds of objects.

Listing event records graphically

Default
Lists event records in the command window.
–g/raphical
Starts a browser that displays event records.

Ignoring preferences settings

Default
Displays the history browser with your saved settings for filtering.
–nop/references
Temporarily overrides filtering settings. When used alone, uses default settings (displays all events except minor events). When used in combination with one or more of –minor, –nco, –user, or –branch, overrides your current filtering settings.
Note: You cannot save your History Browser settings during a session that you invoked using the –nopreferences option.

Report format

Default
Default report format for an element:

—02-02T10:51 scd create version "msg.c@@/main/rel2_bugfix/1"
"Version for branch creation test"
–02-02T10:51 scd create version "msg.c@@/main/rel2_bugfix/0"
–02-02T10:51 scd create branch "msg.c@@/main/rel2_bugfix"
.
.
.
–02-01T16:17 scd create file element "msg.c@@"

Default report format for a hyperlink:

–02-08T11:25 scd create hyperlink "Merge@535@\tmp\scd_reach_hw"

Default report format for a storage pool:

–02-01T16:05 scd create pool "cdft"
"Predefined pool used to store cleartext versions."

–l/ong
Expands the listing to include other object-specific information.
–s/hort
Restricts the listing to names only: path names of file system objects, names of type objects, or names of storage pools.
–fmt format-string
Lists information using the specified format string. For details about using this report-writing facility, see the fmt_ccase reference page.
–eve/ntid
Displays a numerical event ID on the line preceding each event record (even if you use –fmt). You can change the comment assigned to an arbitrary event record by supplying an event ID to the chevent –event command. Event IDs remain valid until the VOB is reformatted with reformatvob.

Selecting events for the specified objects

Default
The report includes all the major events in the entire histories of the selected objects.
Note: When using one or more of these options with lshistory –graphical, you must precede them with the –nopreferences option (the –branch option also has this requirement).
–min/or
Includes less important events in the listing: attaching of attributes, version labels, and so on. For type objects and storage pools, minor events include rename operations and changes to pool parameters (mkpool –update).
–nco
Excludes checkout version events (the ones listed by the lscheckout command).
–las/t [ num-events ]
Lists the specified number of events, starting with the most recent. If num-events is not specified, lists the most recent event.
Note: This option is mutually exclusive with –recurse.
–sin/ce date-time
Lists events recorded since (that is, at and after) the specified date-time.

The date-time argument can have any of the following formats:

date.time | date | time | now

where:

–

date

:=

day-of-week | long-date

time

:=

h[h]:m[m][:s[s]] [UTC [ [ + | - ]h[h][:m[m] ] ] ]

day-of-week

:=

today |yesterday |Sunday | ... |Saturday |Sun | ... |Sat

long-date

:=

d[d]–month[–[yy]yy]

month

:=

January |... |December |Jan |... |Dec

Specify time in 24-hour format, relative to the local time zone. If you omit the time, the default value is 00:00:00. If you omit date, the default is today. If you omit the century, year, or a specific date, the most recent one is used. Specify UTC if you want to resolve the time to the same moment in time regardless of time zone. Use the plus (+) or minus (-) operator to specify a positive or negative offset to the UTC time. If you specify UTC without hour or minute offsets, Greenwich Mean Time (GMT) is used. (Dates before January 1, 1970 Universal Coordinated Time (UTC) are invalid.)

Examples:

22-November-1999
sunday
yesterday.16:00
8-jun
13:00
today
9-Aug.10:00UTC

–me
Lists events recorded for commands entered by the current user.
–use/r login-name
Lists events recorded for commands entered by the specified user.

File system data history

Use the following to specify one or more file system objects for a history listing.

–bra/nch branch-type-selector
Restricts the report to events relating to branches of the specified type. If you use this option with –graphical, you must precede –branch with the –nopreferences option. Specify branch-type-selector in the form [brtype:]type-name

Table

type-name

Name of the branch type
–r/ecurse
Processes the entire subtree below any directory element encountered. VOB symbolic links are not traversed during the recursive descent.
Note: This option is mutually exclusive with –last.
–d/irectory
Lists information on a directory element itself, rather than on its contents.
–a/ll
Reports on all objects in the VOB containing pname: file system objects, type objects, and storage pools. If you omit pname, this option uses the VOB that contains the current working directory. Specifying –all implicitly specifies –local.
–avo/bs
Similar to –all, but includes all VOBs active (mounted) on the local host. (If environment variable CLEARCASE_AVOBS is set to a list of VOB tags, this set of VOBs is used instead.) If a VOB has multiple replicas, events from all the replicas are reported. Specifying –avobs implicitly specifies –local.
–local
Reports on local copies of types specified with object-selector. By default, lshistory displays the history of the global type for the object selector you specify. For more information about global types, see the Help.
–pna/me
Indicates that pname is a file system object. Do not use this option when pname has the form of an object selector (for example, lbtype:V3.0).
pname ...
One or more path names, specifying elements and/or VOB symbolic links whose history is to be listed.
Note: You cannot use a pname argument like foo.c@@\main to restrict the report in this way.
object-selector ...
The object whose event records are to be displayed. The object must be in the VOB containing the current working directory, unless you use the @vob-selector suffix. Specify object-selector in one of the following forms:

Table for object-selector

vob-selector

vob:pname-in-vob

pname-in-vob can be the pathname of the VOB tag (whether or not the VOB is mounted) or of any file system objects within the VOB (if the VOB is mounted). It cannot be the pathname of the VOB storage directory.

attribute-type-selector

attype:type-name[@vob-selector]

branch-type-selector

brtype:type-name[@vob-selector]

element-type-selector

eltype:type-name[@vob-selector]

hyperlink-type-selector

hltype:type-name[@vob-selector]

label-type-selector

lbtype:type-name[@vob-selector]

trigger-type-selector

trtype:type-name[@vob-selector]

pool-selector

pool:pool-name[@vob-selector]

hlink-selector

hlink:hlink-id[@vob-selector]

oid-obj-selector

oid:object-oid[@vob-selector]

The following object selector is valid only if you use MultiSite:

replica-selector

replica:replica-name[@vob-selector]

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 event history of an element.

    cmd-context  lshistory hello.c
    2007-12-08T12:05 jackson  import file element "hello.c@@"
    2007-05-20T15:41 cory     create version "hello.c@@/main/3" (REL2)
    "include name, home dir, and time in message
    KNOWN BUG: extra NL at end of time message"
    2007-05-07T08:34 akp      create version "hello.c@@/main/2" (REL1)
    "ANSI compatibility: declare return value type, make explicit
    return value also: clean up wording for The Boss"
    2007-05-04T13:35 akp      create version "hello.c@@/main/1"
    "first implementation"
    2007-05-04T13:35 akp      create version "hello.c@@/main/0"
    2007-05-04T13:35 akp      create branch "hello.c@@/main"
    2007-05-04T13:35 akp      create file element "hello.c@@"

  • List the history of a label type, using the long format.

    cmd-context  lshistory –long lbtype:REL1
    2007-01–08T12:05:43 Chuck Jackson (test user) (jackson.dvt@oxygen)
    import label type "REL1"
    2007-04-15T14:45:00 ross.devt@neptune
    create label type "REL1"
    "create label for Release 1 of "hello world" program"

  • For all elements in the current working directory, list events involving the rel2_bugfix branch.

    cmd-context  lshistory –branch rel2_bugfix
    2007-03-24T12:45 jackson      create version "msg.c@@/main/rel2_bugfix/0"
    2007-03-24T12:45 jackson      create branch "msg.c@@/main/rel2_bugfix"
    "release 2 bugfixes"
    2007-03-23T20:40 jackson      create version "util.c@@/main/rel2_bugfix/1"
    "fix bug: extra NL in time string"
    2007-03-23T20:39 jackson      create version "util.c@@/main/rel2_bugfix/0"
    2007-03-23T20:39 jackson      create branch "util.c@@/main/el2_bugfix"

  • On a Windows system, list the latest event for every file element in or below the current directory. 
    cleartool find . –type f –exec "cleartool lshistory –last %CLEARCASE_XPN%" 
2007-06-09T17:25   lee     create version ".\file.txt@@\main\1"
2007-06-07T15:33   cty     create version ".\tests.txt@@\main\33"
2007-05-17T23:44   ben     create version ".\dir1\comp.c@@\main\bugfix\45"
...
  • List the history of the VOB object itself for the current VOB. 
    cmd-context  lsh vob:. 
2007-12-10T08:01 gomez      unlock versioned object base "/home/gomez/personal"
2007-12-09T15:48 gomez      lock versioned object base "/home/gomez/personal"
 "Locked for all users."
2007-10-02T19:46 gomez      create versioned object base "/home/gomez/personal"
 "gomez's personal vob"
  • Start a history browser, overriding the saved filtering settings and displaying events for the hello.c element that are related to the v4_test branch.

    cmd-context  lshistory –graphical –nopreferences –branch v4_test hello.c