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
SYNOPSIS
- mkproj·ect [ –c·omment comment | –cfi·le pname | –cq·uery
- | –cqe·ach | –nc·omment ]
[ –mod·comp component-selector[,...
] ]
–in folder-selector
[ –pol·icy policy-keyword[,...] ] [ –npo·licy policy-keyword[,...] ]
[ –spo·licy policy-keyword[,...] ]
[ –model { SIMPLE | DEFAULT } ]
[ –crm·enable ClearQuest-user-database-name ]
[ –bln·ame_template baseline-naming-template ]
[ project-selector ... ]
DESCRIPTION
The mkproject command creates a project. A project includes policy information and configuration information.
Projects are created in folders. A folder or folder hierarchy must be in place before you create a project. If no folder exists, you can specify RootFolder as the folder selector with the –in option. RootFolder is a predefined object that represents the parent folder of a folder hierarchy. See mkfolder for more information.
Projects maintain a list of components that can be modified within the project. You can specify these with the –modcomp option. Streams in the project can make changes, such as checking out files, only in modifiable components; all other components are read-only.
The basic UCM process uses an integration stream and multiple development streams in a project. However, small teams of developers working together closely may prefer a single-stream project. You can create a project with single or multiple streams by using the –model option with keywords SIMPLE or DEFAULT.
Project Policies
You can set or unset projectwide policies, such as specifying that views attached to the integration stream must be snapshot views. Policies are identified by their keywords. Table 8 describes these policies and lists the keywords used to set them. For more information about setting policies, see Managing Software Projects.
| Policy | Keyword |
|---|---|
| Recommend snapshot views for integration work. | POLICY_UNIX_INT_SNAP (UNIX) POLICY_WIN_INT_SNAP (Windows) |
| Recommend snapshot views for development work. | POLICY_UNIX_DEV_SNAP (UNIX) POLICY_WIN_DEV_SNAP (Windows) |
| Skip permission checking to allow any user to modify an existing project with chproject. | POLICY_CHPROJECT_UNRESTRICTED |
| Require a development stream to be based on the current recommended baselines before it can deliver changes to its default target stream. | POLICY_DELIVER_REQUIRE_REBASE |
| Do not allow delivery from a development stream that has checkouts. | POLICY_DELIVER_NCO_DEVSTR |
| Allow a deliver operation from a stream in the same project to include changes from the stream's foundation baselines. | POLICY_INTRAPROJECT_DELIVER _FOUNDATION_CHANGES |
| Allow a deliver operation from a stream in the same project to contain changes in components that are not included in the target stream's configuration. The changes in the missing components are not delivered.[a] | POLICY_INTRAPROJECT_DELIVER _ALLOW_MISSING_TGTCOMPS |
| Allow streams in this project to accept changes in a deliver operation from a stream in a different project. | POLICY_INTERPROJECT_DELIVER |
| Allow a deliver operation from a stream in a different project to include changes from the stream's foundation baselines. This policy is ignored if interproject delivery is disabled. | POLICY_INTERPROJECT_DELIVER _FOUNDATION_CHANGES |
| Require a deliver operation from a stream in a different project to deliver changes in all components. This policy is ignored if interproject delivery is disabled.1 | POLICY_INTERPROJECT_DELIVER _REQUIRE_TGTCOMP_VISIBILITY |
| Allow a deliver operation from a stream in a different project to contain changes in components that are not modifiable in the target stream's configuration. The changes in the nonmodifiable components are not delivered. This policy is ignored if interproject delivery is disabled. | POLICY_INTERPROJECT_DELIVER _ALLOW_NONMOD_TGTCOMPS |
Defaults are different for intraproject and interproject deliver operations. | |
Using Rational ClearQuest with Projects
Optionally, you can link a project to a Rational ClearQuest database. For related information, see chproject.
Baseline Naming
By default, baseline identifiers are made up of two parts: a user-specifiable root name and a generated, unique numeric extension. We recommend you define a meaningful baseline naming convention within a project. You can do so by using the option –blname_template. For more information about baseline names, see mkbl.
RESTRICTIONS
Identities
No special identity required.
Locks
An error occurs if one or more of these objects are locked: the project VOB.
Mastership
(Replicated VOBs only) No mastership restrictions.
OPTIONS AND ARGUMENTS
Event Records and Comments
- Default
- Creates one or more event records,
with commenting controlled by your .clearcase_profile file
(default: –c). 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.
Specifying a Folder for the Project
Specifying Modifiable Components
Setting Project Policy
- Default
- None.
- –pol·icy policy-keyword
- Enables the specified policy. See “Project
Policies”.
- –npo·licy policy-keyword
- Disables the specified policy. See “Project
Policies”.
- –spo·licy policy-keyword
- Allows the specified policy to be enabled
or disabled by individual streams. See “Project
Policies”.
Specifying a Link to the ClearQuest Database
Defining the baseline name template
- Default
- Baseline identifiers are made up of two parts: a user-specifiable root
name and a generated, unique numeric extension.
- –bln·ame_template baseline-naming-template
- Defines the baseline name template for a project. baseline-naming-template specifies
the tokens to be used in the baseline name and it can include any of the following
tokens separated by commas:
When you create baselines, UCM replaces commas with underscores in the baseline name.
Specifying the Project Name
- Default
- A generated name.
- project-selector
- Specifies the project.
You can specify the project as a simple name or as an object selector of the form [project:]project-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 the project resides in the project VOB that is associated with the current view. If the current directory is a project VOB, that project VOB is the context for identifying the project.
The project name must be unique within the PVOB. All UCM objects share the same namespace. You'll get an error if the name you provide collides with the name of an existing UCM object, for example, a component.
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.
Note: In the UNIX examples that follow, arguments and output that show multicomponent VOB tags are not applicable to ClearCase LT, which recognizes only single-component VOB tags. In this manual, a multicomponent VOB tag is by convention a two-component VOB tag of the form /vobs/vob-tag-leaf—for example, /vobs/src. A single-component VOB tag consists of a leaf only—for example, /src. In all other respects, the examples are valid for ClearCase LT.