LogCommand Class

Summary

This class implements the "hg log" command (): show revision history of entire repository or files.
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["LogCommand"] class Type type-node

Syntax

public sealed class LogCommand : IncludeExcludeCommandBase<LogCommand>, 
    IMercurialCommand<IEnumerable<Changeset>>, IMercurialCommand, ICommand

Constructors

Name Summary
LogCommand() Initializes a new instance of the LogCommand 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.
Command string
Gets the command to execute with the Mercurial command line client.
Inherited from CommandBase<T>
Date Nullable<T>
Gets or sets the date to show the log for, or null if no filtering on date should be done. Default is null.
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.
FollowRenamesAndMoves bool
Gets or sets a value indicating whether to follow renames and copies when limiting the log. Default is false.
IncludeHiddenChangesets bool
Gets or sets a value indicating whether to include hidden changesets. Default is false.
IncludePathActions bool
Gets or sets a value indicating whether to include path actions (which files were modified, and the type of modification) or not. Default is false.
IncludePatterns Collection<T>
Gets the collection of filename patterns to include for the command.
Keywords Collection<T>
Gets the collection of case-insensitive keywords to search the log for. Default is empty which indicates no searching will be done.
Observer IMercurialCommandObserver
Gets or sets the object that will act as an observer of command execution.
Inherited from CommandBase<T>
OnlyFollowFirstParent bool
Gets or sets a value indicating whether to only follow the first parent of merge changesets. Default value is false.
Path string
Gets or sets the path to produce the log for, or System.String.Empty to produce the log for the repository. Default is System.String.Empty.
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 IEnumerable<T>
Gets the result of executing the command as a collection of Changeset objects.
Revisions Collection<T>
Gets the collection of Revisions to process/include.
Timeout int
Gets or sets the timeout to use when executing Mercurial commands, in seconds. Default is 60.
Inherited from CommandBase<T>
Users Collection<T>
Gets the collection of users to produce the log for, or an empty collection to produce the log for the repository. Default is an empty collection.

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
Parses the standard output for results.
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.)
Inherited from CommandBase<T>
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.
WithDate(DateTime) LogCommand
Sets the Date property to the specified value and returns this LogCommand instance.
WithExcludePattern(string) T
Adds the value to the ExcludePatterns collection property and returns this instance.
WithFollowRenamesAndMoves(bool) LogCommand
Sets the FollowRenamesAndMoves property to the specified value and returns this LogCommand instance.
WithIncludeHiddenChangesets(bool) LogCommand
Sets the IncludeHiddenChangesets property to the specified value and returns this LogCommand instance.
WithIncludePathActions(bool) LogCommand
Sets the IncludePathActions property to the specified value and returns this LogCommand instance.
WithIncludePattern(string) T
Adds the value to the IncludePatterns collection property and returns this instance.
WithKeyword(string) LogCommand
Adds the value to the Keywords collection property and returns this LogCommand instance.
WithObserver(IMercurialCommandObserver) T
Sets the Observer property to the specified value and returns this instance.
Inherited from CommandBase<T>
WithOnlyFollowFirstParent(bool) LogCommand
Sets the OnlyFollowFirstParent property to the specified value and returns this LogCommand instance.
WithPath(string) LogCommand
Sets the Path property to the specified value and returns this LogCommand instance.
WithRevision(RevSpec) LogCommand
Adds the value to the Revisions collection property and returns this LogCommand instance.
WithTimeout(int) T
Sets the Timeout property to the specified value and returns this instance.
Inherited from CommandBase<T>
WithUser(string) LogCommand
Sets the Users property to the specified value and returns this LogCommand instance.

Extension Methods

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