Differences between revisions 68 and 69

Using Mercurial extensions

Mercurial features an extension mechanism for adding new commands.

Extensions allow the creation of new features and using them directly from the main hg command line as if they were builtin commands.

Finding existing extensions

Extensions Bundled with Mercurial

Core extensions

Name	Page	Description
acl	AclExtension	Manage commit access to parts of a repo using control lists
bisect	BisectExtension	Quickly find the revision that introduces a bug or feature bisecting the history tree (O(log(n))
bugzilla	BugzillaExtension	Update Bugzilla entries when a bug id is referenced in a changeset
convert	ConvertExtension	Convert repositories from other SCMs into Mercurial
extdiff	ExtdiffExtension	Compare changes using external programs
fetch	FetchExtension	Conveniently pull, merge and update in one step
gpg	GpgExtension	Sign changesets and check signatures using GPG
graphlog	GraphlogExtension	Show revision history alongside an ASCII revision graph
hgk	HgkExtension	Graphical repository and history browser based on gitk
mq	MqExtension	Mercurial Patch Queues - manage changes as series of patches
notify	NotifyExtension	Send email to subscribed addresses to notify repository changes
patchbomb	PatchbombExtension	Send a collection of changesets as a series of patch emails
record	RecordExtension	Select working directory changes to commit by hunk à la darcs record
transplant	TransplantExtension	Cherry-picking, rebasing and changeset rewriting
win32text	Win32Extension	Manage line ending conversion for Windows repositories

Additional extensions

Name	Page	Description
churn	ChurnExtension	Show change statistics for mercurial operations per author
purge	PurgeExtension	Purge all files and dirs in the repository that are not being tracked by Mercurial

Extensions provided by others

Name	Page	Description
alias	AliasExtension	user-defined command aliases
digest	DigestExtension	Create and use small digest files for outgoing/bundle
diffstat	DiffstatExtension	Shortcut commands for displaying diffstat
forest	ForestExtension	Manage a bunch of mercurial repos as a meta repository, with snapshot support [http://www.selenic.com/pipermail/mercurial/2006-July/009336.html thread]
hgcia	HgciaExtension	Send notifications to [http://cia.navi.cx CIA]
imerge	ImergeExtension	Perform interactive, interruptible merges
inotify	InotifyExtension	Use linux 2.6 inotify API for instantaneous status updates
localbranch	LocalbranchExtension	Create clones inside your working directory
keyword expansion	KeywordExpansionExtension	use CVS like keyword expansion in tracked files
parentrevspec	ParentrevspecExtension	use `foo^` to refer to the parent of revision `foo`
send	SendExtension	Automatic send of bundle containing changesets missing on remote, like darcs send
qct	QctExtension	provide access to the Qct commit tool
graphviz	GraphvizExtension	generate DOT language source to visualize changeset tree

Enabling an extension

To load an extension, you add it to the "extensions" section of your [http://www.selenic.com/mercurial/hgrc.5.html .hgrc] file.

Mercurial will scan the default python library path for a file named hgk.py if you set hgk empty:

[extensions]
hgk=

Extensions are usually located in the hgext directory, and that is the recommended directory to place them. In this case you can load them like:

[extensions]
hgext.hgk=

You can also specify an absolute path:

[extensions]
hgk=/usr/local/lib/hgk.py

Extensions can often be configured further in an extension specific section in the same configuration file.

See CategoryExtension for a more complete list and WritingExtensions for more information about the installation and writing of new extensions.

-  ⇤ ← Revision 68 as of 2007-08-26 05:52:41 → 
  Size: 329
  Editor: 220
  Comment:
+   ← Revision 69 as of 2007-08-26 06:34:49 → ⇥
  Size: 4546
  Editor: BrendanCully
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
- * UsingHgk - how to use the GUI repository browser
 * MqExtension - Mercurial Patch Queues
 * UsingBisect - how to use the bisect extension to find bugs
 * TransplantExtension - cherry-picks patches and rebases branches
+## page was renamed from Extensions
= Using Mercurial extensions =
Mercurial features an extension mechanism for adding new commands.
-Line 6:
+Line 5:
- See CategoryExtension for a more complete list and ExtensionHowto for a list of bundled extensions.
+Extensions allow the creation of new features and using them directly from the main hg command line as if they were builtin commands.

== Finding existing extensions ==

=== Extensions Bundled with Mercurial ===
==== Core extensions ====

|| ''Name''        || ''Page'' || ''Description'' ||
|| '''acl''' || AclExtension || Manage commit access to parts of a repo using control lists ||
|| '''bisect''' || BisectExtension  || Quickly find the revision that introduces a bug or feature bisecting the history tree (O(log(n)) ||
|| '''bugzilla''' || BugzillaExtension || Update Bugzilla entries when a bug id is referenced in a changeset ||
|| '''convert''' || ConvertExtension || Convert repositories from other SCMs into Mercurial ||
|| '''extdiff''' || ExtdiffExtension || Compare changes using external programs ||
|| '''fetch''' || FetchExtension || Conveniently pull, merge and update in one step ||
|| '''gpg''' || GpgExtension || Sign changesets and check signatures using GPG ||
|| '''graphlog''' || GraphlogExtension || Show revision history alongside an ASCII revision graph ||
|| '''hgk''' || HgkExtension || Graphical repository and history browser based on gitk ||
|| '''mq''' || MqExtension || Mercurial Patch Queues - manage changes as series of patches ||
|| '''notify''' || NotifyExtension || Send email to subscribed addresses to notify repository changes ||
|| '''patchbomb''' || PatchbombExtension || Send a collection of changesets as a series of patch emails ||
|| '''record''' || RecordExtension || Select working directory changes to commit by hunk à la darcs record ||
|| '''transplant''' || TransplantExtension || Cherry-picking, rebasing and changeset rewriting ||
|| '''win32text''' || Win32Extension || Manage line ending conversion for Windows repositories ||

==== Additional extensions ====

|| ''Name''        || ''Page'' || ''Description'' ||
|| '''churn''' || ChurnExtension || Show change statistics for mercurial operations per author ||
|| '''purge''' || PurgeExtension || Purge all files and dirs in the repository that are not being tracked by Mercurial ||

=== Extensions provided by others ===

|| ''Name''        || ''Page'' || ''Description'' ||
|| '''alias''' || AliasExtension || user-defined command aliases ||
|| '''digest''' || DigestExtension || Create and use small digest files for outgoing/bundle ||
|| '''diffstat''' || DiffstatExtension || Shortcut commands for displaying diffstat ||
|| '''forest''' || ForestExtension || Manage a bunch of mercurial repos as a meta repository, with snapshot support [http://www.selenic.com/pipermail/mercurial/2006-July/009336.html thread] ||
|| '''hgcia''' || HgciaExtension || Send notifications to [http://cia.navi.cx CIA] ||
|| '''imerge''' || ImergeExtension || Perform interactive, interruptible merges ||
|| '''inotify''' || InotifyExtension || Use linux 2.6 inotify API for instantaneous status updates ||
|| '''localbranch''' || LocalbranchExtension || Create clones inside your working directory ||
|| '''keyword expansion''' || KeywordExpansionExtension || use CVS like keyword expansion in tracked files ||
|| '''parentrevspec''' || ParentrevspecExtension || use `foo^` to refer to the parent of revision `foo` ||
|| '''send''' || SendExtension || Automatic send of bundle containing changesets missing on remote, like darcs send ||
|| '''qct''' || QctExtension || provide access to the Qct commit tool ||
|| '''graphviz''' || GraphvizExtension || generate DOT language source to visualize changeset tree ||


== Enabling an extension ==

To load an extension, you add it to the "extensions" section of your [http://www.selenic.com/mercurial/hgrc.5.html .hgrc] file.

Mercurial will scan the default python library path for a file named {{{hgk.py}}} if you set {{{hgk}}} empty:

{{{
[extensions]
hgk=
}}}

Extensions are usually located in the hgext directory, and that is the recommended directory to place them. In this case you can load them like:

{{{
[extensions]
hgext.hgk=
}}}

You can also specify an absolute path:

{{{
[extensions]
hgk=/usr/local/lib/hgk.py
}}}

Extensions can often be configured further in an extension specific section in the same configuration file.



See CategoryExtension for a more complete list and WritingExtensions for more information about the installation and writing of new extensions.

Diff for "UsingExtensions"