si lock
locks project members
Synopsis
si lock [--cpid=ID|--changePackageId=ID] [--lockType=[exclusive|nonexclusive|auto]] [--[no|confirm]downgradeOnLockConflict [--issueId =ID] [(-r rev|--revision=rev)] [(-R|--[no|confirm]recurse)] [--filter=filteroptions] [(-P project|--project=project)] [--[no]failOnAmbiguousProject] [(-S sandbox|--sandbox=sandbox)] [--devpath=path] [--hostname=server] [--port=number] [--password=password] [--user=name] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--[no|confirm]revisionMismatchIsError] [--forceConfirm=[yes|no]] [(-g|--gui)] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] member...
Description
si lock locks one or more project members. For example,
si lock --lockType=nonexclusive c:/Documentation/Man_Pages/xml_man/si_add.1.xml
If no members are specified, si lock applies to all project members. By default, the member revision is locked and not necessarily the working revision, if in a Sandbox.
This is purely a project operation -- if performed in a Sandbox, no memory of what revision was locked is maintained in the Sandbox. However, you can create a work in progress indicator for the the associated working file in the Sandbox.
Depending on the locking policy configured by your administrator, you may hold a lock on only one revision of a particular member at a time. It is not an "error" to relock an already locked member.
If the target revision is already locked by a user other than yourself, then specifying the --branch option creates a branch revision and locks it. Otherwise, you cannot lock the revision at all.
Options
This command takes the universal options available to all
si commands, as well as some general options. See the
options reference page for descriptions.
• --lockType=[exclusive|nonexclusive|auto]
specifies the type of lock obtained on checkout.
--lockType=exclusive obtains an exclusive lock on the member. Exclusive locks enable only one member at a time to lock a specific revision.
--lockType=nonexclusive obtains a non-exclusive lock on the member. Non-exclusive locks enable multiple users to check out the same revision for editing.
--lockType=auto obtains a lock on the member based on the locks policy. For information on the locks policy, contact your administrator. If the locks policy does noe require a lock, but the --lock option is set, a non-exclusive lock is obtained.
• --[no|confirm]downgradeOnLockConflict
controls whether to downgrade your lock to non-exclusive if another user has an exclusive lock on the revision.
--downgradeOnLockConflict means always downgrade.
--nodowngradeOnLockConflict means never downgrade.
--confirmdowngradeOnLockConflict means always ask before downgrading.
• --[no|confirm]revisionMismatchIsError
controls whether to display an error message if the working revision does not match the member revision. This only applies if you are performing the lock operation in a Sandbox.
• member...
identifies a specific member; use spaces to specify more than one member.
Diagnostics
See the
diagnostics reference page for possible exit status values.
Preferences
Using
si setprefs or
si viewprefs, you are able to set or view the preference keys for this command.
See Also
• Commands:
• Miscellaneous: