PVCSPutTask Class

Summary

Puts files into a PVCS repository.
graph BT Type-->Base0["PVCSMultipleEntityTask"] click Base0 "/api/NAnt.Contrib.Tasks.PVCS/PVCSMultipleEntityTask" Base0-->Base1["PVCSProjectDatabaseTask"] click Base1 "/api/NAnt.Contrib.Tasks.PVCS/PVCSProjectDatabaseTask" Base1-->Base2["PVCSTask"] click Base2 "/api/NAnt.Contrib.Tasks.PVCS/PVCSTask" Base2-->Base3["ExternalProgramBase"] Type["PVCSPutTask"] class Type type-node

Syntax

[TaskName("pvcsput")]
public sealed class PVCSPutTask : PVCSMultipleEntityTask

Examples

Puts the file called App.ico into the project database specified by the project-database property. The description for the change is Added more colour.

    <pvcsput projectdatabase="${project-database}" description="Added more colour">
    <entities>
        <entity name="/App.ico"/>
    </entities>
</pvcsput>

Puts all files into the project database specified by the project-database property. The description for the changes is Major changes. Even if the workfiles have not been changed, they will result in a new revision in PVCS.

    <pvcsput projectdatabase="${project-database}" description="Major changes" checkinunchanged="true" includesubprojects="true">
    <entities>
        <entity name="/"/>
    </entities>
</pvcsput>

Puts file.txt and all files in folder into the project database specified by the project-database property. The description for the changes is Some changes. A new branch is forcibly created via the forcebranch attribute. Leading and trailing whitespace is ignored when determining whether the workfile has been altered.

    <pvcsput projectdatabase="${project-database}" description="Some changes" forcebranch="true" ignorespaces="true">
    <entities>
        <entity name="/folder"/>
        <entity name="/file.txt"/>
    </entities>
</pvcsput>

Remarks

This task uses the put PCLI command to put the files into PVCS.

Attributes

Type Description
TaskName

Constructors

Name Summary
PVCSPutTask() Constructs and initializes an instance of PVCSPut.

Properties

Name Value Summary
BaseProjectPath string
Gets or sets the base project path.
CheckInUnchanged bool
Gets or sets a value indicating whether unchanged workfiles should be checked in.
Description string
Gets or sets the description to be applied to the checked in revisions.
Entities EntitySet
Gets or sets the entities involved in the operation.
Inherited from PVCSMultipleEntityTask
ExeName string
Gets the executable name for the command-line tool to run for the PVCS task.
Inherited from PVCSTask
FloatLabel bool
Gets or sets a value indicating whether the version label specified by NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel should float.
ForceBranch bool
Gets or sets a value indicating whether a new branch will be created.
IgnoreSpaces bool
Gets or sets a value indicating whether leading and trailing spaces should be ignored when determining whether the revision has changed.
IncludeSubprojects bool
Gets or sets a value indicating whether the operation should include subprojects.
KeepWorkfile bool
Gets or sets a value indicating whether the workfile should kept in its original state.
Location string
Gets or sets an alternative location for workfiles.
Lock bool
Gets or sets a value indicating the files should be locked after the put operation.
OverrideWorkfileLocation bool
Gets or sets a value indicating whether the workfile location for files should be overridden.
Password string
Gets or sets the password to use when connecting to the project database.
PCLICommandName string
Gets the PCLI command name that corresponds to the operation the task performs.
Inherited from PVCSTask
ProgramArguments string
Gets the program arguments with which to run the wrapped PVCS process.
Inherited from PVCSTask
ProjectDatabase string
Gets or sets the project database to utilize during the operation.
ProjectPath string
Gets or sets the project path to utilize during the operation.
PromotionGroup string
Gets or sets the promotion in use. If a promotion group is specified, this option identifies the promotion group to which the revision is currently assigned. If no promotion group is specified (ie. this property is set to an empty string), this option indicates that one is not identifying the revision by promotion group.
PVCSBin string
Gets or sets the location of the PVCS binary command-line tools.
Inherited from PVCSTask
ReassignLabelIfExists bool
Gets or sets a value indicating whether the version label specified by NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel should be reassigned if it already exists.
Revision double
Gets or sets the revision number to use for the new revision.
SupportsIncludeSubprojects bool
Gets a value indicating whether the specific task implementation supports the includesubprojects task attribute. If not, an exception will be thrown if an attempt is made to set the attribute.
UserId string
Gets or sets the user ID to use when connecting to the project database.
UseSameDescription bool
Gets or sets a value indicating whether the same description should be used for all versioned items. This is true by default.
VersionLabel string
Gets or sets the version label to assign to the new revisions.
Workspace string
Gets or sets the workspace to use when connecting to the project database.

Methods

Name Value Summary
AddCommandLineArguments(PVCSCommandArgumentCollection) void
ExecuteTask() void
Executes the task.
Inherited from PVCSTask
PrepareProcess(Process) void
Prepares the process wrapped by this task for execution.
Inherited from PVCSTask
StartProcess() Process
Starts the process that is wrapped by this PVCS task.
Inherited from PVCSTask