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
- Base Types
- Derived Types
graph BT
Type-->Base0["AbstractSourceControlTask"]
click Base0 "/api/NAnt.SourceControl.Tasks/AbstractSourceControlTask"
Base0-->Base1["ExternalProgramBase"]
click Base1 "/api/NAnt.Core.Tasks/ExternalProgramBase"
Base1-->Base2["Task"]
click Base2 "/api/NAnt.Core/Task"
Base2-->Base3["Element"]
click Base3 "/api/NAnt.Core/Element"
Base3-->Base4["Object"]
Type-.->Interface0["IConditional"]
click Interface0 "/api/NAnt.Core/IConditional"
Type["AbstractCvsTask"]
class Type type-node
Derived0["ChangeLogTask"]-->Type
click Derived0 "/api/NAnt.SourceControl.Tasks/ChangeLogTask"
Derived1["TagTask"]-->Type
click Derived1 "/api/NAnt.SourceControl.Tasks/TagTask"
Derived2["RTagTask"]-->Type
click Derived2 "/api/NAnt.SourceControl.Tasks/RTagTask"
Derived3["UpdateTask"]-->Type
click Derived3 "/api/NAnt.SourceControl.Tasks/UpdateTask"
Derived4["CvsTask"]-->Type
click Derived4 "/api/NAnt.SourceControl.Tasks/CvsTask"
Derived5["ExportTask"]-->Type
click Derived5 "/api/NAnt.SourceControl.Tasks/ExportTask"
Derived6["CheckoutTask"]-->Type
click Derived6 "/api/NAnt.SourceControl.Tasks/CheckoutTask"
Syntax
public abstract class AbstractCvsTask : AbstractSourceControlTask, IConditionalConstructors
| Name | Summary |
|---|---|
| AbstractCvsTask |
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.
Inherited from Abstract
static
|
| CvsExe | cvs.exe |
The name of the cvs executable.
static
|
| CvsHome | CVS_HOME |
An environment variable that holds path information about where
cvs is located.
static
|
| CvsPassfile | .cvspass |
Name of the password file that cvs stores pserver
cvsroot/ password pairings.
static
|
| CvsPassFileVariable | CVS_PASSFILE |
The environment variable that holds the location of the
.cvspass file.
Inherited from Abstract
static
|
| CvsRsh | CVS_RSH |
Environment variable that holds the executable name that is used for
ssh communication.
static
|
| Default |
3 |
The default compression level to use for cvs commands.
static
|
| DefaultQuiet | False |
Default value for the quiet command.
static
|
| DefaultReallyQuiet | False |
Default value for the really quiet command.
static
|
| DefaultRecursive | False |
Default value for the recursive directive. The default is
false.
static
|
| Default |
True |
The default use of binaries, defaults to use sharpcvs.
static
|
| EnvHome | HOME |
Name of the environmental variable specifying a users' home
in a *nix environment.
Inherited from Abstract
static
|
| PathVariable | PATH |
The environment variable that holds path information.
Inherited from Abstract
static
|
| PropExeName | sourcecontrol.exename |
Property name used to specify the source control executable. This is
used as a readonly property.
Inherited from Abstract
static
|
| SharpCvsExe | scvs.exe |
The temporary name of the sharpcvslib binary file, to avoid
conflicts in the path variable.
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
|
| UseSharpCvsLibProp | sourcecontrol.usesharpcvslib |
Property name used to specify on a project level whether sharpcvs is
used or not.
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.
Inherited from Abstract
|
| CommandName | string |
The name of the command that is going to be executed.
Inherited from Abstract
|
| 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.
Inherited from Abstract
|
| CompressionLevel | int |
Compression level to use for all net traffic. This should be a value from 1-9.
|
| 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
|
| CvsFileSet | CvsFileSet |
Used to specify the version control system (VCS) files that are going
to be acted on.
|
| CvsFullPath | FileInfo |
The full path to the cvs binary used. The cvs tasks will attempt to
"guess" the location of your cvs binary based on your path. If the
task is unable to resolve the location, or resolves it incorrectly
this can be used to manually specify the path.
|
| DestinationDirectory | DirectoryInfo |
Destination directory for the local sandbox. If destination is not specified
then the current directory is used.
Inherited from Abstract
|
| 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 cvs 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.
Inherited from Abstract
|
| IfDefined | bool |
If
true then the task will be executed; otherwise,
skipped. The default is true.
Inherited from Task
|
| IsModuleNeeded | bool |
Specify if the module is needed for this cvs command. It is
only needed if there is no module information on the local file
system.
|
| Location | 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
|
| Module | string |
The module to perform an operation on.
|
| 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.
Inherited from Abstract
|
| PassFileName | string |
The name of the pass file, or
.cvspass at the time
of this writing.
|
| Password | string |
The password for logging in to the repository.
Inherited from Abstract
|
| ProcessId | int |
Gets the unique identifier for the spawned application.
Inherited from ExternalProgramBase
|
| ProgramArguments | string |
Get the command line arguments for the task.
Inherited from Abstract
|
| ProgramFileName | string |
Gets the filename of the external program to start.
Inherited from ExternalProgramBase
|
| Project | 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
|
| Quiet | bool |
Indicates if the output from the cvs command should be suppressed.
The default is
false.
|
| ReadOnly | bool |
true if the sandbox files should be checked out in
read only mode. The default is false.
|
| ReadWrite | bool |
true if the sandbox files should be checked out in
read/write mode. The default is true.
|
| ReallyQuiet | bool |
Indicates if the output from the cvs command should be stopped.
The default is
false.
|
| Root | string |
The cvs root variable has the following components:
|
| 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
|
| UseSharpCvsLib | bool |
You may also specify an override value for all cvs tasks instead
of specifying a value for each. To do this set the property
|
| VcsExeName | string |
The name of the cvs binary, or
cvs.exe at the time this
was written.
|
| VcsFileSet | FileSet |
Get the cvs file set.
|
| 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.
Inherited from Abstract
|
| VcsHomeEnv | string |
The name of the version control system specific home environment
variable.
|
| Verbose | bool |
Determines whether the task should report detailed build log messages.
The default is
false.
Inherited from Task
|
| XmlNode | XmlNode |
Gets or sets the XML node of the element.
Inherited from Element
|
Methods
| Name | Value | Summary |
|---|---|---|
| AddArg |
void |
Add the given argument to the command line options. Note that are not explicitly
quoted are split into separate arguments. This is to resolve a recent issue
with quoting command line arguments.
|
| 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.
Inherited from Abstract
|
| AppendSubCommandArgs |
void |
Override to append any commands before the modell and files.
|
| CopyTo |
void |
Copies all instance data of the
NAnt.Core.Element to a given
NAnt.Core.Element.
Inherited from Element
|
| Derive |
FileInfo |
Derive the location of the version control system from the environment
variable
Inherited from Abstract
|
| 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
|
| Get |
XmlNode |
Locates the XML node for the specified attribute in either the
configuration section of the extension assembly or the.project.
Inherited from Task
|
| Get |
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 |
void |
Performs default initialization.
Inherited from Element
|
| Initialize |
Element |
Initializes the build element.
Inherited from Element
static
|
| InitializeElement |
void |
Derived classes should override to this method to provide extra
initialization and validation not covered by the base class.
Inherited from Element
|
| InitializeTask |
void |
Initializes the task.
Inherited from Task
|
| Initialize |
void |
Initializes the configuration of the task using configuration
settings retrieved from the NAnt configuration file.
Inherited from Task
|
| InitializeXml |
void |
Initializes all build attributes and child elements.
Inherited from Element
|
| IsLogEnabledFor |
bool |
Determines whether build output is enabled for the given
NAnt.Core.Level.
Inherited from Task
|
| Log |
void |
Logs a message with the given priority.
Inherited from Task
|
| Log |
void |
Logs a formatted message with the given priority.
Inherited from Task
|
| PrepareProcess |
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 |
void |
Adds a new command option if none exists. If one does exist then
the use switch is toggled on or of.
Inherited from Abstract
|
| SetEnvironment |
void |
Set up the environment variables for a process.
Inherited from Abstract
|
| SetGlobalOption |
void |
Adds a new global option if none exists. If one does exist then
the use switch is toggled on or of.
Inherited from Abstract
|
| StartProcess |
Process |
Starts the process and handles errors.
Inherited from ExternalProgramBase
|
| ToCvsDateTimeString |
string |
Converts a date value to a string representation that can be
interpreted by cvs.
|