Summary

A base class for creating tasks for executing CVS client commands on a CVS repository.

Assembly

NAnt.SourceControl.dll

Namespace

NAnt.SourceControl.Tasks

Interfaces

IConditional

Base Types

Derived Types

AbstractCvsTask

graph BT Type-->Base0["ExternalProgramBase"] click Base0 "/api/NAnt.Core.Tasks/ExternalProgramBase" Base0-->Base1["Task"] click Base1 "/api/NAnt.Core/Task" Base1-->Base2["Element"] click Base2 "/api/NAnt.Core/Element" Base2-->Base3["Object"] Type-.->Interface0["IConditional"] click Interface0 "/api/NAnt.Core/IConditional" Type["AbstractSourceControlTask"] class Type type-node Derived0["AbstractCvsTask"]-->Type click Derived0 "/api/NAnt.SourceControl.Tasks/AbstractCvsTask"

Syntax

public abstract class AbstractSourceControlTask : ExternalProgramBase, IConditional

Constructors

Name	Summary
AbstractSourceControlTask()	Initializes a new instance of the `NAnt.SourceControl.Tasks.AbstractCvsTask` class.

Fields

Name	Constant Value	Summary
AppData	APPDATA	Used on windows to specify the location of application data. static
CvsPassFileVariable	CVS_PASSFILE	The environment variable that holds the location of the .cvspass file. static
EnvHome	HOME	Name of the environmental variable specifying a users' home in a nix environment. static*
PathVariable	PATH	The environment variable that holds path information. static
PropExeName	sourcecontrol.exename	Property name used to specify the source control executable. This is used as a readonly property. static
UnknownExitCode	-1000	Defines the exit code that will be returned by `NAnt.Core.Tasks.ExternalProgramBase.ExitCode` if the process could not be started, or did not exit (in time). Inherited from ExternalProgramBase static

Properties

Name Value Summary

Arguments

ArgumentCollection

The command-line arguments for the external program.

Inherited from ExternalProgramBase

BaseDirectory

DirectoryInfo

Gets the working directory for the application.

Inherited from ExternalProgramBase

CommandLine

string

Gets the command-line arguments, separated by spaces.

Inherited from ExternalProgramBase

CommandLineArguments

string

Command-line arguments for the program. The command line arguments are used to specify any cvs command options that are not available as attributes. These are appended after the command itself and are additive to whatever attributes are currently specified.

CommandName

string

The name of the command that is going to be executed.

CommandOptions

Hashtable

A collection of options that can be used to modify the default behavior of the version control commands. See the sub-tasks for implementation specifics.

CustomXmlProcessing

bool

Gets a value indicating whether the element is performing additional processing using the NAnt.Core.Element.XmlNode that was used to initialize the element.

Inherited from Element

DestinationDirectory

DirectoryInfo

Destination directory for the local sandbox. If destination is not specified then the current directory is used.

ErrorWriter

TextWriter

Gets or sets the System.IO.TextWriter to which error output of the external program will be written.

Inherited from ExternalProgramBase

ExeName

string

The name of the version control system executable.

ExitCode

int

Gets the value that the process specified when it terminated.

Inherited from ExternalProgramBase

FailOnError

bool

Determines if task failure stops the build, or is just reported. The default is true.

Inherited from Task

GlobalOptions

Hashtable

Holds a collection of globally available options.

IfDefined

bool

If true then the task will be executed; otherwise, skipped. The default is true.

Inherited from Task

Location

Gets or sets the location in the build file where the element is defined.

Inherited from Element

LogPrefix

string

The prefix used when sending messages to the log.

Inherited from Task

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.

Inherited from ExternalProgramBase

Name

string

The name of the task.

Inherited from Task

NamespaceManager

XmlNamespaceManager

Gets or sets the System.Xml.XmlNamespaceManager.

Inherited from Element

Output

FileInfo

Gets the file to which the standard output should be redirected.

Inherited from ExternalProgramBase

OutputAppend

bool

Gets a value indicating whether output will be appended to the NAnt.Core.Tasks.ExternalProgramBase.Output.

Inherited from ExternalProgramBase

OutputWriter

TextWriter

Gets or sets the System.IO.TextWriter to which standard output messages of the external program will be written.

Inherited from ExternalProgramBase

Parent

Object

Gets or sets the parent of the element.

Inherited from Element

PassFile

FileInfo

The full path to the cached password file. If not specified then the environment variables are used to try and locate the file.

PassFileName

string

The name of the passfile, overridden for each version control system (VCS).

Password

string

The password for logging in to the repository.

ProcessId

int

Gets the unique identifier for the spawned application.

Inherited from ExternalProgramBase

ProgramArguments

string

Get the command line arguments for the task.

ProgramFileName

string

Gets the filename of the external program to start.

Inherited from ExternalProgramBase

Project

Gets or sets the NAnt.Core.Element.Project to which this element belongs.

Inherited from Element

Properties

PropertyDictionary

Gets the properties local to this NAnt.Core.Element and the NAnt.Core.Element.Project.

Inherited from Element

Root

string

The root variable contains information on how to locate a repository. Although this information is in different formats it typically must define the following:

server locationprotocol used to communicate with the repositoryrepository location on the serverproject location in the repository

Spawn

bool

Gets or sets a value indicating whether the application should be spawned. If you spawn an application, its output will not be logged by NAnt. The default is false.

Inherited from ExternalProgramBase

Ssh

FileInfo

The executable to use for ssh communication.

SshEnv

string

The environment name for the ssh variable.

Threshold

Level

Gets or sets the log threshold for this NAnt.Core.Task. By default the threshold of a task is NAnt.Core.Level.Debug, causing no messages to be filtered in the task itself.

Inherited from Task

TimeOut

int

The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out.

Inherited from ExternalProgramBase

UnlessDefined

bool

Opposite of NAnt.Core.Task.IfDefined. If false then the task will be executed; otherwise, skipped. The default is false.

Inherited from Task

UseRuntimeEngine

bool

Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is false.

Inherited from ExternalProgramBase

VcsExeName

string

The name of the version control system (VCS) executable file.

VcsFileSet

FileSet

Used to specify the version control system (VCS) files that are going to be acted on.

VcsHome

DirectoryInfo

The path to the specific home directory of the version control system, this can be where the binary files are kept, or other app information.

VcsHomeEnv

string

The environment variable that defines where the version control system (VCS) home variable is kept.

Verbose

bool

Determines whether the task should report detailed build log messages. The default is false.

Inherited from Task

XmlNode

Gets or sets the XML node of the element.

Inherited from Element

Methods

Name	Value	Summary
AppendFiles()	void	Append the files specified in the fileset to the command line argument. Files are changed to use a relative path from the working directory that the task is spawned in.
CopyTo(Element)	void	Copies all instance data of the `NAnt.Core.Element` to a given `NAnt.Core.Element`. Inherited from Element
DeriveVcsFromEnvironment()	FileInfo	Derive the location of the version control system from the environment variable `PATH` .
Execute()	void	Executes the task unless it is skipped. Inherited from Task
ExecuteTask()	void	Starts the external process and captures its output. Inherited from ExternalProgramBase
GetAttributeConfigurationNode(FrameworkInfo, string)	XmlNode	Locates the XML node for the specified attribute in either the configuration section of the extension assembly or the.project. Inherited from Task
GetAttributeConfigurationNode(XmlNode, FrameworkInfo, string)	XmlNode	Inherited from Element
GetLocation()	Location	Retrieves the location in the build file where the element is defined. Inherited from Element
Initialize()	void	Initializes the task. Inherited from Task
Initialize(XmlNode)	void	Performs default initialization. Inherited from Element
InitializeBuildElement(Element, XmlNode, Element, Type)	Element	Initializes the build element. Inherited from Element static
InitializeElement(XmlNode)	void	Derived classes should override to this method to provide extra initialization and validation not covered by the base class. Inherited from Element
InitializeTask(XmlNode)	void	Initializes the task. Inherited from Task
InitializeTaskConfiguration()	void	Initializes the configuration of the task using configuration settings retrieved from the NAnt configuration file. Inherited from Task
InitializeXml(XmlNode, PropertyDictionary, FrameworkInfo)	void	Initializes all build attributes and child elements. Inherited from Element
IsLogEnabledFor(Level)	bool	Determines whether build output is enabled for the given `NAnt.Core.Level`. Inherited from Task
Log(Level, string)	void	Logs a message with the given priority. Inherited from Task
Log(Level, string, Object[])	void	Logs a formatted message with the given priority. Inherited from Task
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.
SetCommandOption(string, string, bool)	void	Adds a new command option if none exists. If one does exist then the use switch is toggled on or of.
SetEnvironment(Process)	void	Set up the environment variables for a process.
SetGlobalOption(string, string, bool)	void	Adds a new global option if none exists. If one does exist then the use switch is toggled on or of.
StartProcess()	Process	Starts the process and handles errors. Inherited from ExternalProgramBase

AbstractSourceControlTask Class

Summary

Syntax

Constructors

Fields

Properties

Methods