BisectCommand Class

Summary

This class implements the "hg bisect" command (): subdivision search of changesets.
Assembly
Mercurial.Net.dll
Namespace
Mercurial
Interfaces
Base Types
graph TD Base0["MercurialCommandBase<T>"]-->Type click Base0 "/Cake.Hg/api/Mercurial/MercurialCommandBase_1" Base1["CommandBase<T>"]-->Base0 click Base1 "/Cake.Hg/api/Mercurial/CommandBase_1" Base2["object"]-->Base1 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["BisectCommand"] class Type type-node

Syntax

public sealed class BisectCommand : MercurialCommandBase<BisectCommand>, 
    IMercurialCommand<BisectResult>, IMercurialCommand, ICommand

Remarks

The BisectCommand should be used by first updating the repository to a changeset where the current state is known to be bad or good, and then updated to another changeset were the current state is known to be the opposite of the previous changeset. Then the BisectCommand should be iteratively executed, analyzing the Result property each time.

When the BisectResult object in that property says Done = false, then the repository has been updated to a new changeset. The program should then analyze the changeset and determine if its state is good or bad, and issue another BisectCommand to that effect.

When the BisectResult says that Done = true, the Revision property contains the revspec of the first changeset that is deemed good or bad, depending on what you're looking for.

Constructors

Name Summary
BisectCommand() Initializes a new instance of the BisectCommand 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>
Arguments IEnumerable<T>
Gets all the arguments to the Command, or an empty array if there are none.
Inherited from CommandBase<T>
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>
Observer IMercurialCommandObserver
Gets or sets the object that will act as an observer of command execution.
Inherited from CommandBase<T>
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 BisectResult
Gets the result from the command line execution, as an appropriately typed value.
State BisectState
Gets or sets a value specifying how to proceed with the bisect command, by marking the current changeset good or bad.
TestCommand string
Gets or sets the command to execute from Mercurial in order to test each changeset, doing an automated search instead of one controlled by the program using Mercurial.Net.
Timeout int
Gets or sets the timeout to use when executing Mercurial commands, in seconds. Default is 60.
Inherited from CommandBase<T>
Update bool
Gets or sets a value indicating whether to update to target revision. Default value is true.

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.
Inherited from CommandBase<T>
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.
Inherited from CommandBase<T>
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>
WithConfigurationOverride(string, string, string) void
Adds a configuration override specification to the AdditionalArguments collection in the form of section.name=value.
WithObserver(IMercurialCommandObserver) T
Sets the Observer property to the specified value and returns this instance.
Inherited from CommandBase<T>
WithState(BisectState) BisectCommand
Sets the State property to the specified value and returns this BisectCommand instance.
WithTimeout(int) T
Sets the Timeout property to the specified value and returns this instance.
Inherited from CommandBase<T>
WithUpdate(bool) BisectCommand
Sets the Update property to the specified value and returns this BisectCommand instance.

Extension Methods

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