SSCMCheckout Task
Surround SCM Check Out task for checking out files.
Apache Ant
 
Description

Check out files when you need to make changes. You can check out single files, multiple files, or a repository. Surround SCM creates a read-write copy of the file in the working directory.

<taskdef name="sscmcheckout" classname="com.seapine.surroundscm.ant.SSCMCheckout" />

 
Parameters
Attribute Description Type Requirement
file Enter a file or repository name. Can be / or empty, which means the repository specified by the repository option or the default repository. String Required
overwrite Enter how to handle a local writable file: replace, skip. "replace", "skip"
branch Enter the name of branch to check out files from. The default branch is set in the working directory. String Optional
comment Enter a comment. String
exclusive Exclusively lock the files. boolean
force Force file retrieval from server regardless of the local copy status. boolean
quiet Quiet mode. Do not list repository and local full path of the Surround SCM server. boolean
recursive Recursively get files and sub-repositories. boolean
repository Enter the full repository path. String
failOnError Set to true if you want the task to throw a BuildException when it fails. boolean
serverconnect Enter the address and port number of the Surround SCM server host computer. If not entered, use the last saved connection parameters. String
serverlogin Enter the username and password used to login to the Surround SCM server. If not entered, use the last saved login parameters. String
timestamp Set the local file's date/time: current time (default), modify time, checkin time. "current", "modify", "checkin"
version Enter which file version to check out. Ignored if a specific filename is not given in the file attribute. String
 
Parameters as nested elements
 
Examples
 <sscmcheckout
   serverconnect="localhost:4900"
   serverlogin="administrator:"
   file="/"
   branch="Widget 1.0"
   repository="Mainline/Widget"
   recursive="true"
   force="true"
   overwrite="replace"
   comment="This is my Check Out comment"
   />

Check Out all files and repositories from repository 'Mainline/Widget' recursively from the 'Widget 1.0' branch to the working directory setup for user 'administrator'. This call will force the file retrieval from the server even if the local file is current; and overwrite any local files that are writable with the copy from the server. This call will output the progress of the Check Out to the console. Add quiet="true" to hide these progress messages.

 <sscmcheckout
   serverconnect="localhost:4900"
   serverlogin="administrator:"
   quiet="true"
   file="Widget.java"
   branch="Widget 1.0"
   repository="Mainline/Widget"
   overwrite="skip"
   writable="true"
   version="1"
   exclusive="true"
   />

Checkout version 1 of the file 'Mainline/Widget/Widget.java' exclusively from the 'Widget 1.0' branch to the working directory setup for user 'administrator'. Will not overwrite a local file that is writable even if that file is out of date.


Copyright © 2000-2003, Apache Software Foundation