AbstractSvnTask Class

Summary

A base class for creating tasks for executing CVS client commands on a CVS repository.
Assembly
NAnt.Contrib.dll
Namespace
NAnt.Contrib.Tasks.Svn
Base Types
  • AbstractSourceControlTask
Derived Types
graph BT Type-->Base0["AbstractSourceControlTask"] Type["AbstractSvnTask"] class Type type-node Derived0["SvnCheckoutTask"]-->Type click Derived0 "/api/NAnt.Contrib.Tasks.Svn/SvnCheckoutTask" Derived1["SvnTask"]-->Type click Derived1 "/api/NAnt.Contrib.Tasks.Svn/SvnTask" Derived2["SvnUpdateTask"]-->Type click Derived2 "/api/NAnt.Contrib.Tasks.Svn/SvnUpdateTask"

Syntax

public abstract class AbstractSvnTask : AbstractSourceControlTask

Constructors

Name Summary
AbstractSvnTask() Initializes a new instance of the NAnt.Contrib.Tasks.Svn.AbstractSvnTask class.

Fields

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

Properties

Name Value Summary
CommandName string
The command to execute.
ExeName string
The full path of the svn executable.
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.
PassFileName string
The name of the password file.
Password string
The pasword to use to login to svn.
Quiet bool
Specifies whether to print as little information as possible. The default is false.
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

Ssh FileInfo
The executable to use for ssh communication.
SshEnv string
The name of the ssh/ rsh environment variable.
UserName string
The user performing the checkout.
VcsExeName string
The name of the executable.
VcsHomeEnv string
Name of the home environment variable.

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.