CommitCommand Class

Summary

This class implements the "hg commit" command (): commit the specified files or all outstanding changes.
Assembly
Mercurial.Net.dll
Namespace
Mercurial
Interfaces
Base Types
graph TD Base0["IncludeExcludeCommandBase<T>"]-->Type click Base0 "/Cake.Hg/api/Mercurial/IncludeExcludeCommandBase_1" Base1["MercurialCommandBase<T>"]-->Base0 click Base1 "/Cake.Hg/api/Mercurial/MercurialCommandBase_1" Base2["CommandBase<T>"]-->Base1 click Base2 "/Cake.Hg/api/Mercurial/CommandBase_1" Base3["object"]-->Base2 Interface0["IMercurialCommand<TResult>"]-.->Type click Interface0 "/Cake.Hg/api/Mercurial/IMercurialCommand_1" Interface1["IMercurialCommand"]-.->Type click Interface1 "/Cake.Hg/api/Mercurial/IMercurialCommand" Interface2["ICommand"]-.->Type click Interface2 "/Cake.Hg/api/Mercurial/ICommand" Type["CommitCommand"] class Type type-node

Syntax

public sealed class CommitCommand : IncludeExcludeCommandBase<CommitCommand>, 
    IMercurialCommand<RevSpec>, IMercurialCommand, ICommand

Constructors

Name Summary
CommitCommand() Initializes a new instance of the CommitCommand class.

Properties

Name Value Summary
AdditionalArguments Collection<T>
Gets the collection which additional arguments can be added into. This collection is exposed for extensions, so that they have a place to add all their extra arguments to the Mercurial command line client.
Inherited from CommandBase<T>
AddRemove bool
Gets or sets a value indicating whether to automatically add new files and remove missing files before committing. Default is false.
Arguments IEnumerable<T>
Gets all the arguments to the Command, or an empty array if there are none.
CloseBranch bool
Gets or sets a value indicating whether to mark a branch as closed, hiding it from the branch list. Default is false.
Command string
Gets the command to execute with the Mercurial command line client.
Inherited from CommandBase<T>
DebugOutput bool
Gets or sets a value indicating whether to enable debug output on the command. This should only be used by the command code itself, never by the user.
Inherited from CommandBase<T>
ExcludePatterns Collection<T>
Gets the collection of filename patterns to exclude for the command.
IncludePatterns Collection<T>
Gets the collection of filename patterns to include for the command.
Message string
Gets or sets the commit message to use when committing.
Observer IMercurialCommandObserver
Gets or sets the object that will act as an observer of command execution.
Inherited from CommandBase<T>
OverrideAuthor string
Gets or sets the username to use when committing; or System.String.Empty to use the username configured in the repository or by the current user. Default is System.String.Empty.
OverrideTimestamp Nullable<T>
Gets or sets the timestamp DateTime to use when committing; or null which means use the current date and time. Default is null.
Paths Collection<T>
Gets the collection of files to commit. If left empty, will commit all pending changes.
RawExitCode int
Gets the raw exit code from executing the command line client.
Inherited from CommandBase<T>
RawStandardErrorOutput string
Gets the raw standard error output from executing the command line client.
Inherited from CommandBase<T>
RawStandardOutput string
Gets the raw standard output from executing the command line client.
Inherited from CommandBase<T>
Result RevSpec
Gets or sets the result of executing the command as a RevSpec identifying the new changeset that was committed.
Timeout int
Gets or sets the timeout to use when executing Mercurial commands, in seconds. Default is 60.
Inherited from CommandBase<T>

Methods

Name Value Summary
AddArgument(string) void
Adds the specified argument to the AdditionalArguments collection, unless it is already present.
Inherited from CommandBase<T>
After(int, string, string) void
This method is called after the command has been executed. You can use this to clean up after the command execution (like removing temporary files), and to react to the exit code from the command line client. If the exit code is considered a failure, this method should throw the correct exception.
Inherited from CommandBase<T>
Before() void
This method is called before the command is executed. You can use this to store temporary files (like a commit message or similar) that the Arguments refer to, before the command is executed.
Inherited from CommandBase<T>
Cleanup() void
Override this method to implement code that will execute after command line execution.
ParseStandardOutputForResults(int, string) void
This method should parse and store the appropriate execution result output according to the type of data the command line client would return for the command.
Prepare() void
Override this method to implement code that will execute before command line execution.
RequiresVersion(Version, string) void
This method will check the current client version and throw a System.NotSupportedException if the current client version is older than the required one.
ThrowOnUnsuccessfulExecution(int, string) void
This method should throw the appropriate exception depending on the contents of the exitCode and standardErrorOutput parameters, or simply return if the execution is considered successful.
Inherited from CommandBase<T>
Validate() void
Validates the command configuration. This method should throw the necessary exceptions to signal missing or incorrect configuration (like attempting to add files to the repository without specifying which files to add.)
WithAdditionalArgument(string) T
Adds the value to the AdditionalArguments collection property and returns this instance.
Inherited from CommandBase<T>
WithAddRemove(bool) CommitCommand
Sets the AddRemove property to the specified value and returns this CommitCommand instance.
WithCloseBranch(bool) CommitCommand
Sets the CloseBranch property to the specified value and returns this CommitCommand instance.
WithConfigurationOverride(string, string, string) void
Adds a configuration override specification to the AdditionalArguments collection in the form of section.name=value.
WithExcludePattern(string) T
Adds the value to the ExcludePatterns collection property and returns this instance.
WithIncludePattern(string) T
Adds the value to the IncludePatterns collection property and returns this instance.
WithMessage(string) CommitCommand
Sets the Message property to the specified value and returns this CommitCommand instance.
WithObserver(IMercurialCommandObserver) T
Sets the Observer property to the specified value and returns this instance.
Inherited from CommandBase<T>
WithOverrideAuthor(string) CommitCommand
Sets the OverrideAuthor property to the specified value and returns this CommitCommand instance.
WithOverrideTimestamp(DateTime) CommitCommand
Sets the OverrideTimestamp property to the specified value and returns this CommitCommand instance.
WithPath(string) CommitCommand
Adds the value to the Paths collection property and returns this ForgetCommand instance.
WithTimeout(int) T
Sets the Timeout property to the specified value and returns this instance.
Inherited from CommandBase<T>

Extension Methods

Name Value Summary
OperateOnPatchRepository<CommitCommand>() T
Makes the command operate on the patch repository instead of the main repository.