Summary

This MercurialHookBase descendant implements the code necessary to handle the "precommit" hook: This is run before starting a commit (note, the commit command has started executing, and can have addes files, etc. See the MercurialPreCommitCommandHook for a way to intercept the entire commit command.)

Assembly

Mercurial.Net.dll

Namespace

Mercurial.Hooks

Interfaces

IMercurialControllingHook

Base Types

graph TD Base0["MercurialControllingHookBase"]-->Type click Base0 "/Cake.Hg/api/Mercurial.Hooks/MercurialControllingHookBase" Base1["MercurialHookBase"]-->Base0 click Base1 "/Cake.Hg/api/Mercurial.Hooks/MercurialHookBase" Base2["object"]-->Base1 Interface0["IMercurialControllingHook"]-.->Type click Interface0 "/Cake.Hg/api/Mercurial.Hooks/IMercurialControllingHook" Type["MercurialPreCommitHook"] class Type type-node

Syntax

public class MercurialPreCommitHook : MercurialControllingHookBase, IMercurialControllingHook

Remarks

As with all controlling hooks (descendants of MercurialControllingHookBase), you can prevent the command from continuing, or let it continue, by calling TerminateHookAndCancelCommand(int) or TerminateHookAndProceed() respectively.

Constructors

Name	Summary
MercurialPreCommitHook()

Properties

Name	Value	Summary
LeftParentRevision	RevSpec	Gets the `RevSpec` identifying the left parent of the changeset that was committed.
Repository	Repository	Gets the `Repository` the hook is executing in. Inherited from MercurialHookBase
RightParentRevision	RevSpec	Gets the `RevSpec` identifying the left parent of the changeset that was committed; or `null` if this is not a merge changeset.

Methods