|NAntContrib Help Task Reference <sscmfreeze>||v0.92-alpha1|
[This is preliminary documentation and subject to change.]
Freezes branches in a Surround SCM repository.Freezing a branch prevents any code changes being made to files in the branch. When a branch is frozen, it is locked and no changes can be made to it.
|branch||string||Surround SCM branch name.||True|
|mainline||string||Surround SCM mainline branch name. The default is pulled from the local working directory.||False|
|failonerror||bool||Determines if task failure stops the build, or is just reported. The default is true.||False|
|if||bool||If true then the task will be executed; otherwise, skipped. The default is true.||False|
|serverconnect||string||The address and port number of the Surround SCM server host computer. Format is server:port. If not entered, the last saved connection parameters are used.||False|
|serverlogin||string||The username and password used to login to the Surround SCM server. Format is username:password. If not entered, the last saved login parameters are used.||False|
|timeout||int||The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out.||False|
|unless||bool|| Opposite of ||False|
|verbose||bool||Determines whether the task should report detailed build log messages. The default is false.||False|
|managed||ManagedExecution||Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR.||False|
|useruntimeengine||bool||Deprecated. Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is false.||False|
Represents a command-line argument.
When passed to an external application, the argument will be quoted when appropriate. This does not apply to the
line parameter, which is always passed as is.
|dir||directory||The value for a directory-based command-line argument; will be replaced with the absolute path of the directory.||False|
|file||file||The name of a file as a single command-line argument; will be replaced with the absolute filename of the file.||False|
|if||bool||Indicates if the argument should be passed to the external program. If true then the argument will be passed; otherwise, skipped. The default is true.||False|
|line||string||List of command-line arguments; will be passed to the executable as is.||False|
|path||<path>|| The value for a PATH-like command-line argument; you can use ||False|
|unless||bool||Indicates if the argument should not be passed to the external program. If false then the argument will be passed; otherwise, skipped. The default is false.||False|
|value||string||A single command-line argument; can contain space characters.||False|
A single command-line argument containing a space character.
<arg value="-l -a" />
Two separate command-line arguments.
<arg line="-l -a" />
A single command-line argument with the value
\dir;\dir2;\dir3 on DOS-based systems and
/dir:/dir2:/dir3 on Unix-like systems.
<arg path="/dir;/dir2:\dir3" />
Freeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the server at localhost, port 4900 with username 'administrator' and a blank password.
<sscmfreeze serverconnect="localhost:4900" serverlogin="administrator:" mainline="Mainline" branch="Widget 1.0" />