Differences between revisions 1 and 167 (spanning 166 versions)

Using Mercurial extensions

(Translations: French)

Mercurial is designed to offer an small and easy to use command set. With it's powerful extension mechanism it offers a flexible way to add new commands for more advanced uses. Extensions allow the creation of new features and using them directly from the main hg command line as if they were builtin commands.

See also "hg help extensions" (in Mercurial 1.3+) for more information about extensions.

See CategoryExtension for pages in the extension category and WritingExtensions for more information about the installation and writing of new extensions.

Contents

Enabling an extension
Extensions Bundled with Mercurial
Extensions provided by others
See also

1. Enabling an extension

To enable the "foo" extension, either shipped with Mercurial or in the Python search path, create an entry for it in your hgrc, like this:

[extensions]
foo =

You may also specify the full path to an extension:

[extensions]
myfeature = ~/.hgext/myfeature.py

To explicitly disable an extension enabled in an hgrc of broader scope, prepend its path with !:

[extensions]
# disabling extension bar residing in /path/to/extension/bar.py
hgext.bar = !/path/to/extension/bar.py
# ditto, but no path was supplied for extension baz
hgext.baz = !

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

2. Extensions Bundled with Mercurial

Name	Page	Description
acl	AclExtension	Manage commit access to parts of a repo using control lists
alias	AliasExtension	User-defined command aliases (built-in since Mercurial 1.3)
bisect	BisectExtension	Quickly find the revision that introduces a bug or feature bisecting the history tree (O(log(n)) (built-in since Mercurial 1.0)
bookmarks	BookmarksExtension	Markers on commits that move on commit
bugzilla	BugzillaExtension	Update Bugzilla entries when a bug id is referenced in a changeset
children	ChildrenExtension	Display children revisions
churn	ChurnExtension	Show change statistics for mercurial operations per author
convert	ConvertExtension	Convert repositories from other SCMs into Mercurial
color	ColorExtension	Color output for the diff, status and qseries commands
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
hgcia	HgciaExtension	Send notifications to CIA
hgk	HgkExtension	Graphical repository and history browser based on gitk
highlight	HighlightExtension	Highlight syntax in the file revision view of hgweb
imerge	ImergeExtension	Perform interactive, interruptible merges
inotify	InotifyExtension	Use linux 2.6 inotify API for instantaneous status updates
interhg	InterhgExtension	This extension allows you to change changelog and summary text just like InterWiki way
keyword	KeywordExtension	Use CVS like keyword expansion in tracked files
mq	MqExtension	Mercurial Patch Queues - manage changes as series of patches
notify	NotifyExtension	Send email to subscribed addresses to notify repository changes
pager	PagerExtension	Allows you to choose a pager
parentrevspec	ParentrevspecExtension	Use `foo^` to refer to the parent of revision `foo`
patchbomb	PatchbombExtension	Send a collection of changesets as a series of patch emails
purge	PurgeExtension	Purge all files and dirs in the repository that are not being tracked by Mercurial
rebase	RebaseExtension	Move revisions from a point to another
record	RecordExtension	Select working directory changes to commit by hunk à la darcs record
share	ShareExtension	Share repository history between multiple repos
transplant	TransplantExtension	Cherry-picking, rebasing and changeset rewriting
win32mbcs	Win32mbcsExtension	Allow to use shift_jis/big5 filenames on Windows.
win32text	Win32TextExtension	Manage line ending conversion for Windows repositories
zeroconf	ZeroconfExtension	Announce and browser respositories via zeroconf/bonjour

3. Extensions provided by others

Name	Page	Description
activity	ActivityExtension	Create an image representing the activity of the repository
attic	AtticExtension	Easily deal with individual patches
autopager	AutopagerExtension	Invoke pager when output is longer than one screen
bfiles	BfilesExtension	Handle large binary files
bigfiles	BigfilesExtension	Support versions of big files with storage outside hg repo
boundmode	BoundModeExtension	Enables a bound mode (commit command auto-pushes)
branchhead	BranchHeadExtension	Show head(s) of the branch the working directory or given revision is on
casefold	CaseFoldExtension	Successful unjams case-folding conflicts
casestop	CasestopExtension	Stops case-folding conflicts on commit
changelog	ChangelogExtension	Auto-generate commit message from changelog entry
chart	ChartExtension	Display activity graphs (see also ActivityExtension and ChurnExtension)
cifiles	CifilesExtension	Print the names of all checked-in files
commits	CommitsExtension	Commit modified files as multiple changesets at once
compass	CompassExtension	Find your way in repositories with multiple heads, branches and bookmarks.
collapse	CollapseExtension	Collapse consecutive changesets into one
config	ConfigExtensionCommandLine	Manage config files via command line only
config	ConfigExtension	Manage hgrc files via dialogs and command line
crecord	CrecordExtension	Select graphically which files/hunk/lines to commit
cutehg	CuteHgExtension	A growing set of easy to install and use dialogs for mercurial commands
cvscommit	CvscommitExtension	Push changesets to CVS
defpasswd	DefpasswdExtension	Automatically provide credentials (username/passwords) read from a file.
deps	DepsExtension	Create and manage versioned repository dependencies
digest	DigestExtension	Create and use small digest files for outgoing/bundle
diffstat	DiffstatExtension	Shortcut commands for displaying diffstat
dotlog	DotLogExtension	Yet Another DOT grapher
easycommit	EasycommitExtension	Command-line GUI for committing changes
easymerge	EasymergeExtension	Command-line GUI for merging
fastimport	FastImportExtension	Read a git "fast import" stream and turn it into changesets in a Mercurial repository
filereview	FileReviewExtension	Perform code review for any project using mercurial
fixcase	FixcaseExtension	Fix problems where an external tool has changed the case of a filename
fixutf8	FixUtf8Extension	Fix problems on non-utf8 systems with filenames (Windows never supports utf8 filenames)
foreign	ForeignExtension	Interactively register or delete foreign/unknown files
forest	ForestExtension	Manage a bunch of mercurial repos as a meta repository, with snapshot support thread
ftp	FTPExtension	Manage uploaded snapshots on FTP server
graphviz	GraphvizExtension	Generate DOT language source to visualize changeset tree
group	GroupExtension	Allow to visually regroup a set of changesets
hg-git	HgGit	Push to and pull from a Git server
hgsubversion	HgSubversion	Use Mercurial as a Subversion client
hgtrac	HgTracExtension	Mercurial/Trac Integration Hook (pre/post hooks for Trac/Mercurial)
histedit	HisteditExtension	Edit, fold, drop changesets in the style of `git rebase --interactive`
histpush	HistpushExtension	Record locally which revisions have been pushed
info	InfoExtension	Display basic information about a repository
kerberos	KerberosExtension	Kerberos Authentication over HTTP support
localbranch	LocalbranchExtension	Create clones inside your working directory
makewritable	MakewritableExtension	Interactively removes read-only flags from files
message	MessageExtension	Preset the message used for commit
mbox	MboxExtension	Import patches from unix mailboxes in MQ
nearest	NearestExtension	Display the nearest tag from a given changeset
pbranch	PatchBranchExtension	Collaborative and/or long-term patch development and maintenance
prompt	PromptExtension	Put information about the current repository into a shell prompt
publishall	PublishAllExtension	Publish to all your set repositories (ie: paths)
reviewboard	ReviewboardExtension	Post changesets for review to a Review Board server
qct	QctExtension	Provide access to the Qct commit tool
qtimes	QtimesExtension	Save or restore modification times of files affected by patch queue
qup	QupExtension	Move MQ patches to top of unapplied part of series
rcpath	RcpathExtension	Displays Mercurial configuration file paths and names
rdiff	RdiffExtension	Allow diff to work against remote repositories
reposettings	ReposettingsExtension	Allow repo specific configuration from central configuration files
schemes	SchemesExtension	Add shortcuts to urls as url schemes
send	SendExtension	Automatic send of bundle containing changesets missing on remote, like darcs send
sharedrepo	SharedRepoExtension	Let multiple working directories share the same repository
shelve	ShelveExtension	Interactively select changes to set aside
sonichg	SonicHgExtension	Record pushlog data, web interfaces to view pushlog & shortlog with slider, advanced search for pushlog, new file log page, full side-by-side diffs, regex filter, commit syntax warning and more!
tasks	TasksExtension	Manage tasks as collections of contiguous changesets
timestamp	TimestampExtension	Saves and restores file timestamps

4. See also

ExtensionHitlist

CategoryExtension

-  ⇤ ← Revision 1 as of 2006-12-10 23:00:42 → 
  Size: 277
  Editor: mpm
  Comment:
+   ← Revision 167 as of 2009-11-02 15:54:18 → ⇥
  Size: 11251
  Editor: DavidSoria
  Comment: Add additional explanation about the extension mechanism.
-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
+#pragma section-numbers 2
-Line 6:
+Line 3:
- See CategoryExtension for a more complete list.
+= Using Mercurial extensions =

''(Translations: [[FrenchUsingExtensions|French]])''

Mercurial is designed to offer an small and easy to use command set. With it's powerful extension mechanism it offers a flexible way to add new commands for more advanced uses.
Extensions allow the creation of new features and using them directly from the main hg command line as if they were builtin commands.

See also "`hg help extensions`" (in Mercurial 1.3+) for more information about extensions.

See CategoryExtension for pages in the extension category and WritingExtensions for more information about the installation and writing of new extensions.

<<TableOfContents>>

== Enabling an extension ==

To enable the "foo" extension, either shipped with Mercurial or in the Python search path, create an entry for it in your hgrc, like this:

{{{
[extensions]
foo =
}}}

You may also specify the full path to an extension:

{{{
[extensions]
myfeature = ~/.hgext/myfeature.py
}}}

To explicitly disable an extension enabled in an hgrc of broader scope, prepend its path with !:

{{{
[extensions]
# disabling extension bar residing in /path/to/extension/bar.py
hgext.bar = !/path/to/extension/bar.py
# ditto, but no path was supplied for extension baz
hgext.baz = !
}}}

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

== Extensions Bundled with Mercurial ==

||''Name'' ||''Page'' ||''Description'' ||
||'''acl''' ||AclExtension ||Manage commit access to parts of a repo using control lists ||
||'''alias''' ||AliasExtension ||User-defined command aliases ('''built-in since Mercurial 1.3''') ||
||'''bisect''' ||BisectExtension ||Quickly find the revision that introduces a bug or feature bisecting the history tree (O(log(n)) ('''built-in since Mercurial 1.0''') ||
||'''bookmarks''' ||BookmarksExtension ||Markers on commits that move on commit ||
||'''bugzilla''' ||BugzillaExtension ||Update Bugzilla entries when a bug id is referenced in a changeset ||
||'''children''' ||ChildrenExtension ||Display children revisions ||
||'''churn''' ||ChurnExtension ||Show change statistics for mercurial operations per author ||
||'''convert''' ||ConvertExtension ||Convert repositories from other SCMs into Mercurial ||
||'''color''' ||ColorExtension ||Color output for the diff, status and qseries commands ||
||'''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 ||
||'''hgcia''' ||HgciaExtension ||Send notifications to [[http://cia.navi.cx|CIA]] ||
||'''hgk''' ||HgkExtension ||Graphical repository and history browser based on gitk ||
||'''highlight''' ||HighlightExtension ||Highlight syntax in the file revision view of hgweb ||
||'''imerge''' ||ImergeExtension ||Perform interactive, interruptible merges ||
||'''inotify''' ||InotifyExtension ||Use linux 2.6 inotify API for instantaneous status updates ||
||'''interhg''' ||InterhgExtension ||This extension allows you to change changelog and summary text just like InterWiki way ||
||'''keyword''' ||KeywordExtension ||Use CVS like keyword expansion in tracked files ||
||'''mq''' ||MqExtension ||Mercurial Patch Queues - manage changes as series of patches ||
||'''notify''' ||NotifyExtension ||Send email to subscribed addresses to notify repository changes ||
||'''pager''' ||PagerExtension ||Allows you to choose a pager ||
||'''parentrevspec''' ||ParentrevspecExtension ||Use `foo^` to refer to the parent of revision `foo` ||
||'''patchbomb''' ||PatchbombExtension ||Send a collection of changesets as a series of patch emails ||
||'''purge''' ||PurgeExtension ||Purge all files and dirs in the repository that are not being tracked by Mercurial ||
||'''rebase''' ||RebaseExtension ||Move revisions from a point to another ||
||'''record''' ||RecordExtension ||Select working directory changes to commit by hunk à la darcs record ||
||'''share''' ||ShareExtension ||Share repository history between multiple repos ||
||'''transplant''' ||TransplantExtension ||Cherry-picking, rebasing and changeset rewriting ||
||'''win32mbcs''' ||Win32mbcsExtension ||Allow to use shift_jis/big5 filenames on Windows. ||
||'''win32text''' ||Win32TextExtension ||Manage line ending conversion for Windows repositories ||
||'''zeroconf''' ||ZeroconfExtension ||Announce and browser respositories via zeroconf/bonjour ||


== Extensions provided by others ==
||''Name'' ||''Page'' ||''Description'' ||
||'''activity''' ||ActivityExtension ||Create an image representing the activity of the repository ||
||'''attic''' ||AtticExtension ||Easily deal with individual patches ||
||'''autopager''' ||AutopagerExtension ||Invoke pager when output is longer than one screen ||
||'''bfiles''' || [[BfilesExtension]] || Handle large binary files ||
||'''bigfiles''' ||BigfilesExtension ||Support versions of big files with storage outside hg repo ||
||'''boundmode''' ||BoundModeExtension ||Enables a bound mode (commit command auto-pushes) ||
||'''branchhead''' ||BranchHeadExtension ||Show head(s) of the branch the working directory or given revision is on ||
||'''casefold''' || CaseFoldExtension || Successful unjams case-folding conflicts ||
||'''casestop''' ||CasestopExtension ||Stops case-folding conflicts on commit ||
||'''changelog''' ||ChangelogExtension ||Auto-generate commit message from changelog entry ||
||'''chart''' ||ChartExtension ||Display activity graphs (see also ActivityExtension and ChurnExtension) ||
||'''cifiles''' ||CifilesExtension ||Print the names of all checked-in files ||
||'''commits''' ||CommitsExtension ||Commit modified files as multiple changesets at once ||
||'''compass''' ||CompassExtension ||Find your way in repositories with multiple heads, branches and bookmarks. ||
||'''collapse''' ||CollapseExtension ||Collapse consecutive changesets into one ||
||'''config''' ||ConfigExtensionCommandLine ||Manage config files via command line only ||
||'''config''' ||ConfigExtension ||Manage hgrc files via dialogs and command line ||
||'''crecord''' ||CrecordExtension ||Select graphically which files/hunk/lines to commit ||
||'''cutehg''' ||CuteHgExtension ||A growing set of easy to install and use dialogs for mercurial commands ||
||'''cvscommit''' ||CvscommitExtension ||Push changesets to CVS ||
||'''defpasswd''' ||DefpasswdExtension ||Automatically provide credentials (username/passwords) read from a file. ||
||'''deps''' ||DepsExtension ||Create and manage versioned repository dependencies ||
||'''digest''' ||DigestExtension ||Create and use small digest files for outgoing/bundle ||
||'''diffstat''' ||DiffstatExtension ||Shortcut commands for displaying diffstat ||
||'''dotlog''' ||DotLogExtension ||Yet Another DOT grapher ||
||'''easycommit''' ||EasycommitExtension ||Command-line GUI for committing changes ||
||'''easymerge''' ||EasymergeExtension ||Command-line GUI for merging ||
||'''fastimport''' ||FastImportExtension ||Read a git "fast import" stream and turn it into changesets in a Mercurial repository ||
||'''filereview''' ||FileReviewExtension||Perform code review for any project using mercurial ||
||'''fixcase''' ||FixcaseExtension ||Fix problems where an external tool has changed the case of a filename ||
||'''fixutf8''' ||FixUtf8Extension ||Fix problems on non-utf8 systems with filenames (Windows never supports utf8 filenames) ||
||'''foreign''' ||ForeignExtension ||Interactively register or delete foreign/unknown files ||
||'''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]] ||
||'''ftp''' ||[[FTPExtension]] ||Manage uploaded snapshots on FTP server ||
||'''graphviz''' ||GraphvizExtension ||Generate DOT language source to visualize changeset tree ||
||'''group''' ||GroupExtension ||Allow to ''visually'' regroup a set of changesets ||
||'''hg-git''' ||HgGit ||Push to and pull from a [[http://git-scm.com/|Git]] server ||
||'''hgsubversion''' ||HgSubversion ||Use Mercurial as a [[http://subversion.tigris.org/|Subversion]] client ||
||'''hgtrac''' ||HgTracExtension ||Mercurial/Trac Integration Hook (pre/post hooks for Trac/Mercurial) ||
||'''histedit''' ||HisteditExtension ||Edit, fold, drop changesets in the style of {{{git rebase --interactive}}} ||
||'''histpush''' ||HistpushExtension ||Record locally which revisions have been pushed ||
||'''info''' ||InfoExtension ||Display basic information about a repository ||
||'''kerberos''' ||KerberosExtension ||Kerberos Authentication over HTTP support ||
||'''localbranch''' ||LocalbranchExtension ||Create clones inside your working directory ||
||'''makewritable''' ||MakewritableExtension ||Interactively removes read-only flags from files ||
||'''message''' ||MessageExtension||Preset the message used for commit ||
||'''mbox''' ||MboxExtension ||Import patches from unix mailboxes in MQ ||
||'''nearest''' ||NearestExtension ||Display the nearest tag from a given changeset ||
||'''pbranch''' ||PatchBranchExtension ||Collaborative and/or long-term patch development and maintenance ||
||'''prompt''' ||PromptExtension ||Put information about the current repository into a shell prompt ||
||'''publishall''' ||PublishAllExtension ||Publish to all your set repositories (ie: paths)||
||'''reviewboard''' ||ReviewboardExtension ||Post changesets for review to a [[http://www.review-board.org/|Review Board]] server ||
||'''qct''' ||QctExtension ||Provide access to the Qct commit tool ||
||'''qtimes''' ||QtimesExtension ||Save or restore modification times of files affected by patch queue ||
||'''qup''' ||QupExtension ||Move MQ patches to top of unapplied part of series ||
||'''rcpath''' ||RcpathExtension ||Displays Mercurial configuration file paths and names ||
||'''rdiff''' ||RdiffExtension ||Allow diff to work against remote repositories ||
||'''reposettings''' ||ReposettingsExtension ||Allow repo specific configuration from central configuration files ||
||'''schemes''' ||SchemesExtension ||Add shortcuts to urls as url schemes ||
||'''send''' ||SendExtension ||Automatic send of bundle containing changesets missing on remote, like darcs send ||
||'''sharedrepo''' ||SharedRepoExtension ||Let multiple working directories share the same repository ||
||'''shelve''' ||ShelveExtension ||Interactively select changes to set aside ||
||'''sonichg''' ||SonicHgExtension ||Record pushlog data, web interfaces to view pushlog & shortlog with slider, advanced search for pushlog, new file log page, full side-by-side diffs, regex filter, commit syntax warning and more! ||
||'''tasks''' ||TasksExtension ||Manage tasks as collections of contiguous changesets ||
||'''timestamp''' ||TimestampExtension ||Saves and restores file timestamps ||

== See also ==
 * ExtensionHitlist

----
CategoryExtension

Diff for "UsingExtensions"

Using Mercurial extensions

1. Enabling an extension

2. Extensions Bundled with Mercurial

3. Extensions provided by others

4. See also