Rational ClearCase Commands Referenceannotate
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
DESCRIPTION
The chevent command modifies or replaces the comment string in one or more existing event records. It is useful for correcting typing errors and for including information that was omitted in the original comment.
There are several ways to specify an event record whose comment you want to change:
- If you specify a checked-out version, chevent changes the comment in the checkout event record.
- If you specify any other object, chevent changes that object's creation event record. For example, if you specify a label type object, chevent changes the comment supplied when that label type was created with mklbtype.
- You can change the comment in an arbitrary event record by passing its event ID to the –event option. Use the command lshistory –eventid to capture event IDs. (Event IDs remain valid until the VOB is reformatted with reformatvob.)
For details about the operations that cause event records to be created and how event records are attached to objects, see the events_ccase reference page. See also the comments reference page.
RESTRICTIONS
Identities
You must have one of the following identities:
Locks
The following restrictions apply:
Mastership
(Replicated VOBs only) For a version, your current replica must master the branch containing the version. For any other object, your current replica must master the object.
OPTIONS AND ARGUMENTS
Specifying the Comment Change
- Default
- For each object or event, chevent prompts
for a comment string to apply to the corresponding event record.
- –c·omment comment
- Specifies a character string to replace
the existing comment or be added to it.
- –cfi·le comment-file-pname
- Specifies a text file whose contents are
to be placed in the event record.
Note: A final newline character in this file is included in the comment.
- –cq·uery
- Prompts for one comment, which will be used
to update all of the event records.
- –cqe·ach
- Same as default—prompts for a separate
comment string for each object or event ID.
- –nc·omment
- No comment. When combined with –replace,
this option removes the existing comment. Otherwise, it nullifies the effect
of chevent.
Specifying How to Change the Comment
- Default
- The new comment is appended to the existing
one. On UNIX systems, it is preceded by a newline character.
- –app·end
- Same as default.
- –ins·ert
- The new comment is inserted before the existing
one. On UNIX systems, the new comment is followed by a newline character.
- –rep·lace
- The existing comment is discarded; the new
comment replaces it.
Specifying Event Records to Be Changed
You can indicate which event record is to be changed by specifying a file system object, a non-file-system object, or a numerical event ID.
- Default
- None.
- –eve·nt [ –inv·ob vob-selector ] event-ID ...
- Specifies one or more events by their numeric
event IDs. The –event keyword can appear anywhere an
option is valid; the event ID arguments must appear at the end of the command
(that is, after all options). By default, event IDs specify events in the
VOB containing the current working directory; use –invob vob-selector to
specify another VOB.
To determine the event ID of an event, use lshistory –eventid.
- [ –pna·me ] pname ...
- A standard pathname or VOB-extended pathname,
indicating the creation event record for an element, branch, or version object.
The standard pathname of an element specifies the version in your view. The –pname option
is required only if the pathname looks like an object-selector (for example,
an element named pool:one).
Specifying a checked-out version changes its checkout version comment. You can use any of the following to specify the checked-out version:
- object-selector ...
- One or more object-selectors,
in any of these forms:
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.
- Add
a creation comment for an element, verifying the change with describe.
cmd-context chevent hello.c@@
Comments for "hello.c":
Main module of greeting program.
.
Modified event of file element "hello.c".
cmd-context describe hello.c@@
file element "hello.c@@"
created 04-Dec-98.14:38:26 by anne.user
"Main module of greeting program"
element type: text_file
source pool: p1 cleartext pool: pc1 - Add
a header to a checked-out version's checkout comment.
cmd-context lscheckout bye.c
13-May.13:58 anne checkout version "bye.c" from /main/1 (reserved)
"Improve error handling."
cmd-context chevent –insert –c "Fix bug #2493:" bye.c
Modified event of version "bye.c".
cmd-context lscheckout bye.c
13-May.13:58 anne checkout version "bye.c" from /main/11 (reserved)
"Fix bug #2493:
Improve error handling." - Update
a branch type creation comment.
cmd-context chevent –append brtype:v1_bugfix
Comments for "v1_bugfix":
Branches should sprout from the version labeled 'V1'
.
Modified event of branch type "v1_bugfix"
cmd-context lstype brtype:v1_bugfix
28-Mar.16:26 ali branch type "v1_bugfix"
"Branch for fixes to version 1.
Branches should sprout from the version labeled 'V1'" - Delete the comment on a branch object.
- Find
the event ID for an operation and append a comment string to the one already
assigned to that event. Then verify that the new comment was added.
cmd-context lshistory –long –eventid util.c
event 45678:
21-Mar-99.14:45:20 Anne Duvo (anne@neptune)
destroy sub-branch "bugfix" of branch "util.c@@\main"
“Destroyed branch “\main\bugfix"."
.
.
.
cmd-context chevent –c "bugfix merge completed." –append –event 45678
Modified event "45678".
cmd-context lshistory –long –eventid util.c
event 45678:
21-Mar-99.14:45:20 Anne Duvo (anne@neptune)
destroy sub-branch "bugfix" of branch "util.c@@\main"
"Destroyed branch "\main\bugfix".
"bugfix merge completed."
.
.
.