<sscmcheckout>

[This is preliminary documentation and subject to change.]

Checks out files from a Surround SCM repository.

You can check out single files, multiple files, or a full repository. Surround SCM creates a read-write copy of the files in the working directory.

Parameters

AttributeTypeDescriptionRequired
branchstring Surround SCM branch name. The default is pulled from the local working directory. False
commentstring Comment for the check-out. False
exclusivebool Exclusively lock the files. The default is false. False
filestring File or repository name. Can be / or empty, which means the repository specified by the repository attribute or the default repository. False
forcebool Force file retrieval from server regardless of the local copy status. The default is false. False
overwritebool Specifies whether to overwrite local writable files. The default is false. False
quietbool Do not list repository and local full path of the Surround SCM server. The default is false. False
recursivebool Recursively get files and sub-repositories. The default is false. False
repositorystring Surround SCM repository path. The default is pulled from the local working directory. False
timestampstring Specifies how to set the local file's date/time. Possible values are current, modify or checkin. False
versionstring Specifies the file version to check out. Ignored if no specific filename is set using the file attribute. False
failonerrorbool Determines if task failure stops the build, or is just reported. The default is true. False
ifbool If true then the task will be executed; otherwise, skipped. The default is true. False
serverconnectstring 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
serverloginstring 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
timeoutint The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. False
unlessbool Opposite of if. If false then the task will be executed; otherwise, skipped. The default is false. False
verbosebool Determines whether the task should report detailed build log messages. The default is false. False

Framework-configurable parameters

AttributeTypeDescriptionRequired
managedManagedExecution 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
useruntimeengineboolDeprecated. Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is false. False

Nested Elements:

<arg>

The command-line arguments for the external program.

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.

Parameters

AttributeTypeDescriptionRequired
dirdirectory The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. False
filefile The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. False
ifbool 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
linestring 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 : or ; as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. False
unlessbool 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
valuestring A single command-line argument; can contain space characters. False

Nested Elements:

<path>

Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used.

</path>

Examples

</arg>

Examples

Requirements

Assembly: NAnt.Contrib.Tasks (0.93.5521.0)