Путеводитель по Руководству Linux

  User  |  Syst  |  Libr  |  Device  |  Files  |  Other  |  Admin  |  Head  |



   hg    ( 1 )

система управления исходным кодом Mercurial (Mercurial source code management system)

Расширения (Extensions)

This section contains help for extensions that are distributed together with Mercurial. Help for other extensions is available in the help system.

acl hooks for controlling repository access

This hook makes it possible to allow or deny write access to given branches and paths of a repository when receiving incoming changesets via pretxnchangegroup and pretxncommit.

The authorization is matched based on the local user name on the system where the hook runs, and not the committer of the original changeset (since the latter is merely informative).

The acl hook is best used along with a restricted shell like hgsh, preventing authenticating users from doing anything other than pushing or pulling. The hook is not safe to use if users have interactive shell access, as they can then disable the hook. Nor is it safe if remote users share an account, because then there is no way to distinguish them.

The order in which access checks are performed is:

1. Deny list for branches (section acl.deny.branches)

2. Allow list for branches (section acl.allow.branches)

3. Deny list for paths (section acl.deny)

4. Allow list for paths (section acl.allow)

The allow and deny sections take key-value pairs.

Branch-based Access Control Use the acl.deny.branches and acl.allow.branches sections to have branch-based access control. Keys in these sections can be either:

• a branch name, or

• an asterisk, to match any branch;

The corresponding values can be either:

• a comma-separated list containing users and groups, or

• an asterisk, to match anyone;

You can add the "!" prefix to a user or group name to invert the sense of the match.

Path-based Access Control Use the acl.deny and acl.allow sections to have path-based access control. Keys in these sections accept a subtree pattern (with a glob syntax by default). The corresponding values follow the same syntax as the other sections above.

Groups Group names must be prefixed with an @ symbol. Specifying a group name has the same effect as specifying all the users in that group.

You can define group members in the acl.groups section. If a group name is not defined there, and Mercurial is running under a Unix-like system, the list of users will be taken from the OS. Otherwise, an exception will be raised.

Example Configuration [hooks]

# Use this if you want to check access restrictions at commit time pretxncommit.acl = python:hgext.acl.hook

# Use this if you want to check access restrictions for pull, push, # bundle and serve. pretxnchangegroup.acl = python:hgext.acl.hook

[acl] # Allow or deny access for incoming changes only if their source is # listed here, let them pass otherwise. Source is "serve" for all # remote access (http or ssh), "push", "pull" or "bundle" when the # related commands are run locally. # Default: serve sources = serve

[acl.deny.branches]

# Everyone is denied to the frozen branch: frozen-branch = *

# A bad user is denied on all branches: * = bad-user

[acl.allow.branches]

# A few users are allowed on branch-a: branch-a = user-1, user-2, user-3

# Only one user is allowed on branch-b: branch-b = user-1

# The super user is allowed on any branch: * = super-user

# Everyone is allowed on branch-for-tests: branch-for-tests = *

[acl.deny] # This list is checked first. If a match is found, acl.allow is not # checked. All users are granted access if acl.deny is not present. # Format for both lists: glob pattern = user, ..., @group, ...

# To match everyone, use an asterisk for the user: # my/glob/pattern = *

# user6 will not have write access to any file: ** = user6

# Group "hg-denied" will not have write access to any file: ** = @hg-denied

# Nobody will be able to change "DONT-TOUCH-THIS.txt", despite # everyone being able to change all other files. See below. src/main/resources/DONT-TOUCH-THIS.txt = *

[acl.allow] # if acl.allow is not present, all users are allowed by default # empty acl.allow = no users allowed

# User "doc_writer" has write access to any file under the "docs" # folder: docs/** = doc_writer

# User "jack" and group "designers" have write access to any file # under the "images" folder: images/** = jack, @designers

# Everyone (except for "user6" and "@hg-denied" - see acl.deny above) # will have write access to any file under the "resources" folder # (except for 1 file. See acl.deny): src/main/resources/** = *

.hgtags = release_engineer

Examples using the ! prefix Suppose there's a branch that only a given user (or group) should be able to push to, and you don't want to restrict access to any other branch that may be created.

The "!" prefix allows you to prevent anyone except a given user or group to push changesets in a given branch or path.

In the examples below, we will: 1) Deny access to branch "ring" to anyone but user "gollum" 2) Deny access to branch "lake" to anyone but members of the group "hobbit" 3) Deny access to a file to anyone but user "gollum"

[acl.allow.branches] # Empty

[acl.deny.branches]

# 1) only 'gollum' can commit to branch 'ring'; # 'gollum' and anyone else can still commit to any other branch. ring = !gollum

# 2) only members of the group 'hobbit' can commit to branch 'lake'; # 'hobbit' members and anyone else can still commit to any other branch. lake = !@hobbit

# You can also deny access based on file paths:

[acl.allow] # Empty

[acl.deny] # 3) only 'gollum' can change the file below; # 'gollum' and anyone else can still change any other file. /misty/mountains/cave/ring = !gollum

blackbox log repository events to a blackbox for debugging

Logs event information to .hg/blackbox.log to help debug and diagnose problems. The events that get logged can be configured via the blackbox.track config key. Examples:

[blackbox] track = *

[blackbox] track = command, commandfinish, commandexception, exthook, pythonhook

[blackbox] track = incoming

[blackbox] # limit the size of a log file maxsize = 1.5 MB # rotate up to N log files when the current one gets too big maxfiles = 3

Commands blackbox hg blackbox [OPTION]...

view the recent repository events

Options:

-l, --limit the number of events to show (default: 10)

bugzilla hooks for integrating with the Bugzilla bug tracker

This hook extension adds comments on bugs in Bugzilla when changesets that refer to bugs by Bugzilla ID are seen. The comment is formatted using the Mercurial template mechanism.

The bug references can optionally include an update for Bugzilla of the hours spent working on the bug. Bugs can also be marked fixed.

Three basic modes of access to Bugzilla are provided:

1. Access via the Bugzilla XMLRPC interface. Requires Bugzilla 3.4 or later.

2. Check data via the Bugzilla XMLRPC interface and submit bug change via email to Bugzilla email interface. Requires Bugzilla 3.4 or later.

3. Writing directly to the Bugzilla database. Only Bugzilla installations using MySQL are supported. Requires Python MySQLdb.

Writing directly to the database is susceptible to schema changes, and relies on a Bugzilla contrib script to send out bug change notification emails. This script runs as the user running Mercurial, must be run on the host with the Bugzilla install, and requires permission to read Bugzilla configuration details and the necessary MySQL user and password to have full access rights to the Bugzilla database. For these reasons this access mode is now considered deprecated, and will not be updated for new Bugzilla versions going forward. Only adding comments is supported in this access mode.

Access via XMLRPC needs a Bugzilla username and password to be specified in the configuration. Comments are added under that username. Since the configuration must be readable by all Mercurial users, it is recommended that the rights of that user are restricted in Bugzilla to the minimum necessary to add comments. Marking bugs fixed requires Bugzilla 4.0 and later.

Access via XMLRPC/email uses XMLRPC to query Bugzilla, but sends email to the Bugzilla email interface to submit comments to bugs. The From: address in the email is set to the email address of the Mercurial user, so the comment appears to come from the Mercurial user. In the event that the Mercurial user email is not recognized by Bugzilla as a Bugzilla user, the email associated with the Bugzilla username used to log into Bugzilla is used instead as the source of the comment. Marking bugs fixed works on all supported Bugzilla versions.

Configuration items common to all access modes:

bugzilla.version The access type to use. Values recognized are:

xmlrpc

Bugzilla XMLRPC interface.

xmlrpc+email

Bugzilla XMLRPC and email interfaces.

3.0

MySQL access, Bugzilla 3.0 and later.

2.18

MySQL access, Bugzilla 2.18 and up to but not including 3.0.

2.16

MySQL access, Bugzilla 2.16 and up to but not including 2.18.

bugzilla.regexp Regular expression to match bug IDs for update in changeset commit message. It must contain one "()" named group <ids> containing the bug IDs separated by non-digit characters. It may also contain a named group <hours> with a floating-point number giving the hours worked on the bug. If no named groups are present, the first "()" group is assumed to contain the bug IDs, and work time is not updated. The default expression matches Bug 1234, Bug no. 1234, Bug number 1234, Bugs 1234,5678, Bug 1234 and 5678 and variations thereof, followed by an hours number prefixed by h or hours, e.g. hours 1.5. Matching is case insensitive.

bugzilla.fixregexp Regular expression to match bug IDs for marking fixed in changeset commit message. This must contain a "()" named group <ids>` containing the bug IDs separated by non-digit characters. It may also contain a named group ``<hours> with a floating-point number giving the hours worked on the bug. If no named groups are present, the first "()" group is assumed to contain the bug IDs, and work time is not updated. The default expression matches Fixes 1234, Fixes bug 1234, Fixes bugs 1234,5678, Fixes 1234 and 5678 and variations thereof, followed by an hours number prefixed by h or hours, e.g. hours 1.5. Matching is case insensitive.

bugzilla.fixstatus The status to set a bug to when marking fixed. Default RESOLVED.

bugzilla.fixresolution The resolution to set a bug to when marking fixed. Default FIXED.

bugzilla.style The style file to use when formatting comments.

bugzilla.template Template to use when formatting comments. Overrides style if specified. In addition to the usual Mercurial keywords, the extension specifies:

{bug}

The Bugzilla bug ID.

{root}

The full pathname of the Mercurial repository.

{webroot}

Stripped pathname of the Mercurial repository.

{hgweb}

Base URL for browsing Mercurial repositories.

Default changeset {node|short} in repo {root} refers to bug {bug}.\ndetails:\n\t{desc|tabindent}

bugzilla.strip The number of path separator characters to strip from the front of the Mercurial repository path ({root} in templates) to produce {webroot}. For example, a repository with {root} /var/local/my-project with a strip of 2 gives a value for {webroot} of my-project. Default 0.

web.baseurl Base URL for browsing Mercurial repositories. Referenced from templates as {hgweb}.

Configuration items common to XMLRPC+email and MySQL access modes:

bugzilla.usermap Path of file containing Mercurial committer email to Bugzilla user email mappings. If specified, the file should contain one mapping per line:

committer = Bugzilla user

See also the [usermap] section.

The [usermap] section is used to specify mappings of Mercurial committer email to Bugzilla user email. See also bugzilla.usermap. Contains entries of the form committer = Bugzilla user.

XMLRPC access mode configuration:

bugzilla.bzurl The base URL for the Bugzilla installation. Default http://localhost/bugzilla .

bugzilla.user The username to use to log into Bugzilla via XMLRPC. Default bugs.

bugzilla.password The password for Bugzilla login.

XMLRPC+email access mode uses the XMLRPC access mode configuration items, and also:

bugzilla.bzemail The Bugzilla email address.

In addition, the Mercurial email settings must be configured. See the documentation in hgrc(5), sections [email] and [smtp].

MySQL access mode configuration:

bugzilla.host Hostname of the MySQL server holding the Bugzilla database. Default localhost.

bugzilla.db Name of the Bugzilla database in MySQL. Default bugs.

bugzilla.user Username to use to access MySQL server. Default bugs.

bugzilla.password Password to use to access MySQL server.

bugzilla.timeout Database connection timeout (seconds). Default 5.

bugzilla.bzuser Fallback Bugzilla user name to record comments with, if changeset committer cannot be found as a Bugzilla user.

bugzilla.bzdir Bugzilla install directory. Used by default notify. Default /var/www/html/bugzilla.

bugzilla.notify The command to run to get Bugzilla to send bug change notification emails. Substitutes from a map with 3 keys, bzdir, id (bug id) and user (committer bugzilla email). Default depends on version; from 2.18 it is "cd %(bzdir)s && perl -T contrib/sendbugmail.pl %(id)s %(user)s".

Activating the extension:

[extensions] bugzilla =

[hooks] # run bugzilla hook on every change pulled or pushed in here incoming.bugzilla = python:hgext.bugzilla.hook

Example configurations:

XMLRPC example configuration. This uses the Bugzilla at http://my-project.org/bugzilla , logging in as user bugmail@my-project.org with password plugh. It is used with a collection of Mercurial repositories in /var/local/hg/repos/, with a web interface at http://my-project.org/hg .

[bugzilla] bzurl=http://my-project.org/bugzilla user=bugmail@my-project.org password=plugh version=xmlrpc template=Changeset {node|short} in {root|basename}. {hgweb}/{webroot}/rev/{node|short}\n {desc}\n strip=5

[web] baseurl=http://my-project.org/hg

XMLRPC+email example configuration. This uses the Bugzilla at http://my-project.org/bugzilla , logging in as user bugmail@my-project.org with password plugh. It is used with a collection of Mercurial repositories in /var/local/hg/repos/, with a web interface at http://my-project.org/hg . Bug comments are sent to the Bugzilla email address bugzilla@my-project.org.

[bugzilla] bzurl=http://my-project.org/bugzilla user=bugmail@my-project.org password=plugh version=xmlrpc bzemail=bugzilla@my-project.org template=Changeset {node|short} in {root|basename}. {hgweb}/{webroot}/rev/{node|short}\n {desc}\n strip=5

[web] baseurl=http://my-project.org/hg

[usermap] user@emaildomain.com=user.name@bugzilladomain.com

MySQL example configuration. This has a local Bugzilla 3.2 installation in /opt/bugzilla-3.2. The MySQL database is on localhost, the Bugzilla database name is bugs and MySQL is accessed with MySQL username bugs password XYZZY. It is used with a collection of Mercurial repositories in /var/local/hg/repos/, with a web interface at http://my-project.org/hg .

[bugzilla] host=localhost password=XYZZY version=3.0 bzuser=unknown@domain.com bzdir=/opt/bugzilla-3.2 template=Changeset {node|short} in {root|basename}. {hgweb}/{webroot}/rev/{node|short}\n {desc}\n strip=5

[web] baseurl=http://my-project.org/hg

[usermap] user@emaildomain.com=user.name@bugzilladomain.com

All the above add a comment to the Bugzilla bug record of the form:

Changeset 3b16791d6642 in repository-name. http://my-project.org/hg/repository-name/rev/3b16791d6642

Changeset commit comment. Bug 1234.

children command to display child changesets (DEPRECATED)

This extension is deprecated. You should use hg log -r "children(REV)" instead.

Commands children hg children [-r REV] [FILE]

Print the children of the working directory's revisions. If a revision is given via -r/--rev, the children of that revision will be printed. If a file argument is given, revision in which the file was last changed (after the working directory revision or the argument to --rev if given) is printed.

Options:

-r, --rev show children of the specified revision

--style display using template map file

--template display with template

churn command to display statistics about repository history

Commands churn hg churn [-d DATE] [-r REV] [--aliases FILE] [FILE]

This command will display a histogram representing the number of changed lines or revisions, grouped according to the given template. The default template will group changes by author. The --dateformat option may be used to group the results by date instead.

Statistics are based on the number of changed lines, or alternatively the number of matching revisions if the --changesets option is specified.

Examples:

# display count of changed lines for every committer hg churn -t '{author|email}'

# display daily activity graph hg churn -f '%H' -s -c

# display activity of developers by month hg churn -f '%Y-%m' -s -c

# display count of lines changed in every year hg churn -f '%Y' -s

It is possible to map alternate email addresses to a main address by providing a file using the following format:

<alias email> = <actual email>

Such a file may be specified with the --aliases option, otherwise a .hgchurn file will be looked for in the working directory root.

Options:

-r, --rev count rate for the specified revision or range

-d, --date count rate for revisions matching date spec

-t, --template template to group changesets (default: {author|email})

-f, --dateformat strftime-compatible format for grouping by date

-c, --changesets count rate by number of changesets

-s, --sort sort by key (default: sort by count)

--diffstat display added/removed lines separately

--aliases file with email aliases

-I, --include include names matching the given patterns

-X, --exclude exclude names matching the given patterns

color colorize output from some commands

This extension modifies the status and resolve commands to add color to their output to reflect file status, the qseries command to add color to reflect patch status (applied, unapplied, missing), and to diff-related commands to highlight additions, removals, diff headers, and trailing whitespace.

Other effects in addition to color, like bold and underlined text, are also available. By default, the terminfo database is used to find the terminal codes used to change color and effect. If terminfo is not available, then effects are rendered with the ECMA-48 SGR control function (aka ANSI escape codes).

Default effects may be overridden from your configuration file:

[color] status.modified = blue bold underline red_background status.added = green bold status.removed = red bold blue_background status.deleted = cyan bold underline status.unknown = magenta bold underline status.ignored = black bold

# 'none' turns off all effects status.clean = none status.copied = none

qseries.applied = blue bold underline qseries.unapplied = black bold qseries.missing = red bold

diff.diffline = bold diff.extended = cyan bold diff.file_a = red bold diff.file_b = green bold diff.hunk = magenta diff.deleted = red diff.inserted = green diff.changed = white diff.trailingwhitespace = bold red_background

resolve.unresolved = red bold resolve.resolved = green bold

bookmarks.current = green

branches.active = none branches.closed = black bold branches.current = green branches.inactive = none

tags.normal = green tags.local = black bold

The available effects in terminfo mode are 'blink', 'bold', 'dim', 'inverse', 'invisible', 'italic', 'standout', and 'underline'; in ECMA-48 mode, the options are 'bold', 'inverse', 'italic', and 'underline'. How each is rendered depends on the terminal emulator. Some may not be available for a given terminal type, and will be silently ignored.

Note that on some systems, terminfo mode may cause problems when using color with the pager extension and less -R. less with the -R option will only display ECMA-48 color codes, and terminfo mode may sometimes emit codes that less doesn't understand. You can work around this by either using ansi mode (or auto mode), or by using less -r (which will pass through all terminal control codes, not just color control codes).

Because there are only eight standard colors, this module allows you to define color names for other color slots which might be available for your terminal type, assuming terminfo mode. For instance:

color.brightblue = 12 color.pink = 207 color.orange = 202

to set 'brightblue' to color slot 12 (useful for 16 color terminals that have brighter colors defined in the upper eight) and, 'pink' and 'orange' to colors in 256-color xterm's default color cube. These defined colors may then be used as any of the pre-defined eight, including appending '_background' to set the background to that color.

By default, the color extension will use ANSI mode (or win32 mode on Windows) if it detects a terminal. To override auto mode (to enable terminfo mode, for example), set the following configuration option:

[color] mode = terminfo

Any value other than 'ansi', 'win32', 'terminfo', or 'auto' will disable color.

convert import revisions from foreign VCS repositories into Mercurial

Commands convert hg convert [OPTION]... SOURCE [DEST [REVMAP]]

Accepted source formats [identifiers]:

• Mercurial [hg]

• CVS [cvs]

• Darcs [darcs]

• git [git]

• Subversion [svn]

• Monotone [mtn]

• GNU Arch [gnuarch]

• Bazaar [bzr]

• Perforce [p4]

Accepted destination formats [identifiers]:

• Mercurial [hg]

• Subversion [svn] (history on branches is not preserved)

If no revision is given, all revisions will be converted. Otherwise, convert will only import up to the named revision (given in a format understood by the source).

If no destination directory name is specified, it defaults to the basename of the source with -hg appended. If the destination repository doesn't exist, it will be created.

By default, all sources except Mercurial will use --branchsort. Mercurial uses --sourcesort to preserve original revision numbers order. Sort modes have the following effects:

--branchsort convert from parent to child revision when possible, which means branches are usually converted one after the other. It generates more compact repositories.

--datesort sort revisions by date. Converted repositories have good-looking changelogs but are often an order of magnitude larger than the same ones generated by --branchsort.

--sourcesort try to preserve source revisions order, only supported by Mercurial sources.

--closesort try to move closed revisions as close as possible to parent branches, only supported by Mercurial sources.

If REVMAP isn't given, it will be put in a default location (<dest>/.hg/shamap by default). The REVMAP is a simple text file that maps each source commit ID to the destination ID for that revision, like so:

<source ID> <destination ID>

If the file doesn't exist, it's automatically created. It's updated on each commit copied, so hg convert can be interrupted and can be run repeatedly to copy new commits.

The authormap is a simple text file that maps each source commit author to a destination commit author. It is handy for source SCMs that use unix logins to identify authors (e.g.: CVS). One line per author mapping and the line format is:

source author = destination author

Empty lines and lines starting with a # are ignored.

The filemap is a file that allows filtering and remapping of files and directories. Each line can contain one of the following directives:

include path/to/file-or-dir

exclude path/to/file-or-dir

rename path/to/source path/to/destination

Comment lines start with #. A specified path matches if it equals the full relative name of a file or one of its parent directories. The include or exclude directive with the longest matching path applies, so line order does not matter.

The include directive causes a file, or all files under a directory, to be included in the destination repository, and the exclusion of all other files and directories not explicitly included. The exclude directive causes files or directories to be omitted. The rename directive renames a file or directory if it is converted. To rename from a subdirectory into the root of the repository, use . as the path to rename to.

The splicemap is a file that allows insertion of synthetic history, letting you specify the parents of a revision. This is useful if you want to e.g. give a Subversion merge two parents, or graft two disconnected series of history together. Each entry contains a key, followed by a space, followed by one or two comma-separated values:

key parent1, parent2

The key is the revision ID in the source revision control system whose parents should be modified (same format as a key in .hg/shamap). The values are the revision IDs (in either the source or destination revision control system) that should be used as the new parents for that node. For example, if you have merged "release-1.0" into "trunk", then you should specify the revision on "trunk" as the first parent and the one on the "release-1.0" branch as the second.

The branchmap is a file that allows you to rename a branch when it is being brought in from whatever external repository. When used in conjunction with a splicemap, it allows for a powerful combination to help fix even the most badly mismanaged repositories and turn them into nicely structured Mercurial repositories. The branchmap contains lines of the form:

original_branch_name new_branch_name

where "original_branch_name" is the name of the branch in the source repository, and "new_branch_name" is the name of the branch is the destination repository. No whitespace is allowed in the branch names. This can be used to (for instance) move code in one repository from "default" to a named branch.

Mercurial Source The Mercurial source recognizes the following configuration options, which you can set on the command line with --config:

convert.hg.ignoreerrors ignore integrity errors when reading. Use it to fix Mercurial repositories with missing revlogs, by converting from and to Mercurial. Default is False.

convert.hg.saverev store original revision ID in changeset (forces target IDs to change). It takes a boolean argument and defaults to False.

convert.hg.startrev convert start revision and its descendants. It takes a hg revision identifier and defaults to 0.

CVS Source CVS source will use a sandbox (i.e. a checked-out copy) from CVS to indicate the starting point of what will be converted. Direct access to the repository files is not needed, unless of course the repository is :local:. The conversion uses the top level directory in the sandbox to find the CVS repository, and then uses CVS rlog commands to find files to convert. This means that unless a filemap is given, all files under the starting directory will be converted, and that any directory reorganization in the CVS sandbox is ignored.

The following options can be used with --config:

convert.cvsps.cache Set to False to disable remote log caching, for testing and debugging purposes. Default is True.

convert.cvsps.fuzz Specify the maximum time (in seconds) that is allowed between commits with identical user and log message in a single changeset. When very large files were checked in as part of a changeset then the default may not be long enough. The default is 60.

convert.cvsps.mergeto Specify a regular expression to which commit log messages are matched. If a match occurs, then the conversion process will insert a dummy revision merging the branch on which this log message occurs to the branch indicated in the regex. Default is {{mergetobranch ([-\w]+)}}

convert.cvsps.mergefrom Specify a regular expression to which commit log messages are matched. If a match occurs, then the conversion process will add the most recent revision on the branch indicated in the regex as the second parent of the changeset. Default is {{mergefrombranch ([-\w]+)}}

convert.localtimezone use local time (as determined by the TZ environment variable) for changeset date/times. The default is False (use UTC).

hooks.cvslog Specify a Python function to be called at the end of gathering the CVS log. The function is passed a list with the log entries, and can modify the entries in-place, or add or delete them.

hooks.cvschangesets Specify a Python function to be called after the changesets are calculated from the CVS log. The function is passed a list with the changeset entries, and can modify the changesets in-place, or add or delete them.

An additional "debugcvsps" Mercurial command allows the builtin changeset merging code to be run without doing a conversion. Its parameters and output are similar to that of cvsps 2.1. Please see the command help for more details.

Subversion Source Subversion source detects classical trunk/branches/tags layouts. By default, the supplied svn://repo/path/ source URL is converted as a single branch. If svn://repo/path/trunk exists it replaces the default branch. If svn://repo/path/branches exists, its subdirectories are listed as possible branches. If svn://repo/path/tags exists, it is looked for tags referencing converted branches. Default trunk, branches and tags values can be overridden with following options. Set them to paths relative to the source URL, or leave them blank to disable auto detection.

The following options can be set with --config:

convert.svn.branches specify the directory containing branches. The default is branches.

convert.svn.tags specify the directory containing tags. The default is tags.

convert.svn.trunk specify the name of the trunk branch. The default is trunk.

convert.localtimezone use local time (as determined by the TZ environment variable) for changeset date/times. The default is False (use UTC).

Source history can be retrieved starting at a specific revision, instead of being integrally converted. Only single branch conversions are supported.

convert.svn.startrev specify start Subversion revision number. The default is 0.

Perforce Source The Perforce (P4) importer can be given a p4 depot path or a client specification as source. It will convert all files in the source to a flat Mercurial repository, ignoring labels, branches and integrations. Note that when a depot path is given you then usually should specify a target directory, because otherwise the target may be named ...-hg.

It is possible to limit the amount of source history to be converted by specifying an initial Perforce revision:

convert.p4.startrev specify initial Perforce revision (a Perforce changelist number).

Mercurial Destination The following options are supported:

convert.hg.clonebranches dispatch source branches in separate clones. The default is False.

convert.hg.tagsbranch branch name for tag revisions, defaults to default.

convert.hg.usebranchnames preserve branch names. The default is True.

Options:

--authors username mapping filename (DEPRECATED, use --authormap instead)

-s, --source-type source repository type

-d, --dest-type destination repository type

-r, --rev import up to target revision REV

-A, --authormap remap usernames using this file

--filemap remap file names using contents of file

--splicemap splice synthesized history into place

--branchmap change branch names while converting

--branchsort try to sort changesets by branches

--datesort try to sort changesets by date

--sourcesort preserve source changesets order

--closesort try to reorder closed revisions

eol automatically manage newlines in repository files

This extension allows you to manage the type of line endings (CRLF or LF) that are used in the repository and in the local working directory. That way you can get CRLF line endings on Windows and LF on Unix/Mac, thereby letting everybody use their OS native line endings.

The extension reads its configuration from a versioned .hgeol configuration file found in the root of the working copy. The .hgeol file use the same syntax as all other Mercurial configuration files. It uses two sections, [patterns] and [repository].

The [patterns] section specifies how line endings should be converted between the working copy and the repository. The format is specified by a file pattern. The first match is used, so put more specific patterns first. The available line endings are LF, CRLF, and BIN.

Files with the declared format of CRLF or LF are always checked out and stored in the repository in that format and files declared to be binary (BIN) are left unchanged. Additionally, native is an alias for checking out in the platform's default line ending: LF on Unix (including Mac OS X) and CRLF on Windows. Note that BIN (do nothing to line endings) is Mercurial's default behaviour; it is only needed if you need to override a later, more general pattern.

The optional [repository] section specifies the line endings to use for files stored in the repository. It has a single setting, native, which determines the storage line endings for files declared as native in the [patterns] section. It can be set to LF or CRLF. The default is LF. For example, this means that on Windows, files configured as native (CRLF by default) will be converted to LF when stored in the repository. Files declared as LF, CRLF, or BIN in the [patterns] section are always stored as-is in the repository.

Example versioned .hgeol file:

[patterns] **.py = native **.vcproj = CRLF **.txt = native Makefile = LF **.jpg = BIN

[repository] native = LF

Note The rules will first apply when files are touched in the working copy, e.g. by updating to null and back to tip to touch all files.

The extension uses an optional [eol] section read from both the normal Mercurial configuration files and the .hgeol file, with the latter overriding the former. You can use that section to control the overall behavior. There are three settings:

eol.native (default os.linesep) can be set to LF or CRLF to override the default interpretation of native for checkout. This can be used with hg archive on Unix, say, to generate an archive where files have line endings for Windows.

eol.only-consistent (default True) can be set to False to make the extension convert files with inconsistent EOLs. Inconsistent means that there is both CRLF and LF present in the file. Such files are normally not touched under the assumption that they have mixed EOLs on purpose.

eol.fix-trailing-newline (default False) can be set to True to ensure that converted files end with a EOL character (either \n or \r\n as per the configured patterns).

The extension provides cleverencode: and cleverdecode: filters like the deprecated win32text extension does. This means that you can disable win32text and enable eol and your filters will still work. You only need to these filters until you have prepared a .hgeol file.

The win32text.forbid* hooks provided by the win32text extension have been unified into a single hook named eol.checkheadshook. The hook will lookup the expected line endings from the .hgeol file, which means you must migrate to a .hgeol file first before using the hook. eol.checkheadshook only checks heads, intermediate invalid revisions will be pushed. To forbid them completely, use the eol.checkallhook hook. These hooks are best used as pretxnchangegroup hooks.

See hg help patterns for more information about the glob patterns used.

extdiff command to allow external programs to compare revisions

The extdiff Mercurial extension allows you to use external programs to compare revisions, or revision with working directory. The external diff programs are called with a configurable set of options and two non-option arguments: paths to directories containing snapshots of files to compare.

The extdiff extension also allows you to configure new diff commands, so you do not need to type hg extdiff -p kdiff3 always.

[extdiff] # add new command that runs GNU diff(1) in 'context diff' mode cdiff = gdiff -Nprc5 ## or the old way: #cmd.cdiff = gdiff #opts.cdiff = -Nprc5

# add new command called vdiff, runs kdiff3 vdiff = kdiff3

# add new command called meld, runs meld (no need to name twice) meld =

# add new command called vimdiff, runs gvimdiff with DirDiff plugin # (see http://www.vim.org/scripts/script.php?script_id=102) Non # English user, be sure to put "let g:DirDiffDynamicDiffText = 1" in # your .vimrc vimdiff = gvim -f "+next" \ "+execute 'DirDiff' fnameescape(argv(0)) fnameescape(argv(1))"

Tool arguments can include variables that are expanded at runtime:

$parent1, $plabel1 - filename, descriptive label of first parent $child, $clabel - filename, descriptive label of child revision $parent2, $plabel2 - filename, descriptive label of second parent $root - repository root $parent is an alias for $parent1.

The extdiff extension will look in your [diff-tools] and [merge-tools] sections for diff tool arguments, when none are specified in [extdiff].

[extdiff] kdiff3 =

[diff-tools] kdiff3.diffargs=--L1 '$plabel1' --L2 '$clabel' $parent $child

You can use -I/-X and list of file or directory names like normal hg diff command. The extdiff extension makes snapshots of only needed files, so running the external diff program will actually be pretty fast (at least faster than having to compare the entire tree).

Commands extdiff hg extdiff [OPT]... [FILE]...

Show differences between revisions for the specified files, using an external program. The default program used is diff, with default options "-Npru".

To select a different program, use the -p/--program option. The program will be passed the names of two directories to compare. To pass additional options to the program, use -o/--option. These will be passed before the names of the directories to compare.

When two revision arguments are given, then changes are shown between those revisions. If only one revision is specified then that revision is compared to the working directory, and, when no revisions are specified, the working directory files are compared to its parent.

Options:

-p, --program comparison program to run

-o, --option pass option to comparison program

-r, --rev revision

-c, --change change made by revision

-I, --include include names matching the given patterns

-X, --exclude exclude names matching the given patterns

factotum http authentication with factotum

This extension allows the factotum(4) facility on Plan 9 from Bell Labs platforms to provide authentication information for HTTP access. Configuration entries specified in the auth section as well as authentication information provided in the repository URL are fully supported. If no prefix is specified, a value of "*" will be assumed.

By default, keys are specified as:

proto=pass service=hg prefix=<prefix> user=<username> !password=<password>

If the factotum extension is unable to read the required key, one will be requested interactively.

A configuration section is available to customize runtime behavior. By default, these entries are:

[factotum] executable = /bin/auth/factotum mountpoint = /mnt/factotum service = hg

The executable entry defines the full path to the factotum binary. The mountpoint entry defines the path to the factotum file service. Lastly, the service entry controls the service name used when reading keys.

fetch pull, update and merge in one command (DEPRECATED)

Commands fetch hg fetch [SOURCE]

This finds all changes from the repository at the specified path or URL and adds them to the local repository.

If the pulled changes add a new branch head, the head is automatically merged, and the result of the merge is committed. Otherwise, the working directory is updated to include the new changes.

When a merge is needed, the working directory is first updated to the newly pulled changes. Local changes are then merged into the pulled changes. To switch the merge order, use --switch-parent.

See hg help dates for a list of formats valid for -d/--date.

Returns 0 on success.

Options:

-r, --rev a specific revision you would like to pull

-e, --edit edit commit message

--force-editor edit commit message (DEPRECATED)

--switch-parent switch parents when merging

-m, --message use text as commit message

-l, --logfile read commit message from file

-d, --date record the specified date as commit date

-u, --user record the specified user as committer

-e, --ssh specify ssh command to use

--remotecmd specify hg command to run on the remote side

--insecure do not verify server certificate (ignoring web.cacerts config)

gpg commands to sign and verify changesets

Commands sigcheck hg sigcheck REV

verify all the signatures there may be for a particular revision

sign hg sign [OPTION]... [REV]...

If no revision is given, the parent of the working directory is used, or tip if no revision is checked out.

See hg help dates for a list of formats valid for -d/--date.

Options:

-l, --local make the signature local

-f, --force sign even if the sigfile is modified

--no-commit do not commit the sigfile after signing

-k, --key the key id to sign with

-m, --message commit message

-d, --date record the specified date as commit date

-u, --user record the specified user as committer

sigs hg sigs

list signed changesets

graphlog command to view revision graphs from a shell

This extension adds a --graph option to the incoming, outgoing and log commands. When this options is given, an ASCII representation of the revision graph is also shown.

Commands glog hg glog [OPTION]... [FILE]

Print a revision history alongside a revision graph drawn with ASCII characters.

Nodes printed as an @ character are parents of the working directory.

Options:

-f, --follow follow changeset history, or file history across copies and renames

--follow-first only follow the first parent of merge changesets (DEPRECATED)

-d, --date show revisions matching date spec

-C, --copies show copied files

-k, --keyword do case-insensitive search for a given text

-r, --rev show the specified revision or range

--removed include revisions where files were removed

-m, --only-merges show only merges (DEPRECATED)

-u, --user revisions committed by user

--only-branch show only changesets within the given named branch (DEPRECATED)

-b, --branch show changesets within the given named branch

-P, --prune do not display revision or any of its ancestors

-p, --patch show patch

-g, --git use git extended diff format

-l, --limit limit number of changes displayed

-M, --no-merges do not show merges

--stat output diffstat-style summary of changes

-G, --graph show the revision DAG

--style display using template map file

--template display with template

-I, --include include names matching the given patterns

-X, --exclude exclude names matching the given patterns

hgcia hooks for integrating with the CIA.vc notification service

This is meant to be run as a changegroup or incoming hook. To configure it, set the following options in your hgrc:

[cia] # your registered CIA user name user = foo # the name of the project in CIA project = foo # the module (subproject) (optional) #module = foo # Append a diffstat to the log message (optional) #diffstat = False # Template to use for log messages (optional) #template = {desc}\n{baseurl}{webroot}/rev/{node}-- {diffstat} # Style to use (optional) #style = foo # The URL of the CIA notification service (optional) # You can use mailto: URLs to send by email, e.g. # mailto:cia@cia.vc # Make sure to set email.from if you do this. #url = http://cia.vc/ # print message instead of sending it (optional) #test = False # number of slashes to strip for url paths #strip = 0

[hooks] # one of these: changegroup.cia = python:hgcia.hook #incoming.cia = python:hgcia.hook

[web] # If you want hyperlinks (optional) baseurl = http://server/path/to/repo

hgk browse the repository in a graphical way

The hgk extension allows browsing the history of a repository in a graphical way. It requires Tcl/Tk version 8.4 or later. (Tcl/Tk is not distributed with Mercurial.)

hgk consists of two parts: a Tcl script that does the displaying and querying of information, and an extension to Mercurial named hgk.py, which provides hooks for hgk to get information. hgk can be found in the contrib directory, and the extension is shipped in the hgext repository, and needs to be enabled.

The hg view command will launch the hgk Tcl script. For this command to work, hgk must be in your search path. Alternately, you can specify the path to hgk in your configuration file:

[hgk] path=/location/of/hgk

hgk can make use of the extdiff extension to visualize revisions. Assuming you had already configured extdiff vdiff command, just add:

[hgk] vdiff=vdiff

Revisions context menu will now display additional entries to fire vdiff on hovered and selected revisions.

Commands view hg view [-l LIMIT] [REVRANGE]

start interactive history viewer

Options:

-l, --limit limit number of changes displayed

highlight syntax highlighting for hgweb (requires Pygments)

It depends on the Pygments syntax highlighting library: http://pygments.org/

There is a single configuration option:

[web] pygments_style = <style>

The default is 'colorful'.

histedit interactive history editing

With this extension installed, Mercurial gains one new command: histedit. Usage is as follows, assuming the following history:

@ 3[tip] 7c2fd3b9020c 2009-04-27 18:04 -0500 durin42 | Add delta | o 2 030b686bedc4 2009-04-27 18:04 -0500 durin42 | Add gamma | o 1 c561b4e977df 2009-04-27 18:04 -0500 durin42 | Add beta | o 0 d8d2fcd0e319 2009-04-27 18:04 -0500 durin42 Add alpha

If you were to run hg histedit c561b4e977df, you would see the following file open in your editor:

pick c561b4e977df Add beta pick 030b686bedc4 Add gamma pick 7c2fd3b9020c Add delta

# Edit history between c561b4e977df and 7c2fd3b9020c # # Commands: # p, pick = use commit # e, edit = use commit, but stop for amending # f, fold = use commit, but fold into previous commit (combines N and N-1) # d, drop = remove commit from history # m, mess = edit message without changing commit content #

In this file, lines beginning with # are ignored. You must specify a rule for each revision in your history. For example, if you had meant to add gamma before beta, and then wanted to add delta in the same revision as beta, you would reorganize the file to look like this:

pick 030b686bedc4 Add gamma pick c561b4e977df Add beta fold 7c2fd3b9020c Add delta

# Edit history between c561b4e977df and 7c2fd3b9020c # # Commands: # p, pick = use commit # e, edit = use commit, but stop for amending # f, fold = use commit, but fold into previous commit (combines N and N-1) # d, drop = remove commit from history # m, mess = edit message without changing commit content #

At which point you close the editor and histedit starts working. When you specify a fold operation, histedit will open an editor when it folds those revisions together, offering you a chance to clean up the commit message:

Add beta *** Add delta

Edit the commit message to your liking, then close the editor. For this example, let's assume that the commit message was changed to Add beta and delta. After histedit has run and had a chance to remove any old or temporary revisions it needed, the history looks like this:

@ 2[tip] 989b4d060121 2009-04-27 18:04 -0500 durin42 | Add beta and delta. | o 1 081603921c3f 2009-04-27 18:04 -0500 durin42 | Add gamma | o 0 d8d2fcd0e319 2009-04-27 18:04 -0500 durin42 Add alpha

Note that histedit does not remove any revisions (even its own temporary ones) until after it has completed all the editing operations, so it will probably perform several strip operations when it's done. For the above example, it had to run strip twice. Strip can be slow depending on a variety of factors, so you might need to be a little patient. You can choose to keep the original revisions by passing the --keep flag.

The edit operation will drop you back to a command prompt, allowing you to edit files freely, or even use hg record to commit some changes as a separate commit. When you're done, any remaining uncommitted changes will be committed as well. When done, run hg histedit --continue to finish this step. You'll be prompted for a new commit message, but the default commit message will be the original message for the edit ed revision.

The message operation will give you a chance to revise a commit message without changing the contents. It's a shortcut for doing edit immediately followed by hg histedit --continue`.

If histedit encounters a conflict when moving a revision (while handling pick or fold), it'll stop in a similar manner to edit with the difference that it won't prompt you for a commit message when done. If you decide at this point that you don't like how much work it will be to rearrange history, or that you made a mistake, you can use hg histedit --abort to abandon the new changes you have made and return to the state before you attempted to edit your history.

If we clone the histedit-ed example repository above and add four more changes, such that we have the following history:

@ 6[tip] 038383181893 2009-04-27 18:04 -0500 stefan | Add theta | o 5 140988835471 2009-04-27 18:04 -0500 stefan | Add eta | o 4 122930637314 2009-04-27 18:04 -0500 stefan | Add zeta | o 3 836302820282 2009-04-27 18:04 -0500 stefan | Add epsilon | o 2 989b4d060121 2009-04-27 18:04 -0500 durin42 | Add beta and delta. | o 1 081603921c3f 2009-04-27 18:04 -0500 durin42 | Add gamma | o 0 d8d2fcd0e319 2009-04-27 18:04 -0500 durin42 Add alpha

If you run hg histedit --outgoing on the clone then it is the same as running hg histedit 836302820282. If you need plan to push to a repository that Mercurial does not detect to be related to the source repo, you can add a --force option.

Commands histedit hg histedit [PARENT]

interactively edit changeset history

Options:

--commands Read history edits from the specified file.

-c, --continue continue an edit already in progress

-k, --keep don't strip old nodes after edit is complete

--abort abort an edit in progress

-o, --outgoing changesets not found in destination

-f, --force force outgoing even for unrelated repositories

-r, --rev first revision to be edited

inotify accelerate status report using Linux's inotify service

Commands inserve hg inserve [OPTION]...

start an inotify server for this repository

Options:

-d, --daemon run server in background

--daemon-pipefds used internally by daemon mode

-t, --idle-timeout minutes to sit idle before exiting

--pid-file name of file to write process ID to

interhg None

keyword expand keywords in tracked files

This extension expands RCS/CVS-like or self-customized $Keywords$ in tracked text files selected by your configuration.

Keywords are only expanded in local repositories and not stored in the change history. The mechanism can be regarded as a convenience for the current user or for archive distribution.

Keywords expand to the changeset data pertaining to the latest change relative to the working directory parent of each file.

Configuration is done in the [keyword], [keywordset] and [keywordmaps] sections of hgrc files.

Example:

[keyword] # expand keywords in every python file except those matching "x*" **.py = x* = ignore

[keywordset] # prefer svn- over cvs-like default keywordmaps svn = True

Note The more specific you are in your filename patterns the less you lose speed in huge repositories.

For [keywordmaps] template mapping and expansion demonstration and control run hg kwdemo. See hg help templates for a list of available templates and filters.

Three additional date template filters are provided:

utcdate

"2006/09/18 15:13:13"

svnutcdate

"2006-09-18 15:13:13Z"

svnisodate

"2006-09-18 08:13:13 -700 (Mon, 18 Sep 2006)"

The default template mappings (view with hg kwdemo -d) can be replaced with customized keywords and templates. Again, run hg kwdemo to control the results of your configuration changes.

Before changing/disabling active keywords, you must run hg kwshrink to avoid storing expanded keywords in the change history.

To force expansion after enabling it, or a configuration change, run hg kwexpand.

Expansions spanning more than one line and incremental expansions, like CVS' $Log$, are not supported. A keyword template map "Log = {desc}" expands to the first line of the changeset description.

Commands kwdemo hg kwdemo [-d] [-f RCFILE] [TEMPLATEMAP]...

Show current, custom, or default keyword template maps and their expansions.

Extend the current configuration by specifying maps as arguments and using -f/--rcfile to source an external hgrc file.

Use -d/--default to disable current configuration.

See hg help templates for information on templates and filters.

Options:

-d, --default show default keyword template maps

-f, --rcfile read maps from rcfile

kwexpand hg kwexpand [OPTION]... [FILE]...

Run after (re)enabling keyword expansion.

kwexpand refuses to run if given files contain local changes.

Options:

-I, --include include names matching the given patterns

-X, --exclude exclude names matching the given patterns

kwfiles hg kwfiles [OPTION]... [FILE]...

List which files in the working directory are matched by the [keyword] configuration patterns.

Useful to prevent inadvertent keyword expansion and to speed up execution by including only files that are actual candidates for expansion.

See hg help keyword on how to construct patterns both for inclusion and exclusion of files.

With -A/--all and -v/--verbose the codes used to show the status of files are:

K = keyword expansion candidate k = keyword expansion candidate (not tracked) I = ignored i = ignored (not tracked)

Options:

-A, --all show keyword status flags of all files

-i, --ignore show files excluded from expansion

-u, --unknown only show unknown (not tracked) files

-I, --include include names matching the given patterns

-X, --exclude exclude names matching the given patterns

kwshrink hg kwshrink [OPTION]... [FILE]...

Must be run before changing/disabling active keywords.

kwshrink refuses to run if given files contain local changes.

Options:

-I, --include include names matching the given patterns

-X, --exclude exclude names matching the given patterns

largefiles track large binary files

Large binary files tend to be not very compressible, not very diffable, and not at all mergeable. Such files are not handled efficiently by Mercurial's storage format (revlog), which is based on compressed binary deltas; storing large binary files as regular Mercurial files wastes bandwidth and disk space and increases Mercurial's memory usage. The largefiles extension addresses these problems by adding a centralized client-server layer on top of Mercurial: largefiles live in a central store out on the network somewhere, and you only fetch the revisions that you need when you need them.

largefiles works by maintaining a "standin file" in .hglf/ for each largefile. The standins are small (41 bytes: an SHA-1 hash plus newline) and are tracked by Mercurial. Largefile revisions are identified by the SHA-1 hash of their contents, which is written to the standin. largefiles uses that revision ID to get/put largefile revisions from/to the central store. This saves both disk space and bandwidth, since you don't need to retrieve all historical revisions of large files when you clone or pull.

To start a new repository or add new large binary files, just add --large to your hg add command. For example:

$ dd if=/dev/urandom of=randomdata count=2000 $ hg add --large randomdata $ hg commit -m 'add randomdata as a largefile'

When you push a changeset that adds/modifies largefiles to a remote repository, its largefile revisions will be uploaded along with it. Note that the remote Mercurial must also have the largefiles extension enabled for this to work.

When you pull a changeset that affects largefiles from a remote repository, the largefiles for the changeset will by default not be pulled down. However, when you update to such a revision, any largefiles needed by that revision are downloaded and cached (if they have never been downloaded before). One way to pull largefiles when pulling is thus to use --update, which will update your working copy to the latest pulled revision (and thereby downloading any new largefiles).

If you want to pull largefiles you don't need for update yet, then you can use pull with the --lfrev option or the hg lfpull command.

If you know you are pulling from a non-default location and want to download all the largefiles that correspond to the new changesets at the same time, then you can pull with --lfrev "pulled()".

If you just want to ensure that you will have the largefiles needed to merge or rebase with new heads that you are pulling, then you can pull with --lfrev "head(pulled())" flag to pre-emptively download any largefiles that are new in the heads you are pulling.

Keep in mind that network access may now be required to update to changesets that you have not previously updated to. The nature of the largefiles extension means that updating is no longer guaranteed to be a local-only operation.

If you already have large files tracked by Mercurial without the largefiles extension, you will need to convert your repository in order to benefit from largefiles. This is done with the hg lfconvert command:

$ hg lfconvert --size 10 oldrepo newrepo

In repositories that already have largefiles in them, any new file over 10MB will automatically be added as a largefile. To change this threshold, set largefiles.minsize in your Mercurial config file to the minimum size in megabytes to track as a largefile, or use the --lfsize option to the add command (also in megabytes):

[largefiles] minsize = 2

$ hg add --lfsize 2

The largefiles.patterns config option allows you to specify a list of filename patterns (see hg help patterns) that should always be tracked as largefiles:

[largefiles] patterns = *.jpg re:.*\.(png|bmp)$ library.zip content/audio/*

Files that match one of these patterns will be added as largefiles regardless of their size.

The largefiles.minsize and largefiles.patterns config options will be ignored for any repositories not already containing a largefile. To add the first largefile to a repository, you must explicitly do so with the --large flag passed to the hg add command.

Commands lfconvert hg lfconvert SOURCE DEST [FILE ...]

Convert repository SOURCE to a new repository DEST, identical to SOURCE except that certain files will be converted as largefiles: specifically, any file that matches any PATTERN or whose size is above the minimum size threshold is converted as a largefile. The size used to determine whether or not to track a file as a largefile is the size of the first version of the file. The minimum size can be specified either with --size or in configuration as largefiles.size.

After running this command you will need to make sure that largefiles is enabled anywhere you intend to push the new repository.

Use --to-normal to convert largefiles back to normal files; after this, the DEST repository can be used without largefiles at all.

Options:

-s, --size minimum size (MB) for files to be converted as largefiles

--to-normal convert from a largefiles repo to a normal repo

lfpull hg lfpull -r REV... [-e CMD] [--remotecmd CMD] [SOURCE]

Pull largefiles that are referenced from local changesets but missing locally, pulling from a remote repository to the local cache.

If SOURCE is omitted, the 'default' path will be used. See hg help urls for more information.

Some examples:

• pull largefiles for all branch heads:

hg lfpull -r "head() and not closed()"

• pull largefiles on the default branch:

hg lfpull -r "branch(default)"

Options:

-r, --rev pull largefiles for these revisions

-e, --ssh specify ssh command to use

--remotecmd specify hg command to run on the remote side

--insecure do not verify server certificate (ignoring web.cacerts config)

mq manage a stack of patches

This extension lets you work with a stack of patches in a Mercurial repository. It manages two stacks of patches - all known patches, and applied patches (subset of known patches).

Known patches are represented as patch files in the .hg/patches directory. Applied patches are both patch files and changesets.

Common tasks (use hg help command for more details):

create new patch qnew import existing patch qimport

print patch series qseries print applied patches qapplied

add known patch to applied stack qpush remove patch from applied stack qpop refresh contents of top applied patch qrefresh

By default, mq will automatically use git patches when required to avoid losing file mode changes, copy records, binary files or empty files creations or deletions. This behaviour can be configured with:

[mq] git = auto/keep/yes/no

If set to 'keep', mq will obey the [diff] section configuration while preserving existing git patches upon qrefresh. If set to 'yes' or 'no', mq will override the [diff] section and always generate git or regular patches, possibly losing data in the second case.

It may be desirable for mq changesets to be kept in the secret phase (see hg help phases), which can be enabled with the following setting:

[mq] secret = True

You will by default be managing a patch queue named "patches". You can create other, independent patch queues with the hg qqueue command.

If the working directory contains uncommitted files, qpush, qpop and qgoto abort immediately. If -f/--force is used, the changes are discarded. Setting:

[mq] keepchanges = True

make them behave as if --keep-changes were passed, and non-conflicting local changes will be tolerated and preserved. If incompatible options such as -f/--force or --exact are passed, this setting is ignored.

Commands qapplied hg qapplied [-1] [-s] [PATCH]

Returns 0 on success.

Options:

-1, --last show only the preceding applied patch

-s, --summary print first line of patch header

qclone hg qclone [OPTION]... SOURCE [DEST]

If source is local, destination will have no patches applied. If source is remote, this command can not check if patches are applied in source, so cannot guarantee that patches are not applied in destination. If you clone remote repository, be sure before that it has no patches applied.

Source patch repository is looked for in <src>/.hg/patches by default. Use -p <url> to change.

The patch directory must be a nested Mercurial repository, as would be created by hg init --mq.

Return 0 on success.

Options:

--pull use pull protocol to copy metadata

-U, --noupdate do not update the new working directories

--uncompressed use uncompressed transfer (fast over LAN)

-p, --patches location of source patch repository

-e, --ssh specify ssh command to use

--remotecmd specify hg command to run on the remote side

--insecure do not verify server certificate (ignoring web.cacerts config)

qcommit hg qcommit [OPTION]... [FILE]...

This command is deprecated; use hg commit --mq instead.

Options:

-A, --addremove mark new/missing files as added/removed before committing

--close-branch mark a branch as closed, hiding it from the branch list

--amend amend the parent of the working dir

-I, --include include names matching the given patterns

-X, --exclude exclude names matching the given patterns

-m, --message use text as commit message

-l, --logfile read commit message from file

-d, --date record the specified date as commit date

-u, --user record the specified user as committer

-S, --subrepos recurse into subrepositories

aliases: qci

qdelete hg qdelete [-k] [PATCH]...

The patches must not be applied, and at least one patch is required. Exact patch identifiers must be given. With -k/--keep, the patch files are preserved in the patch directory.

To stop managing a patch and move it into permanent history, use the hg qfinish command.

Options:

-k, --keep keep patch file

-r, --rev stop managing a revision (DEPRECATED)

aliases: qremove qrm

qdiff hg qdiff [OPTION]... [FILE]...

Shows a diff which includes the current patch as well as any changes which have been made in the working directory since the last refresh (thus showing what the current patch would become after a qrefresh).

Use hg diff if you only want to see the changes made since the last qrefresh, or hg export qtip if you want to see changes made by the current patch without including changes made since the qrefresh.

Returns 0 on success.

Options:

-a, --text treat all files as text

-g, --git use git extended diff format

--nodates omit dates from diff headers

-p, --show-function show which function each change is in

--reverse produce a diff that undoes the changes

-w, --ignore-all-space ignore white space when comparing lines

-b, --ignore-space-change ignore changes in the amount of white space

-B, --ignore-blank-lines ignore changes whose lines are all blank

-U, --unified number of lines of context to show

--stat output diffstat-style summary of changes

-I, --include include names matching the given patterns

-X, --exclude exclude names matching the given patterns

qfinish hg qfinish [-a] [REV]...

Finishes the specified revisions (corresponding to applied patches) by moving them out of mq control into regular repository history.

Accepts a revision range or the -a/--applied option. If --applied is specified, all applied mq revisions are removed from mq control. Otherwise, the given revisions must be at the base of the stack of applied patches.

This can be especially useful if your changes have been applied to an upstream repository, or if you are about to push your changes to upstream.

Returns 0 on success.

Options:

-a, --applied finish all applied changesets

qfold hg qfold [-e] [-k] [-m TEXT] [-l FILE] PATCH...

Patches must not yet be applied. Each patch will be successively applied to the current patch in the order given. If all the patches apply successfully, the current patch will be refreshed with the new cumulative patch, and the folded patches will be deleted. With -k/--keep, the folded patch files will not be removed afterwards.

The header for each folded patch will be concatenated with the current patch header, separated by a line of * * *.

Returns 0 on success.

Options:

-e, --edit edit patch header

-k, --keep keep folded patch files

-m, --message use text as commit message

-l, --logfile read commit message from file

qgoto hg qgoto [OPTION]... PATCH

Returns 0 on success.

Options:

--keep-changes tolerate non-conflicting local changes

-f, --force overwrite any local changes

--no-backup do not save backup copies of files

qguard hg qguard [-l] [-n] [PATCH] [-- [+GUARD]... [-GUARD]...]

Guards control whether a patch can be pushed. A patch with no guards is always pushed. A patch with a positive guard ("+foo") is pushed only if the hg qselect command has activated it. A patch with a negative guard ("-foo") is never pushed if the hg qselect command has activated it.

With no arguments, print the currently active guards. With arguments, set guards for the named patch.

Note Specifying negative guards now requires '--'.

To set guards on another patch:

hg qguard other.patch -- +2.6.17 -stable

Returns 0 on success.

Options:

-l, --list list all patches and guards

-n, --none drop all guards

qheader hg qheader [PATCH]

Returns 0 on success.

qimport hg qimport [-e] [-n NAME] [-f] [-g] [-P] [-r REV]... [FILE]...

The patch is inserted into the series after the last applied patch. If no patches have been applied, qimport prepends the patch to the series.

The patch will have the same name as its source file unless you give it a new one with -n/--name.

You can register an existing patch inside the patch directory with the -e/--existing flag.

With -f/--force, an existing patch of the same name will be overwritten.

An existing changeset may be placed under mq control with -r/--rev (e.g. qimport --rev tip -n patch will place tip under mq control). With -g/--git, patches imported with --rev will use the git diff format. See the diffs help topic for information on why this is important for preserving rename/copy information and permission changes. Use hg qfinish to remove changesets from mq control.

To import a patch from standard input, pass - as the patch file. When importing from standard input, a patch name must be specified using the --name flag.

To import an existing patch while renaming it:

hg qimport -e existing-patch -n new-name

Returns 0 if import succeeded.

Options:

-e, --existing import file in patch directory

-n, --name name of patch file

-f, --force overwrite existing files

-r, --rev place existing revisions under mq control

-g, --git use git extended diff format

-P, --push qpush after importing

qinit hg qinit [-c]

The queue repository is unversioned by default. If -c/--create-repo is specified, qinit will create a separate nested repository for patches (qinit -c may also be run later to convert an unversioned patch repository into a versioned one). You can use qcommit to commit changes to this queue repository.

This command is deprecated. Without -c, it's implied by other relevant commands. With -c, use hg init --mq instead.

Options:

-c, --create-repo create queue repository

qnew hg qnew [-e] [-m TEXT] [-l FILE] PATCH [FILE]...

qnew creates a new patch on top of the currently-applied patch (if any). The patch will be initialized with any outstanding changes in the working directory. You may also use -I/--include, -X/--exclude, and/or a list of files after the patch name to add only changes to matching files to the new patch, leaving the rest as uncommitted modifications.

-u/--user and -d/--date can be used to set the (given) user and date, respectively. -U/--currentuser and -D/--currentdate set user to current user and date to current date.

-e/--edit, -m/--message or -l/--logfile set the patch header as well as the commit message. If none is specified, the header is empty and the commit message is '[mq]: PATCH'.

Use the -g/--git option to keep the patch in the git extended diff format. Read the diffs help topic for more information on why this is important for preserving permission changes and copy/rename information.

Returns 0 on successful creation of a new patch.

Options:

-e, --edit edit commit message

-f, --force import uncommitted changes (DEPRECATED)

-g, --git use git extended diff format

-U, --currentuser add "From: <current user>" to patch

-u, --user add "From: <USER>" to patch

-D, --currentdate add "Date: <current date>" to patch

-d, --date add "Date: <DATE>" to patch

-I, --include include names matching the given patterns

-X, --exclude exclude names matching the given patterns

-m, --message use text as commit message

-l, --logfile read commit message from file

qnext hg qnext [-s]

Returns 0 on success.

Options:

-s, --summary print first line of patch header

qpop hg qpop [-a] [-f] [PATCH | INDEX]

Without argument, pops off the top of the patch stack. If given a patch name, keeps popping off patches until the named patch is at the top of the stack.

By default, abort if the working directory contains uncommitted changes. With --keep-changes, abort only if the uncommitted files overlap with patched files. With -f/--force, backup and discard changes made to such files.

Return 0 on success.

Options:

-a, --all pop all patches

-n, --name queue name to pop (DEPRECATED)

--keep-changes tolerate non-conflicting local changes

-f, --force forget any local changes to patched files

--no-backup do not save backup copies of files

qprev hg qprev [-s]

Returns 0 on success.

Options:

-s, --summary print first line of patch header

qpush hg qpush [-f] [-l] [-a] [--move] [PATCH | INDEX]

By default, abort if the working directory contains uncommitted changes. With --keep-changes, abort only if the uncommitted files overlap with patched files. With -f/--force, backup and patch over uncommitted changes.

Return 0 on success.

Options:

--keep-changes tolerate non-conflicting local changes

-f, --force apply on top of local changes

-e, --exact apply the target patch to its recorded parent

-l, --list list patch name in commit text

-a, --all apply all patches

-m, --merge merge from another queue (DEPRECATED)

-n, --name merge queue name (DEPRECATED)

--move reorder patch series and apply only the patch

--no-backup do not save backup copies of files

qqueue hg qqueue [OPTION] [QUEUE]

Supports switching between different patch queues, as well as creating new patch queues and deleting existing ones.

Omitting a queue name or specifying -l/--list will show you the registered queues - by default the "normal" patches queue is registered. The currently active queue will be marked with "(active)". Specifying --active will print only the name of the active queue.

To create a new queue, use -c/--create. The queue is automatically made active, except in the case where there are applied patches from the currently active queue in the repository. Then the queue will only be created and switching will fail.

To delete an existing queue, use --delete. You cannot delete the currently active queue.

Returns 0 on success.

Options:

-l, --list list all available queues

--active print name of active queue

-c, --create create new queue

--rename rename active queue

--delete delete reference to queue

--purge delete queue, and remove patch dir

qrefresh hg qrefresh [-I] [-X] [-e] [-m TEXT] [-l FILE] [-s] [FILE]...

If any file patterns are provided, the refreshed patch will contain only the modifications that match those patterns; the remaining modifications will remain in the working directory.

If -s/--short is specified, files currently included in the patch will be refreshed just like matched files and remain in the patch.

If -e/--edit is specified, Mercurial will start your configured editor for you to enter a message. In case qrefresh fails, you will find a backup of your message in .hg/last-message.txt.

hg add/remove/copy/rename work as usual, though you might want to use git-style patches (-g/--git or [diff] git=1) to track copies and renames. See the diffs help topic for more information on the git diff format.

Returns 0 on success.

Options:

-e, --edit edit commit message

-g, --git use git extended diff format

-s, --short refresh only files already in the patch and specified files

-U, --currentuser add/update author field in patch with current user

-u, --user add/update author field in patch with given user

-D, --currentdate add/update date field in patch with current date

-d, --date add/update date field in patch with given date

-I, --include include names matching the given patterns

-X, --exclude exclude names matching the given patterns

-m, --message use text as commit message

-l, --logfile read commit message from file

qrename hg qrename PATCH1 [PATCH2]

With one argument, renames the current patch to PATCH1. With two arguments, renames PATCH1 to PATCH2.

Returns 0 on success.

aliases: qmv

qrestore hg qrestore [-d] [-u] REV

This command is deprecated, use hg rebase instead.

Options:

-d, --delete delete save entry

-u, --update update queue working directory

qsave hg qsave [-m TEXT] [-l FILE] [-c] [-n NAME] [-e] [-f]

This command is deprecated, use hg rebase instead.

Options:

-c, --copy copy patch directory

-n, --name copy directory name

-e, --empty clear queue status file

-f, --force force copy

-m, --message use text as commit message

-l, --logfile read commit message from file

qselect hg qselect [OPTION]... [GUARD]...

Use the hg qguard command to set or print guards on patch, then use qselect to tell mq which guards to use. A patch will be pushed if it has no guards or any positive guards match the currently selected guard, but will not be pushed if any negative guards match the current guard. For example:

qguard foo.patch -- -stable (negative guard) qguard bar.patch +stable (positive guard) qselect stable

This activates the "stable" guard. mq will skip foo.patch (because it has a negative match) but push bar.patch (because it has a positive match).

With no arguments, prints the currently active guards. With one argument, sets the active guard.

Use -n/--none to deactivate guards (no other arguments needed). When no guards are active, patches with positive guards are skipped and patches with negative guards are pushed.

qselect can change the guards on applied patches. It does not pop guarded patches by default. Use --pop to pop back to the last applied patch that is not guarded. Use --reapply (which implies --pop) to push back to the current patch afterwards, but skip guarded patches.

Use -s/--series to print a list of all guards in the series file (no other arguments needed). Use -v for more information.

Returns 0 on success.

Options:

-n, --none disable all guards

-s, --series list all guards in series file

--pop pop to before first guarded applied patch

--reapply pop, then reapply patches

qseries hg qseries [-ms]

Returns 0 on success.

Options:

-m, --missing print patches not in series

-s, --summary print first line of patch header

qtop hg qtop [-s]

Returns 0 on success.

Options:

-s, --summary print first line of patch header

qunapplied hg qunapplied [-1] [-s] [PATCH]

Returns 0 on success.

Options:

-1, --first show only the first patch

-s, --summary print first line of patch header

strip hg strip [-k] [-f] [-n] [-B bookmark] [-r] REV...

The strip command removes the specified changesets and all their descendants. If the working directory has uncommitted changes, the operation is aborted unless the --force flag is supplied, in which case changes will be discarded.

If a parent of the working directory is stripped, then the working directory will automatically be updated to the most recent available ancestor of the stripped parent after the operation completes.

Any stripped changesets are stored in .hg/strip-backup as a bundle (see hg help bundle and hg help unbundle). They can be restored by running hg unbundle .hg/strip-backup/BUNDLE, where BUNDLE is the bundle file created by the strip. Note that the local revision numbers will in general be different after the restore.

Use the --no-backup option to discard the backup bundle once the operation completes.

Strip is not a history-rewriting operation and can be used on changesets in the public phase. But if the stripped changesets have been pushed to a remote repository you will likely pull them again.

Return 0 on success.

Options:

-r, --rev strip specified revision (optional, can specify revisions without this option)

-f, --force force removal of changesets, discard uncommitted changes (no backup)

-b, --backup bundle only changesets with local revision number greater than REV which are not descendants of REV (DEPRECATED)

--no-backup no backups

--nobackup no backups (DEPRECATED)

-n ignored (DEPRECATED)

-k, --keep do not modify working copy during strip

-B, --bookmark remove revs only reachable from given bookmark

notify hooks for sending email push notifications

This extension implements hooks to send email notifications when changesets are sent from or received by the local repository.

First, enable the extension as explained in hg help extensions, and register the hook you want to run. incoming and changegroup hooks are run when changesets are received, while outgoing hooks are for changesets sent to another repository:

[hooks] # one email for each incoming changeset incoming.notify = python:hgext.notify.hook # one email for all incoming changesets changegroup.notify = python:hgext.notify.hook

# one email for all outgoing changesets outgoing.notify = python:hgext.notify.hook

This registers the hooks. To enable notification, subscribers must be assigned to repositories. The [usersubs] section maps multiple repositories to a given recipient. The [reposubs] section maps multiple recipients to a single repository:

[usersubs] # key is subscriber email, value is a comma-separated list of repo patterns user@host = pattern

[reposubs] # key is repo pattern, value is a comma-separated list of subscriber emails pattern = user@host

A pattern is a glob matching the absolute path to a repository, optionally combined with a revset expression. A revset expression, if present, is separated from the glob by a hash. Example:

[reposubs] */widgets#branch(release) = qa-team@example.com

This sends to qa-team@example.com whenever a changeset on the release branch triggers a notification in any repository ending in widgets.

In order to place them under direct user management, [usersubs] and [reposubs] sections may be placed in a separate hgrc file and incorporated by reference:

[notify] config = /path/to/subscriptionsfile

Notifications will not be sent until the notify.test value is set to False; see below.

Notifications content can be tweaked with the following configuration entries:

notify.test If True, print messages to stdout instead of sending them. Default: True.

notify.sources Space-separated list of change sources. Notifications are activated only when a changeset's source is in this list. Sources may be:

serve

changesets received via http or ssh

pull

changesets received via hg pull

unbundle

changesets received via hg unbundle

push

changesets sent or received via hg push

bundle

changesets sent via hg unbundle

Default: serve.

notify.strip Number of leading slashes to strip from url paths. By default, notifications reference repositories with their absolute path. notify.strip lets you turn them into relative paths. For example, notify.strip=3 will change /long/path/repository into repository. Default: 0.

notify.domain Default email domain for sender or recipients with no explicit domain.

notify.style Style file to use when formatting emails.

notify.template Template to use when formatting emails.

notify.incoming Template to use when run as an incoming hook, overriding notify.template.

notify.outgoing Template to use when run as an outgoing hook, overriding notify.template.

notify.changegroup Template to use when running as a changegroup hook, overriding notify.template.

notify.maxdiff Maximum number of diff lines to include in notification email. Set to 0 to disable the diff, or -1 to include all of it. Default: 300.

notify.maxsubject Maximum number of characters in email's subject line. Default: 67.

notify.diffstat Set to True to include a diffstat before diff content. Default: True.

notify.merge If True, send notifications for merge changesets. Default: True.

notify.mbox If set, append mails to this mbox file instead of sending. Default: None.

notify.fromauthor If set, use the committer of the first changeset in a changegroup for the "From" field of the notification mail. If not set, take the user from the pushing repo. Default: False.

If set, the following entries will also be used to customize the notifications:

email.from Email From address to use if none can be found in the generated email content.

web.baseurl Root repository URL to combine with repository paths when making references. See also notify.strip.

pager browse command output with an external pager

To set the pager that should be used, set the application variable:

[pager] pager = less -FRX

If no pager is set, the pager extensions uses the environment variable $PAGER. If neither pager.pager, nor $PAGER is set, no pager is used.

You can disable the pager for certain commands by adding them to the pager.ignore list:

[pager] ignore = version, help, update

You can also enable the pager only for certain commands using pager.attend. Below is the default list of commands to be paged:

[pager] attend = annotate, cat, diff, export, glog, log, qdiff

Setting pager.attend to an empty value will cause all commands to be paged.

If pager.attend is present, pager.ignore will be ignored.

To ignore global commands like hg version or hg help, you have to specify them in your user configuration file.

The --pager=... option can also be used to control when the pager is used. Use a boolean value like yes, no, on, off, or use auto for normal behavior.

patchbomb command to send changesets as (a series of) patch emails

The series is started off with a "[PATCH 0 of N]" introduction, which describes the series as a whole.

Each patch email has a Subject line of "[PATCH M of N] ...", using the first line of the changeset description as the subject text. The message contains two or three body parts:

• The changeset description.

• [Optional] The result of running diffstat on the patch.

• The patch itself, as generated by hg export.

Each message refers to the first in the series using the In-Reply-To and References headers, so they will show up as a sequence in threaded mail and news readers, and in mail archives.

To configure other defaults, add a section like this to your configuration file:

[email] from = My Name <my@email> to = recipient1, recipient2, ... cc = cc1, cc2, ... bcc = bcc1, bcc2, ... reply-to = address1, address2, ...

Use [patchbomb] as configuration section name if you need to override global [email] address settings.

Then you can use the hg email command to mail a series of changesets as a patchbomb.

You can also either configure the method option in the email section to be a sendmail compatible mailer or fill out the [smtp] section so that the patchbomb extension can automatically send patchbombs directly from the commandline. See the [email] and [smtp] sections in hgrc(5) for details.

Commands email hg email [OPTION]... [DEST]...

By default, diffs are sent in the format generated by hg export, one per message. The series starts with a "[PATCH 0 of N]" introduction, which describes the series as a whole.

Each patch email has a Subject line of "[PATCH M of N] ...", using the first line of the changeset description as the subject text. The message contains two or three parts. First, the changeset description.

With the -d/--diffstat option, if the diffstat program is installed, the result of running diffstat on the patch is inserted.

Finally, the patch itself, as generated by hg export.

With the -d/--diffstat or --confirm options, you will be presented with a final summary of all messages and asked for confirmation before the messages are sent.

By default the patch is included as text in the email body for easy reviewing. Using the -a/--attach option will instead create an attachment for the patch. With -i/--inline an inline attachment will be created. You can include a patch both as text in the email body and as a regular or an inline attachment by combining the -a/--attach or -i/--inline with the --body option.

With -o/--outgoing, emails will be generated for patches not found in the destination repository (or only those which are ancestors of the specified revisions if any are provided)

With -b/--bundle, changesets are selected as for --outgoing, but a single email containing a binary Mercurial bundle as an attachment will be sent.

With -m/--mbox, instead of previewing each patchbomb message in a pager or sending the messages directly, it will create a UNIX mailbox file with the patch emails. This mailbox file can be previewed with any mail user agent which supports UNIX mbox files.

With -n/--test, all steps will run, but mail will not be sent. You will be prompted for an email recipient address, a subject and an introductory message describing the patches of your patchbomb. Then when all is done, patchbomb messages are displayed. If the PAGER environment variable is set, your pager will be fired up once for each patchbomb message, so you can verify everything is alright.

In case email sending fails, you will find a backup of your series introductory message in .hg/last-email.txt.

Examples:

hg email -r 3000 # send patch 3000 only hg email -r 3000 -r 3001 # send patches 3000 and 3001 hg email -r 3000:3005 # send patches 3000 through 3005 hg email 3000 # send patch 3000 (deprecated)

hg email -o # send all patches not in default hg email -o DEST # send all patches not in DEST hg email -o -r 3000 # send all ancestors of 3000 not in default hg email -o -r 3000 DEST # send all ancestors of 3000 not in DEST

hg email -b # send bundle of all patches not in default hg email -b DEST # send bundle of all patches not in DEST hg email -b -r 3000 # bundle of all ancestors of 3000 not in default hg email -b -r 3000 DEST # bundle of all ancestors of 3000 not in DEST

hg email -o -m mbox && # generate an mbox file... mutt -R -f mbox # ... and view it with mutt hg email -o -m mbox && # generate an mbox file ... formail -s sendmail \ # ... and use formail to send from the mbox -bm -t < mbox # ... using sendmail

Before using this command, you will need to enable email in your hgrc. See the [email] section in hgrc(5) for details.

Options:

-g, --git use git extended diff format

--plain omit hg patch header

-o, --outgoing send changes not found in the target repository

-b, --bundle send changes not in target as a binary bundle

--bundlename name of the bundle attachment file (default: bundle)

-r, --rev a revision to send

--force run even when remote repository is unrelated (with -b/--bundle)

--base a base changeset to specify instead of a destination (with -b/--bundle)

--intro send an introduction email for a single patch

--body send patches as inline message text (default)

-a, --attach send patches as attachments

-i, --inline send patches as inline attachments

--bcc email addresses of blind carbon copy recipients

-c, --cc email addresses of copy recipients

--confirm ask for confirmation before sending

-d, --diffstat add diffstat output to messages

--date use the given date as the sending date

--desc use the given file as the series description

-f, --from email address of sender

-n, --test print messages that would be sent

-m, --mbox write messages to mbox file instead of sending them

--reply-to email addresses replies should be sent to

-s, --subject subject of first message (intro or single patch)

--in-reply-to message identifier to reply to

--flag flags to add in subject prefixes

-t, --to email addresses of recipients

-e, --ssh specify ssh command to use

--remotecmd specify hg command to run on the remote side

--insecure do not verify server certificate (ignoring web.cacerts config)

progress show progress bars for some actions

This extension uses the progress information logged by hg commands to draw progress bars that are as informative as possible. Some progress bars only offer indeterminate information, while others have a definite end point.

The following settings are available:

[progress] delay = 3 # number of seconds (float) before showing the progress bar changedelay = 1 # changedelay: minimum delay before showing a new topic. # If set to less than 3 * refresh, that value will # be used instead. refresh = 0.1 # time in seconds between refreshes of the progress bar format = topic bar number estimate # format of the progress bar width = <none> # if set, the maximum width of the progress information # (that is, min(width, term width) will be used) clear-complete = True # clear the progress bar after it's done disable = False # if true, don't show a progress bar assume-tty = False # if true, ALWAYS show a progress bar, unless # disable is given

Valid entries for the format field are topic, bar, number, unit, estimate, speed, and item. item defaults to the last 20 characters of the item, but this can be changed by adding either -<num> which would take the last num characters, or +<num> for the first num characters.

purge command to delete untracked files from the working directory

Commands purge hg purge [OPTION]... [DIR]...

Delete files not known to Mercurial. This is useful to test local and uncommitted changes in an otherwise-clean source tree.

This means that purge will delete:

• Unknown files: files marked with "?" by hg status

• Empty directories: in fact Mercurial ignores directories unless they contain files under source control management

But it will leave untouched:

• Modified and unmodified tracked files

• Ignored files (unless --all is specified)

• New files added to the repository (with hg add)

If directories are given on the command line, only files in these directories are considered.

Be careful with purge, as you could irreversibly delete some files you forgot to add to the repository. If you only want to print the list of files that this program would delete, use the --print option.

Options:

-a, --abort-on-err abort if an error occurs

--all purge ignored files too

-p, --print print filenames instead of deleting them

-0, --print0 end filenames with NUL, for use with xargs (implies -p/--print)

-I, --include include names matching the given patterns

-X, --exclude exclude names matching the given patterns

aliases: clean

rebase command to move sets of revisions to a different ancestor

This extension lets you rebase changesets in an existing Mercurial repository.

For more information: http://mercurial.selenic.com/wiki/RebaseExtension

Commands rebase hg rebase [-s REV | -b REV] [-d REV] [OPTION]

Rebase uses repeated merging to graft changesets from one part of history (the source) onto another (the destination). This can be useful for linearizing local changes relative to a master development tree.

You should not rebase changesets that have already been shared with others. Doing so will force everybody else to perform the same rebase or they will end up with duplicated changesets after pulling in your rebased changesets.

In its default configuration, Mercurial will prevent you from rebasing published changes. See hg help phases for details.

If you don't specify a destination changeset (-d/--dest), rebase uses the tipmost head of the current named branch as the destination. (The destination changeset is not modified by rebasing, but new changesets are added as its descendants.)

You can specify which changesets to rebase in two ways: as a "source" changeset or as a "base" changeset. Both are shorthand for a topologically related set of changesets (the "source branch"). If you specify source (-s/--source), rebase will rebase that changeset and all of its descendants onto dest. If you specify base (-b/--base), rebase will select ancestors of base back to but not including the common ancestor with dest. Thus, -b is less precise but more convenient than -s: you can specify any changeset in the source branch, and rebase will select the whole branch. If you specify neither -s nor -b, rebase uses the parent of the working directory as the base.

For advanced usage, a third way is available through the --rev option. It allows you to specify an arbitrary set of changesets to rebase. Descendants of revs you specify with this option are not automatically included in the rebase.

By default, rebase recreates the changesets in the source branch as descendants of dest and then destroys the originals. Use --keep to preserve the original source changesets. Some changesets in the source branch (e.g. merges from the destination branch) may be dropped if they no longer contribute any change.

One result of the rules for selecting the destination changeset and source branch is that, unlike merge, rebase will do nothing if you are at the latest (tipmost) head of a named branch with two heads. You need to explicitly specify source and/or destination (or update to the other head, if it's the head of the intended source branch).

If a rebase is interrupted to manually resolve a merge, it can be continued with --continue/-c or aborted with --abort/-a.

Returns 0 on success, 1 if nothing to rebase.

Options:

-s, --source rebase from the specified changeset

-b, --base rebase from the base of the specified changeset (up to greatest common ancestor of base and dest)

-r, --rev rebase these revisions

-d, --dest rebase onto the specified changeset

--collapse collapse the rebased changesets

-m, --message use text as collapse commit message

-e, --edit invoke editor on commit messages

-l, --logfile read collapse commit message from file

--keep keep original changesets

--keepbranches keep original branch names

-D, --detach (DEPRECATED)

-t, --tool specify merge tool

-c, --continue continue an interrupted rebase

-a, --abort abort an interrupted rebase

--style display using template map file

--template display with template

record commands to interactively select changes for commit/qrefresh

Commands qrecord hg qrecord [OPTION]... PATCH [FILE]...

See hg help qnew & hg help record for more information and usage.

record hg record [OPTION]... [FILE]...

If a list of files is omitted, all changes reported by hg status will be candidates for recording.

See hg help dates for a list of formats valid for -d/--date.

You will be prompted for whether to record changes to each modified file, and for files with multiple changes, for each change to use. For each query, the following responses are possible:

y - record this change n - skip this change e - edit this change manually

s - skip remaining changes to this file f - record remaining changes to this file

d - done, skip remaining changes and files a - record all changes to all remaining files q - quit, recording no changes

? - display help

This command is not available when committing a merge.

Options:

-A, --addremove mark new/missing files as added/removed before committing

--close-branch mark a branch as closed, hiding it from the branch list

--amend amend the parent of the working dir

-I, --include include names matching the given patterns

-X, --exclude exclude names matching the given patterns

-m, --message use text as commit message

-l, --logfile read commit message from file

-d, --date record the specified date as commit date

-u, --user record the specified user as committer

-S, --subrepos recurse into subrepositories

-w, --ignore-all-space ignore white space when comparing lines

-b, --ignore-space-change ignore changes in the amount of white space

-B, --ignore-blank-lines ignore changes whose lines are all blank

relink recreates hardlinks between repository clones

Commands relink hg relink [ORIGIN]

When repositories are cloned locally, their data files will be hardlinked so that they only use the space of a single repository.

Unfortunately, subsequent pulls into either repository will break hardlinks for any files touched by the new changesets, even if both repositories end up pulling the same changes.

Similarly, passing --rev to "hg clone" will fail to use any hardlinks, falling back to a complete copy of the source repository.

This command lets you recreate those hardlinks and reclaim that wasted space.

This repository will be relinked to share space with ORIGIN, which must be on the same local disk. If ORIGIN is omitted, looks for "default-relink", then "default", in [paths].

Do not attempt any read operations on this repository while the command is running. (Both repositories will be locked against writes.)

schemes extend schemes with shortcuts to repository swarms

This extension allows you to specify shortcuts for parent URLs with a lot of repositories to act like a scheme, for example:

[schemes] py = http://code.python.org/hg/

After that you can use it like:

hg clone py://trunk/

Additionally there is support for some more complex schemas, for example used by Google Code:

[schemes] gcode = http://{1}.googlecode.com/hg/

The syntax is taken from Mercurial templates, and you have unlimited number of variables, starting with {1} and continuing with {2}, {3} and so on. This variables will receive parts of URL supplied, split by /. Anything not specified as {part} will be just appended to an URL.

For convenience, the extension adds these schemes by default:

[schemes] py = http://hg.python.org/ bb = https://bitbucket.org/ bb+ssh = ssh://hg@bitbucket.org/ gcode = https://{1}.googlecode.com/hg/ kiln = https://{1}.kilnhg.com/Repo/

You can override a predefined scheme by defining a new scheme with the same name.

share share a common history between several working directories

Commands share hg share [-U] SOURCE [DEST]

Initialize a new repository and working directory that shares its history with another repository.

Note using rollback or extensions that destroy/modify history (mq, rebase, etc.) can cause considerable confusion with shared clones. In particular, if two shared clones are both updated to the same changeset, and one of them destroys that changeset with rollback, the other clone will suddenly stop working: all operations will fail with "abort: working directory has unknown parent". The only known workaround is to use debugsetparents on the broken clone to reset it to a changeset that still exists (e.g. tip).

Options:

-U, --noupdate do not create a working copy

unshare hg unshare

Copy the store data to the repo and remove the sharedpath data.

transplant command to transplant changesets from another branch

This extension allows you to transplant changes to another parent revision, possibly in another repository. The transplant is done using 'diff' patches.

Transplanted patches are recorded in .hg/transplant/transplants, as a map from a changeset hash to its hash in the source repository.

Commands transplant hg transplant [-s REPO] [-b BRANCH [-a]] [-p REV] [-m REV] [REV]...

Selected changesets will be applied on top of the current working directory with the log of the original changeset. The changesets are copied and will thus appear twice in the history with different identities.

Consider using the graft command if everything is inside the same repository - it will use merges and will usually give a better result. Use the rebase extension if the changesets are unpublished and you want to move them instead of copying them.

If --log is specified, log messages will have a comment appended of the form:

(transplanted from CHANGESETHASH)

You can rewrite the changelog message with the --filter option. Its argument will be invoked with the current changelog message as $1 and the patch as $2.

--source/-s specifies another repository to use for selecting changesets, just as if it temporarily had been pulled. If --branch/-b is specified, these revisions will be used as heads when deciding which changsets to transplant, just as if only these revisions had been pulled. If --all/-a is specified, all the revisions up to the heads specified with --branch will be transplanted.

Example:

• transplant all changes up to REV on top of your current revision:

hg transplant --branch REV --all

You can optionally mark selected transplanted changesets as merge changesets. You will not be prompted to transplant any ancestors of a merged transplant, and you can merge descendants of them normally instead of transplanting them.

Merge changesets may be transplanted directly by specifying the proper parent changeset by calling hg transplant --parent.

If no merges or revisions are provided, hg transplant will start an interactive changeset browser.

If a changeset application fails, you can fix the merge by hand and then resume where you left off by calling hg transplant --continue/-c.

Options:

-s, --source transplant changesets from REPO

-b, --branch use this source changeset as head

-a, --all pull all changesets up to the --branch revisions

-p, --prune skip over REV

-m, --merge merge at REV

--parent parent to choose when transplanting merge

-e, --edit invoke editor on commit messages

--log append transplant info to log message

-c, --continue continue last transplant session after fixing conflicts

--filter filter changesets through command

win32mbcs allow the use of MBCS paths with problematic encodings

Some MBCS encodings are not good for some path operations (i.e. splitting path, case conversion, etc.) with its encoded bytes. We call such a encoding (i.e. shift_jis and big5) as "problematic encoding". This extension can be used to fix the issue with those encodings by wrapping some functions to convert to Unicode string before path operation.

This extension is useful for:

• Japanese Windows users using shift_jis encoding.

• Chinese Windows users using big5 encoding.

• All users who use a repository with one of problematic encodings on case-insensitive file system.

This extension is not needed for:

• Any user who use only ASCII chars in path.

• Any user who do not use any of problematic encodings.

Note that there are some limitations on using this extension:

• You should use single encoding in one repository.

• If the repository path ends with 0x5c, .hg/hgrc cannot be read.

• win32mbcs is not compatible with fixutf8 extension.

By default, win32mbcs uses encoding.encoding decided by Mercurial. You can specify the encoding by config option:

[win32mbcs] encoding = sjis

It is useful for the users who want to commit with UTF-8 log message.

win32text perform automatic newline conversion

Deprecation: The win32text extension requires each user to configure the extension again and again for each clone since the configuration is not copied when cloning.

We have therefore made the eol as an alternative. The eol uses a version controlled file for its configuration and each clone will therefore use the right settings from the start.

To perform automatic newline conversion, use:

[extensions] win32text = [encode] ** = cleverencode: # or ** = macencode:

[decode] ** = cleverdecode: # or ** = macdecode:

If not doing conversion, to make sure you do not commit CRLF/CR by accident:

[hooks] pretxncommit.crlf = python:hgext.win32text.forbidcrlf # or pretxncommit.cr = python:hgext.win32text.forbidcr

To do the same check on a server to prevent CRLF/CR from being pushed or pulled:

[hooks] pretxnchangegroup.crlf = python:hgext.win32text.forbidcrlf # or pretxnchangegroup.cr = python:hgext.win32text.forbidcr

zeroconf discover and advertise repositories on the local network

Zeroconf-enabled repositories will be announced in a network without the need to configure a server or a service. They can be discovered without knowing their actual IP address.

To allow other people to discover your repository using run hg serve in your repository:

$ cd test $ hg serve

You can discover Zeroconf-enabled repositories by running hg paths:

$ hg paths zc-test = http://example.com:8000/test