Summary

Executes the svn checkout command.

Assembly

NAnt.Contrib.dll

Namespace

NAnt.Contrib.Tasks.Svn

Base Types

AbstractSourceControlTask
AbstractSvnTask

graph BT Type-->Base0["AbstractSvnTask"] click Base0 "/api/NAnt.Contrib.Tasks.Svn/AbstractSvnTask" Base0-->Base1["AbstractSourceControlTask"] Type["SvnCheckoutTask"] class Type type-node

Syntax

[TaskName("svn-checkout")]
public class SvnCheckoutTask : AbstractSvnTask

Examples

Checkout Gentle.NET.

    <svn-update
    destination="c:/dev/src/gentle.net" 
    uri="http://www.mertner.com/svn/repos/projects/gentle" 
    recursive="true"
    verbose="false"
    username="anonymoose"
    password="Canada" 
    revision="HEAD"
    cache-auth="false"
    config-dir="c:\home"
/>

Attributes

Type	Description
TaskName

Constructors

Name	Summary
SvnCheckoutTask()	Initialize the task, and set the default parameters.

Fields

Name	Constant Value	Summary
ARG_PREFIX	--	The prefix used for command arguments. Inherited from AbstractSvnTask static
SVN_EXE	svn.exe	The name of the svn executable. Inherited from AbstractSvnTask static
SVN_HOME	SVN_HOME	An environment variable that holds path information about where svn is located. Inherited from AbstractSvnTask static
SVN_PASSFILE		Name of the password file that is used to cash password settings. Inherited from AbstractSvnTask static
SVN_RSH	RSH	Environment variable that holds the executable name that is used for ssh communication. Inherited from AbstractSvnTask static

Properties

Name	Value	Summary
CacheAuth	bool	`true` if the authentiction token should be cached locally.
CommandName	string	Gets the svn command to execute.
ConfigDir	string	The location of the configuration directory.
ExeName	string	The full path of the svn executable. Inherited from AbstractSvnTask
Interactive	bool	Indicates whether the task should be interactive or not. This is set to `false` by default, and I don't see a reason to expose this to the NAnt task. Inherited from AbstractSvnTask
PassFileName	string	The name of the password file. Inherited from AbstractSvnTask
Password	string	The pasword to use to login to svn. Inherited from AbstractSvnTask
Quiet	bool	Specifies whether to print as little information as possible. The default is `false`. Inherited from AbstractSvnTask
Recursive	bool	`true` if the command should be executed recursively. The default is `true`.
Revision	string	The revision to checkout. If no revision is specified then subversion will return the `HEAD` .
Root	string	TODO: Add more documentation when I understand all svn root possibilities/ protocols. The svn root is usually in the form of a URL from which the server, protocol and path information can be derived. Although the path to the repository can also be determined from this the information is more implicit than explicit. For example a subversion root URL of: http://svn.collab.net/repos/svn/trunk/doc/book/tools would have the following components: protocol: http/ web_dav username: anonymous servername: svn.collab.net repository: /repos/svn server path: /trunk/doc/book/tools In addition the revision path or branch can also be determined as subversion stores this information as a seperate physical directory. In this example: revision: trunk Inherited from AbstractSvnTask
Ssh	FileInfo	The executable to use for ssh communication. Inherited from AbstractSvnTask
SshEnv	string	The name of the ssh/ rsh environment variable. Inherited from AbstractSvnTask
UserName	string	The user performing the checkout. Inherited from AbstractSvnTask
VcsExeName	string	The name of the executable. Inherited from AbstractSvnTask
VcsHomeEnv	string	Name of the home environment variable. Inherited from AbstractSvnTask

Methods

Name	Value	Summary
PrepareProcess(Process)	void	Build up the command line arguments, determine which executable is being used and find the path to that executable and set the working directory.
SetPropertiesDefaults()	void	Set default values for non-requiered parameters. Inherited from AbstractSvnTask

SvnCheckoutTask Class