add

add the specified files on the next commit:

hg add [OPTION]... [FILE]...

Schedule files to be version controlled and added to the repository.

The files will be added to the repository at the next commit. To undo an add before that, see hg forget.

If no names are given, add all files to the repository (except files matching .hgignore).

Returns 0 if all files are successfully added.

Options:

[+] marked option can be specified multiple times

addremove

add all new files, delete all missing files:

hg addremove [OPTION]... [FILE]...

Add all new files and remove all missing files from the repository.

Unless names are given, new files are ignored if they match any of the patterns in .hgignore. As with add, these changes take effect at the next commit.

Use the -s/--similarity option to detect renamed files. This option takes a percentage between 0 (disabled) and 100 (files must be identical) as its parameter. With a parameter greater than 0, this compares every removed file with every added file and records those similar enough as renames. Detecting renamed files this way can be expensive. After using this option, hg status -C can be used to check which files were identified as moved or renamed. If not specified, -s/--similarity defaults to 100 and only renames of identical files are detected.

Returns 0 if all files are successfully added.

Options:

[+] marked option can be specified multiple times

annotate

show changeset information by line for each file:

hg annotate [-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...

List changes in files, showing the revision id responsible for each line.

This command is useful for discovering when a change was made and by whom.

If you include --file, --user, or --date, the revision number is suppressed unless you also include --number.

Without the -a/--text option, annotate will avoid processing files it detects as binary. With -a, annotate will annotate the file anyway, although the results will probably be neither useful nor desirable.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

aliases: blame

archive

create an unversioned archive of a repository revision:

hg archive [OPTION]... DEST

By default, the revision used is the parent of the working directory; use -r/--rev to specify a different revision.

The archive type is automatically detected based on file extension (to override, use -t/--type).

Valid types are:

The exact name of the destination archive or directory is given using a format string; see hg help export for details.

Each member added to an archive file has a directory prefix prepended. Use -p/--prefix to specify a format string for the prefix. The default is the basename of the archive, with suffixes removed.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

backout

reverse effect of earlier changeset:

hg backout [OPTION]... [-r] REV

Prepare a new changeset with the effect of REV undone in the current working directory. If no conflicts were encountered, it will be committed immediately.

If REV is the parent of the working directory, then this new changeset is committed automatically (unless --no-commit is specified).

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

See hg help revert for a way to restore files to the state of another revision.

Returns 0 on success, 1 if nothing to backout or there are unresolved files.

Options:

[+] marked option can be specified multiple times

bisect

subdivision search of changesets:

hg bisect [-gbsr] [-U] [-c CMD] [REV]

This command helps to find changesets which introduce problems. To use, mark the earliest changeset you know exhibits the problem as bad, then mark the latest changeset which is free from the problem as good. Bisect will update your working directory to a revision for testing (unless the -U/--noupdate option is specified). Once you have performed tests, mark the working directory as good or bad, and bisect will either update to another candidate changeset or announce that it has found the bad revision.

As a shortcut, you can also use the revision argument to mark a revision as good or bad without checking it out first.

If you supply a command, it will be used for automatic bisection. The environment variable HG_NODE will contain the ID of the changeset being tested. The exit status of the command will be used to mark revisions as good or bad: status 0 means good, 125 means to skip the revision, 127 (command not found) will abort the bisection, and any other non-zero exit status means the revision is bad.

Returns 0 on success.

Options:

bookmarks

create a new bookmark or list existing bookmarks:

hg bookmarks [OPTIONS]... [NAME]...

Bookmarks are labels on changesets to help track lines of development. Bookmarks are unversioned and can be moved, renamed and deleted. Deleting or moving a bookmark has no effect on the associated changesets.

Creating or updating to a bookmark causes it to be marked as 'active'. The active bookmark is indicated with a '*'. When a commit is made, the active bookmark will advance to the new commit. A plain hg update will also advance an active bookmark, if possible. Updating away from a bookmark will cause it to be deactivated.

Bookmarks can be pushed and pulled between repositories (see hg help push and hg help pull). If a shared bookmark has diverged, a new 'divergent bookmark' of the form 'name@path' will be created. Using hg merge will resolve the divergence.

A bookmark named '@' has the special property that hg clone will check it out by default if it exists.

Options:

branch

set or show the current branch name:

hg branch [-fC] [NAME]

With no argument, show the current branch name. With one argument, set the working directory branch name (the branch will not exist in the repository until the next commit). Standard practice recommends that primary development take place on the 'default' branch.

Unless -f/--force is specified, branch will not let you set a branch name that already exists.

Use -C/--clean to reset the working directory branch to that of the parent of the working directory, negating a previous branch change.

Use the command hg update to switch to an existing branch. Use hg commit --close-branch to mark this branch head as closed. When all heads of a branch are closed, the branch will be considered closed.

Returns 0 on success.

Options:

branches

list repository named branches:

hg branches [-c]

List the repository's named branches, indicating which ones are inactive. If -c/--closed is specified, also list branches which have been marked closed (see hg commit --close-branch).

Use the command hg update to switch to an existing branch.

Returns 0.

Options:

bundle

create a changegroup file:

hg bundle [-f] [-t TYPE] [-a] [-r REV]... [--base REV]... FILE [DEST]

Generate a changegroup file collecting changesets to be added to a repository.

To create a bundle containing all changesets, use -a/--all (or --base null). Otherwise, hg assumes the destination will have all the nodes you specify with --base parameters. Otherwise, hg will assume the repository has all the nodes in destination, or default-push/default if no destination is specified.

You can change bundle format with the -t/--type option. You can specify a compression, a bundle version or both using a dash (comp-version). The available compression methods are: none, bzip2, and gzip (by default, bundles are compressed using bzip2). The available formats are: v1, v2 (default to most suitable).

The bundle file can then be transferred using conventional means and applied to another repository with the unbundle or pull command. This is useful when direct push and pull are not available or when exporting an entire repository is undesirable.

Applying bundles preserves all changeset contents including permissions, copy/rename information, and revision history.

Returns 0 on success, 1 if no changes found.

Options:

[+] marked option can be specified multiple times

cat

output the current or given revision of files:

hg cat [OPTION]... FILE...

Print the specified files as they were at the given revision. If no revision is given, the parent of the working directory is used.

Output may be to a file, in which case the name of the file is given using a format string. The formatting rules as follows:

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

clone

make a copy of an existing repository:

hg clone [OPTION]... SOURCE [DEST]

Create a copy of an existing repository in a new directory.

If no destination directory name is specified, it defaults to the basename of the source.

The location of the source is added to the new repository's .hg/hgrc file, as the default to be used for future pulls.

Only local paths and ssh:// URLs are supported as destinations. For ssh:// destinations, no working directory or .hg/hgrc will be created on the remote side.

If the source repository has a bookmark called '@' set, that revision will be checked out in the new repository by default.

To check out a particular version, use -u/--update, or -U/--noupdate to create a clone with no working directory.

To pull only a subset of changesets, specify one or more revisions identifiers with -r/--rev or branches with -b/--branch. The resulting clone will contain only the specified changesets and their ancestors. These options (or 'clone src#rev dest') imply --pull, even for local source repositories.

$ cp -al REPO REPOCLONE

See hg help urls for details on specifying URLs.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

commit

commit the specified files or all outstanding changes:

hg commit [OPTION]... [FILE]...

Commit changes to the given files into the repository. Unlike a centralized SCM, this operation is a local operation. See hg push for a way to actively distribute your changes.

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

If you are committing the result of a merge, do not provide any filenames or -I/-X filters.

If no commit message is specified, Mercurial starts your configured editor where you can enter a message. In case your commit fails, you will find a backup of your message in .hg/last-message.txt.

The --close-branch flag can be used to mark the current branch head closed. When all heads of a branch are closed, the branch will be considered closed and no longer listed.

The --amend flag can be used to amend the parent of the working directory with a new commit that contains the changes in the parent in addition to those currently reported by hg status, if there are any. The old commit is stored in a backup bundle in .hg/strip-backup (see hg help bundle and hg help unbundle on how to restore it).

Message, user and date are taken from the amended commit unless specified. When a message isn't specified on the command line, the editor will open with the message of the amended commit.

It is not possible to amend public changesets (see hg help phases) or changesets that have children.

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

Returns 0 on success, 1 if nothing changed.

Options:

[+] marked option can be specified multiple times

aliases: ci

config

show combined config settings from all hgrc files:

hg config [-u] [NAME]...

With no arguments, print names and values of all config items.

With one argument of the form section.name, print just the value of that config item.

With multiple arguments, print names and values of all config items with matching section names.

With --edit, start an editor on the user-level config file. With --global, edit the system-wide config file. With --local, edit the repository-level config file.

With --debug, the source (filename and line number) is printed for each config item.

See hg help config for more information about config files.

Returns 0 on success, 1 if NAME does not exist.

Options:

copy

mark files as copied for the next commit:

hg copy [OPTION]... [SOURCE]... DEST

Mark dest as having copies of source files. If dest is a directory, copies are put in that directory. If dest is a file, the source must be a single file.

By default, this command copies the contents of files as they exist in the working directory. If invoked with -A/--after, the operation is recorded, but no copying is performed.

This command takes effect with the next commit. To undo a copy before that, see hg revert.

Returns 0 on success, 1 if errors are encountered.

Options:

[+] marked option can be specified multiple times

aliases: cp

diff

diff repository (or selected files):

hg diff [OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...

Show differences between revisions for the specified files.

Differences between files are shown using the unified diff format.

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 first parent.

Alternatively you can specify -c/--change with a revision to see the changes in that changeset relative to its first parent.

Without the -a/--text option, diff will avoid generating diffs of files it detects as binary. With -a, diff will generate a diff anyway, probably with undesirable results.

Use the -g/--git option to generate diffs in the git extended diff format. For more information, read hg help diffs.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

export

dump the header and diffs for one or more changesets:

hg export [OPTION]... [-o OUTFILESPEC] [-r] [REV]...

Print the changeset header and diffs for one or more revisions. If no revision is given, the parent of the working directory is used.

The information shown in the changeset header is: author, date, branch name (if non-default), changeset hash, parent(s) and commit comment.

Output may be to a file, in which case the name of the file is given using a format string. The formatting rules are as follows:

Without the -a/--text option, export will avoid generating diffs of files it detects as binary. With -a, export will generate a diff anyway, probably with undesirable results.

Use the -g/--git option to generate diffs in the git extended diff format. See hg help diffs for more information.

With the --switch-parent option, the diff will be against the second parent. It can be useful to review a merge.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

files

list tracked files:

hg files [OPTION]... [FILE]...

Print files under Mercurial control in the working directory or specified revision for given files (excluding removed files). Files can be specified as filenames or filesets.

If no files are given to match, this command prints the names of all files under Mercurial control.

See hg help patterns and hg help filesets for more information on specifying file patterns.

Returns 0 if a match is found, 1 otherwise.

Options:

[+] marked option can be specified multiple times

forget

forget the specified files on the next commit:

hg forget [OPTION]... FILE...

Mark the specified files so they will no longer be tracked after the next commit.

This only removes files from the current branch, not from the entire project history, and it does not delete them from the working directory.

To delete the file from the working directory, see hg remove.

To undo a forget before the next commit, see hg add.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

graft

copy changes from other branches onto the current branch:

hg graft [OPTION]... [-r REV]... REV...

This command uses Mercurial's merge logic to copy individual changes from other branches without merging branches in the history graph. This is sometimes known as 'backporting' or 'cherry-picking'. By default, graft will copy user, date, and description from the source changesets.

Changesets that are ancestors of the current revision, that have already been grafted, or that are merges will be skipped.

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

(grafted from CHANGESETHASH)

If --force is specified, revisions will be grafted even if they are already ancestors of or have been grafted to the destination. This is useful when the revisions have since been backed out.

If a graft merge results in conflicts, the graft process is interrupted so that the current merge can be manually resolved. Once all conflicts are addressed, the graft process can be continued with the -c/--continue option.

See hg help revisions and hg help revsets for more about specifying revisions.

Returns 0 on successful completion.

Options:

[+] marked option can be specified multiple times

grep

search revision history for a pattern in specified files:

hg grep [OPTION]... PATTERN [FILE]...

Search revision history for a regular expression in the specified files or the entire project.

By default, grep prints the most recent revision number for each file in which it finds a match. To get it to print every revision that contains a change in match status ("-" for a match that becomes a non-match, or "+" for a non-match that becomes a match), use the --all flag.

PATTERN can be any Python (roughly Perl-compatible) regular expression.

If no FILEs are specified (and -f/--follow isn't set), all files in the repository are searched, including those that don't exist in the current branch or have been deleted in a prior changeset.

Returns 0 if a match is found, 1 otherwise.

Options:

[+] marked option can be specified multiple times

heads

show branch heads:

hg heads [-ct] [-r STARTREV] [REV]...

With no arguments, show all open branch heads in the repository. Branch heads are changesets that have no descendants on the same branch. They are where development generally takes place and are the usual targets for update and merge operations.

If one or more REVs are given, only open branch heads on the branches associated with the specified changesets are shown. This means that you can use hg heads . to see the heads on the currently checked-out branch.

If -c/--closed is specified, also show branch heads marked closed (see hg commit --close-branch).

If STARTREV is specified, only those heads that are descendants of STARTREV will be displayed.

If -t/--topo is specified, named branch mechanics will be ignored and only topological heads (changesets with no children) will be shown.

Returns 0 if matching heads are found, 1 if not.

Options:

help

show help for a given topic or a help overview:

hg help [-ecks] [TOPIC]

With no arguments, print a list of commands with short help messages.

Given a topic, extension, or command name, print help for that topic.

Returns 0 if successful.

Options:

[+] marked option can be specified multiple times

identify

identify the working directory or specified revision:

hg identify [-nibtB] [-r REV] [SOURCE]

Print a summary identifying the repository state at REV using one or two parent hash identifiers, followed by a "+" if the working directory has uncommitted changes, the branch name (if not default), a list of tags, and a list of bookmarks.

When REV is not given, print a summary of the current state of the repository.

Specifying a path to a repository root or Mercurial bundle will cause lookup to operate on that repository/bundle.

See hg log for generating more information about specific revisions, including full hash identifiers.

Returns 0 if successful.

Options:

import

import an ordered set of patches:

hg import [OPTION]... PATCH...

Import a list of patches and commit them individually (unless --no-commit is specified).

To read a patch from standard input, use "-" as the patch name. If a URL is specified, the patch will be downloaded from there.

Import first applies changes to the working directory (unless --bypass is specified), import will abort if there are outstanding changes.

Use --bypass to apply and commit patches directly to the repository, without affecting the working directory. Without --exact, patches will be applied on top of the working directory parent revision.

You can import a patch straight from a mail message. Even patches as attachments work (to use the body part, it must have type text/plain or text/x-patch). From and Subject headers of email message are used as default committer and commit message. All text/plain body parts before first diff are added to the commit message.

If the imported patch was generated by hg export, user and description from patch override values from message headers and body. Values given on command line with -m/--message and -u/--user override these.

If --exact is specified, import will set the working directory to the parent of each patch before applying it, and will abort if the resulting changeset has a different ID than the one recorded in the patch. This will guard against various ways that portable patch formats and mail systems might fail to transfer Mercurial data or metadata. See hg bundle for lossless transmission.

Use --partial to ensure a changeset will be created from the patch even if some hunks fail to apply. Hunks that fail to apply will be written to a <target-file>.rej file. Conflicts can then be resolved by hand before hg commit --amend is run to update the created changeset. This flag exists to let people import patches that partially apply without losing the associated metadata (author, date, description, ...).

With -s/--similarity, hg will attempt to discover renames and copies in the patch in the same way as hg addremove.

It is possible to use external patch programs to perform the patch by setting the ui.patch configuration option. For the default internal tool, the fuzz can also be configured via patch.fuzz. See hg help config for more information about configuration files and how to use these options.

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

Returns 0 on success, 1 on partial success (see --partial).

Options:

incoming

show new changesets found in source:

hg incoming [-p] [-n] [-M] [-f] [-r REV]... [--bundle FILENAME] [SOURCE]

Show new changesets found in the specified path/URL or the default pull location. These are the changesets that would have been pulled if a pull at the time you issued this command.

See pull for valid source format details.

BM1               01234567890a added
BM2               1234567890ab advanced
BM3               234567890abc diverged
BM4               34567890abcd changed

Returns 0 if there are incoming changes, 1 otherwise.

Options:

[+] marked option can be specified multiple times

aliases: in

init

create a new repository in the given directory:

hg init [-e CMD] [--remotecmd CMD] [DEST]

Initialize a new repository in the given directory. If the given directory does not exist, it will be created.

If no directory is given, the current directory is used.

It is possible to specify an ssh:// URL as the destination. See hg help urls for more information.

Returns 0 on success.

Options:

locate

locate files matching specific patterns (DEPRECATED):

hg locate [OPTION]... [PATTERN]...

Print files under Mercurial control in the working directory whose names match the given patterns.

By default, this command searches all directories in the working directory. To search just the current directory and its subdirectories, use "--include .".

If no patterns are given to match, this command prints the names of all files under Mercurial control in the working directory.

If you want to feed the output of this command into the "xargs" command, use the -0 option to both this command and "xargs". This will avoid the problem of "xargs" treating single filenames that contain whitespace as multiple filenames.

See hg help files for a more versatile command.

Returns 0 if a match is found, 1 otherwise.

Options:

[+] marked option can be specified multiple times

log

show revision history of entire repository or files:

hg log [OPTION]... [FILE]

Print the revision history of the specified files or the entire project.

If no revision range is specified, the default is tip:0 unless --follow is set, in which case the working directory parent is used as the starting revision.

File history is shown without following rename or copy history of files. Use -f/--follow with a filename to follow history across renames and copies. --follow without a filename will only show ancestors or descendants of the starting revision.

By default this command prints revision number and changeset id, tags, non-trivial parents, user, date and time, and a summary for each commit. When the -v/--verbose switch is used, the list of changed files and full commit message are shown.

With --graph the revisions are shown as an ASCII art DAG with the most recent changeset at the top. 'o' is a changeset, '@' is a working directory parent, 'x' is obsolete, and '+' represents a fork where the changeset from the lines below is a parent of the 'o' merge on the same line.

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

See hg help revisions and hg help revsets for more about specifying and ordering revisions.

See hg help templates for more about pre-packaged styles and specifying custom templates.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

aliases: history

manifest

output the current or given revision of the project manifest:

hg manifest [-r REV]

Print a list of version controlled files for the given revision. If no revision is given, the first parent of the working directory is used, or the null revision if no revision is checked out.

With -v, print file permissions, symlink and executable bits. With --debug, print file revision hashes.

If option --all is specified, the list of all files from all revisions is printed. This includes deleted and renamed files.

Returns 0 on success.

Options:

merge

merge another revision into working directory:

hg merge [-P] [[-r] REV]

The current working directory is updated with all changes made in the requested revision since the last common predecessor revision.

Files that changed between either parent are marked as changed for the next commit and a commit must be performed before any further updates to the repository are allowed. The next commit will have two parents.

--tool can be used to specify the merge tool used for file merges. It overrides the HGMERGE environment variable and your configuration files. See hg help merge-tools for options.

If no revision is specified, the working directory's parent is a head revision, and the current branch contains exactly one other head, the other head is merged with by default. Otherwise, an explicit revision with which to merge with must be provided.

See hg help resolve for information on handling file conflicts.

To undo an uncommitted merge, use hg update --clean . which will check out a clean copy of the original merge parent, losing all changes.

Returns 0 on success, 1 if there are unresolved files.

Options:

outgoing

show changesets not found in the destination:

hg outgoing [-M] [-p] [-n] [-f] [-r REV]... [DEST]

Show changesets not found in the specified destination repository or the default push location. These are the changesets that would be pushed if a push was requested.

See pull for details of valid destination formats.

BM1               01234567890a added
BM2                            deleted
BM3               234567890abc advanced
BM4               34567890abcd diverged
BM5               4567890abcde changed

Returns 0 if there are outgoing changes, 1 otherwise.

Options:

[+] marked option can be specified multiple times

aliases: out

parents

show the parents of the working directory or revision (DEPRECATED):

hg parents [-r REV] [FILE]

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

This command is equivalent to:

hg log -r "p1()+p2()" or
hg log -r "p1(REV)+p2(REV)" or
hg log -r "max(::p1() and file(FILE))+max(::p2() and file(FILE))" or
hg log -r "max(::p1(REV) and file(FILE))+max(::p2(REV) and file(FILE))"

See hg summary and hg help revsets for related information.

Returns 0 on success.

Options:

paths

show aliases for remote repositories:

hg paths [NAME]

Show definition of symbolic path name NAME. If no name is given, show definition of all available names.

Option -q/--quiet suppresses all output when searching for NAME and shows only the path names when listing all definitions.

Path names are defined in the [paths] section of your configuration file and in /etc/mercurial/hgrc. If run inside a repository, .hg/hgrc is used, too.

The path names default and default-push have a special meaning. When performing a push or pull operation, they are used as fallbacks if no location is specified on the command-line. When default-push is set, it will be used for push and default will be used for pull; otherwise default is used as the fallback for both. When cloning a repository, the clone source is written as default in .hg/hgrc.

See hg help urls for more information.

Returns 0 on success.

Options:

phase

set or show the current phase name:

hg phase [-p|-d|-s] [-f] [-r] [REV...]

With no argument, show the phase name of the current revision(s).

With one of -p/--public, -d/--draft or -s/--secret, change the phase value of the specified revisions.

Unless -f/--force is specified, hg phase won't move changeset from a lower phase to an higher phase. Phases are ordered as follows:

public < draft < secret

Returns 0 on success, 1 if some phases could not be changed.

(For more information about the phases concept, see hg help phases.)

Options:

[+] marked option can be specified multiple times

pull

pull changes from the specified source:

hg pull [-u] [-f] [-r REV]... [-e CMD] [--remotecmd CMD] [SOURCE]

Pull changes from a remote repository to a local one.

This finds all changes from the repository at the specified path or URL and adds them to a local repository (the current one unless -R is specified). By default, this does not update the copy of the project in the working directory.

Use hg incoming if you want to see what would have been added by a pull at the time you issued this command. If you then decide to add those changes to the repository, you should use hg pull -r X where X is the last changeset listed by hg incoming.

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

Specifying bookmark as . is equivalent to specifying the active bookmark's name.

Returns 0 on success, 1 if an update had unresolved files.

Options:

[+] marked option can be specified multiple times

push

push changes to the specified destination:

hg push [-f] [-r REV]... [-e CMD] [--remotecmd CMD] [DEST]

Push changesets from the local repository to the specified destination.

This operation is symmetrical to pull: it is identical to a pull in the destination repository from the current one.

By default, push will not allow creation of new heads at the destination, since multiple heads would make it unclear which head to use. In this situation, it is recommended to pull and merge before pushing.

Use --new-branch if you want to allow push to create a new named branch that is not present at the destination. This allows you to only create a new branch without forcing other changes.

If -r/--rev is used, the specified revision and all its ancestors will be pushed to the remote repository.

If -B/--bookmark is used, the specified bookmarked revision, its ancestors, and the bookmark will be pushed to the remote repository. Specifying . is equivalent to specifying the active bookmark's name.

Please see hg help urls for important details about ssh:// URLs. If DESTINATION is omitted, a default path will be used.

Returns 0 if push was successful, 1 if nothing to push.

Options:

[+] marked option can be specified multiple times

recover

roll back an interrupted transaction:

hg recover

Recover from an interrupted commit or pull.

This command tries to fix the repository status after an interrupted operation. It should only be necessary when Mercurial suggests it.

Returns 0 if successful, 1 if nothing to recover or verify fails.

remove

remove the specified files on the next commit:

hg remove [OPTION]... FILE...

Schedule the indicated files for removal from the current branch.

This command schedules the files to be removed at the next commit. To undo a remove before that, see hg revert. To undo added files, see hg forget.

Returns 0 on success, 1 if any warnings encountered.

Options:

[+] marked option can be specified multiple times

aliases: rm

rename

rename files; equivalent of copy + remove:

hg rename [OPTION]... SOURCE... DEST

Mark dest as copies of sources; mark sources for deletion. If dest is a directory, copies are put in that directory. If dest is a file, there can only be one source.

By default, this command copies the contents of files as they exist in the working directory. If invoked with -A/--after, the operation is recorded, but no copying is performed.

This command takes effect at the next commit. To undo a rename before that, see hg revert.

Returns 0 on success, 1 if errors are encountered.

Options:

[+] marked option can be specified multiple times

aliases: move mv

resolve

redo merges or set/view the merge status of files:

hg resolve [OPTION]... [FILE]...

Merges with unresolved conflicts are often the result of non-interactive merging using the internal:merge configuration setting, or a command-line merge tool like diff3. The resolve command is used to manage the files involved in a merge, after hg merge has been run, and before hg commit is run (i.e. the working directory must have two parents). See hg help merge-tools for information on configuring merge tools.

The resolve command can be used in the following ways:

• hg resolve [--tool TOOL] FILE...: attempt to re-merge the specified files, discarding any previous merge attempts. Re-merging is not performed for files already marked as resolved. Use --all/-a to select all unresolved files. --tool can be used to specify the merge tool used for the given files. It overrides the HGMERGE environment variable and your configuration files. Previous file contents are saved with a .orig suffix.
• hg resolve -m [FILE]: mark a file as having been resolved (e.g. after having manually fixed-up the files). The default is to mark all unresolved files.
• hg resolve -u [FILE]...: mark a file as unresolved. The default is to mark all resolved files.
• hg resolve -l: list files which had or still have conflicts. In the printed list, U = unresolved and R = resolved.

Returns 0 on success, 1 if any files fail a resolve attempt.

Options:

[+] marked option can be specified multiple times

revert

restore files to their checkout state:

hg revert [OPTION]... [-r REV] [NAME]...

With no revision specified, revert the specified files or directories to the contents they had in the parent of the working directory. This restores the contents of files to an unmodified state and unschedules adds, removes, copies, and renames. If the working directory has two parents, you must explicitly specify a revision.

Using the -r/--rev or -d/--date options, revert the given files or directories to their states as of a specific revision. Because revert does not change the working directory parents, this will cause these files to appear modified. This can be helpful to "back out" some or all of an earlier change. See hg backout for a related method.

Modified files are saved with a .orig suffix before reverting. To disable these backups, use --no-backup. It is possible to store the backup files in a custom directory relative to the root of the repository by setting the ui.origbackuppath configuration option.

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

See hg help backout for a way to reverse the effect of an earlier changeset.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

rollback

roll back the last transaction (DANGEROUS) (DEPRECATED):

hg rollback

Please use hg commit --amend instead of rollback to correct mistakes in the last commit.

This command should be used with care. There is only one level of rollback, and there is no way to undo a rollback. It will also restore the dirstate at the time of the last transaction, losing any dirstate changes since that time. This command does not alter the working directory.

Transactions are used to encapsulate the effects of all commands that create new changesets or propagate existing changesets into a repository.

This command is not intended for use on public repositories. Once changes are visible for pull by other users, rolling a transaction back locally is ineffective (someone else may already have pulled the changes). Furthermore, a race is possible with readers of the repository; for example an in-progress pull from the repository may fail if a rollback is performed.

Returns 0 on success, 1 if no rollback data is available.

Options:

root

print the root (top) of the current working directory:

hg root

Print the root directory of the current repository.

Returns 0 on success.

serve

start stand-alone webserver:

hg serve [OPTION]...

Start a local HTTP repository browser and pull server. You can use this for ad-hoc sharing and browsing of repositories. It is recommended to use a real web server to serve a repository for longer periods of time.

Please note that the server does not implement access control. This means that, by default, anybody can read from the server and nobody can write to it by default. Set the web.allow_push option to * to allow everybody to push to the server. You should use a real web server if you need to authenticate users.

By default, the server logs accesses to stdout and errors to stderr. Use the -A/--accesslog and -E/--errorlog options to log to files.

To have the server choose a free port number to listen on, specify a port number of 0; in this case, the server will print the port number it uses.

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

status

show changed files in the working directory:

hg status [OPTION]... [FILE]...

Show status of files in the repository. If names are given, only files that match are shown. Files that are clean or ignored or the source of a copy/move operation, are not listed unless -c/--clean, -i/--ignored, -C/--copies or -A/--all are given. Unless options described with "show only ..." are given, the options -mardu are used.

Option -q/--quiet hides untracked (unknown and ignored) files unless explicitly requested with -u/--unknown or -i/--ignored.

If one revision is given, it is used as the base revision. If two revisions are given, the differences between them are shown. The --change option can also be used as a shortcut to list the changed files of a revision from its first parent.

The codes used to show the status of files are:

M = modified
A = added
R = removed
C = clean
! = missing (deleted by non-hg command, but still tracked)
? = not tracked
I = ignored
  = origin of the previous file (with --copies)

Returns 0 on success.

Options:

[+] marked option can be specified multiple times

aliases: st

summary

summarize working directory state:

hg summary [--remote]

This generates a brief summary of the working directory state, including parents, branch, commit status, phase and available updates.

With the --remote option, this will check the default paths for incoming and outgoing changes. This can be time-consuming.

Returns 0 on success.

Options:

tag

add one or more tags for the current or given revision:

hg tag [-f] [-l] [-m TEXT] [-d DATE] [-u USER] [-r REV] NAME...

Name a particular revision using <name>.

Tags are used to name particular revisions of the repository and are very useful to compare different revisions, to go back to significant earlier versions or to mark branch points as releases, etc. Changing an existing tag is normally disallowed; use -f/--force to override.

If no revision is given, the parent of the working directory is used.

To facilitate version control, distribution, and merging of tags, they are stored as a file named ".hgtags" which is managed similarly to other project files and can be hand-edited if necessary. This also means that tagging creates a new commit. The file ".hg/localtags" is used for local tags (not shared among repositories).

Tag commits are usually made at the head of a branch. If the parent of the working directory is not a branch head, hg tag aborts; use -f/--force to force the tag commit to be based on a non-head changeset.

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

Since tag names have priority over branch names during revision lookup, using an existing branch name as a tag name is discouraged.

Returns 0 on success.

Options:

tags

list repository tags:

hg tags

This lists both regular and local tags. When the -v/--verbose switch is used, a third column "local" is printed for local tags. When the -q/--quiet switch is used, only the tag name is printed.

Returns 0 on success.

Options:

tip

show the tip revision (DEPRECATED):

hg tip [-p] [-g]

The tip revision (usually just called the tip) is the changeset most recently added to the repository (and therefore the most recently changed head).

If you have just made a commit, that commit will be the tip. If you have just pulled changes from another repository, the tip of that repository becomes the current tip. The "tip" tag is special and cannot be renamed or assigned to a different changeset.

This command is deprecated, please use hg heads instead.

Returns 0 on success.

Options:

unbundle

apply one or more changegroup files:

hg unbundle [-u] FILE...

Apply one or more compressed changegroup files generated by the bundle command.

Returns 0 on success, 1 if an update has unresolved files.

Options:

update

update working directory (or switch revisions):

hg update [-c] [-C] [-d DATE] [[-r] REV]

Update the repository's working directory to the specified changeset. If no changeset is specified, update to the tip of the current named branch and move the active bookmark (see hg help bookmarks).

Update sets the working directory's parent revision to the specified changeset (see hg help parents).

If the changeset is not a descendant or ancestor of the working directory's parent, the update is aborted. With the -c/--check option, the working directory is checked for uncommitted changes; if none are found, the working directory is updated to the specified changeset.

To cancel an uncommitted merge (and lose your changes), use hg update --clean ..

Use null as the changeset to remove the working directory (like hg clone -U).

If you want to revert just one file to an older revision, use hg revert [-r REV] NAME.

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

Returns 0 on success, 1 if there are unresolved files.

Options:

verify

verify the integrity of the repository:

hg verify

Verify the integrity of the current repository.

This will perform an extensive check of the repository's integrity, validating the hashes and checksums of each entry in the changelog, manifest, and tracked files, as well as the integrity of their crosslinks and indices.

Please see https://mercurial-scm.org/wiki/RepositoryCorruption for more information about recovery from corruption of the repository.

Returns 0 on success, 1 if errors are encountered.

version

output version and copyright information:

hg version

output version and copyright information

Options:

Synopsis

The Mercurial system uses a file called .hgignore in the root directory of a repository to control its behavior when it searches for files that it is not currently tracking.

Description

The working directory of a Mercurial repository will often contain files that should not be tracked by Mercurial. These include backup files created by editors and build products created by compilers. These files can be ignored by listing them in a .hgignore file in the root of the working directory. The .hgignore file must be created manually. It is typically put under version control, so that the settings will propagate to other repositories with push and pull.

An untracked file is ignored if its path relative to the repository root directory, or any prefix path of that path, is matched against any pattern in .hgignore.

For example, say we have an untracked file, file.c, at a/b/file.c inside our repository. Mercurial will ignore file.c if any pattern in .hgignore matches a/b/file.c, a/b or a.

In addition, a Mercurial configuration file can reference a set of per-user or global ignore files. See the ignore configuration key on the [ui] section of hg help config for details of how to configure these files.

To control Mercurial's handling of files that it manages, many commands support the -I and -X options; see hg help <command> and hg help patterns for details.

Files that are already tracked are not affected by .hgignore, even if they appear in .hgignore. An untracked file X can be explicitly added with hg add X, even if X would be excluded by a pattern in .hgignore.

Syntax

An ignore file is a plain text file consisting of a list of patterns, with one pattern per line. Empty lines are skipped. The # character is treated as a comment character, and the \ character is treated as an escape character.

Mercurial supports several pattern syntaxes. The default syntax used is Python/Perl-style regular expressions.

To change the syntax used, use a line of the following form:

syntax: NAME

where NAME is one of the following:

regexp

Regular expression, Python/Perl syntax.

glob

Shell-style glob.

The chosen syntax stays in effect when parsing all patterns that follow, until another syntax is selected.

Neither glob nor regexp patterns are rooted. A glob-syntax pattern of the form *.c will match a file ending in .c in any directory, and a regexp pattern of the form \.c$ will do the same. To root a regexp pattern, start it with ^.

Subdirectories can have their own .hgignore settings by adding subinclude:path/to/subdir/.hgignore to the root .hgignore. See hg help patterns for details on subinclude: and include:.

Example

Here is an example ignore file.

# use glob syntax.
syntax: glob

*.elc
*.pyc
*~

# switch to regexp syntax.
syntax: regexp
^\.pc/

URLs and Common Arguments

URLs under each repository have the form /{command}[/{arguments}] where {command} represents the name of a command or handler and {arguments} represents any number of additional URL parameters to that command.

The web server has a default style associated with it. Styles map to a collection of named templates. Each template is used to render a specific piece of data, such as a changeset or diff.

The style for the current request can be overwritten two ways. First, if {command} contains a hyphen (-), the text before the hyphen defines the style. For example, /atom-log will render the log command handler with the atom style. The second way to set the style is with the style query string argument. For example, /log?style=atom. The hyphenated URL parameter is preferred.

Not all templates are available for all styles. Attempting to use a style that doesn't have all templates defined may result in an error rendering the page.

Many commands take a {revision} URL parameter. This defines the changeset to operate on. This is commonly specified as the short, 12 digit hexadecimal abbreviation for the full 40 character unique revision identifier. However, any value described by hg help revisions typically works.

Commands and URLs

The following web commands and their URLs are available:

Available merge tools

External merge tools and their properties are configured in the merge-tools configuration section - see hgrc(5) - but they can often just be named by their executable.

A merge tool is generally usable if its executable can be found on the system and if it can handle the merge. The executable is found if it is an absolute or relative executable path or the name of an application in the executable search path. The tool is assumed to be able to handle the merge if it can handle symlinks if the file is a symlink, if it can handle binary files if the file is binary, and if a GUI is available if the tool requires a GUI.

There are some internal merge tools which can be used. The internal merge tools are:

:dump

Creates three versions of the files to merge, containing the contents of local, other and base. These files can then be used to perform a merge manually. If the file to be merged is named a.txt, these files will accordingly be named a.txt.local, a.txt.other and a.txt.base and they will be placed in the same directory as a.txt.

:fail

Rather than attempting to merge files that were modified on both branches, it marks them as unresolved. The resolve command must be used to resolve these conflicts.

:local

Uses the local p1() version of files as the merged version.

:merge

Uses the internal non-interactive simple merge algorithm for merging files. It will fail if there are any conflicts and leave markers in the partially merged file. Markers will have two sections, one for each side of merge.

:merge-local

Like :merge, but resolve all conflicts non-interactively in favor of the local p1() changes.

:merge-other

Like :merge, but resolve all conflicts non-interactively in favor of the other p2() changes.

:merge3

Uses the internal non-interactive simple merge algorithm for merging files. It will fail if there are any conflicts and leave markers in the partially merged file. Marker will have three sections, one from each side of the merge and one for the base content.

:other

Uses the other p2() version of files as the merged version.

:prompt

Asks the user which of the local p1() or the other p2() version to keep as the merged version.

:tagmerge

Uses the internal tag merge algorithm (experimental).

:union

Uses the internal non-interactive simple merge algorithm for merging files. It will use both left and right sides for conflict regions. No markers are inserted.

Internal tools are always available and do not require a GUI but will by default not handle symlinks or binary files.

Choosing a merge tool

Mercurial uses these rules when deciding which merge tool to use:

1. If a tool has been specified with the --tool option to merge or resolve, it is used. If it is the name of a tool in the merge-tools configuration, its configuration is used. Otherwise the specified tool must be executable by the shell.
2. If the HGMERGE environment variable is present, its value is used and must be executable by the shell.
3. If the filename of the file to be merged matches any of the patterns in the merge-patterns configuration section, the first usable merge tool corresponding to a matching pattern is used. Here, binary capabilities of the merge tool are not considered.
4. If ui.merge is set it will be considered next. If the value is not the name of a configured tool, the specified value is used and must be executable by the shell. Otherwise the named tool is used if it is usable.
5. If any usable merge tools are present in the merge-tools configuration section, the one with the highest priority is used.
6. If a program named hgmerge can be found on the system, it is used - but it will by default not be used for symlinks and binary files.
7. If the file to be merged is not binary and is not a symlink, then internal :merge is used.
8. The merge of the file fails and must be resolved before commit.

See the merge-tools and ui sections of hgrc(5) for details on the configuration of merge tools.

What are phases?

Phases are a system for tracking which changesets have been or should be shared. This helps prevent common mistakes when modifying history (for instance, with the mq or rebase extensions).

Each changeset in a repository is in one of the following phases:

• public : changeset is visible on a public server
• draft : changeset is not yet published
• secret : changeset should not be pushed, pulled, or cloned

These phases are ordered (public < draft < secret) and no changeset can be in a lower phase than its ancestors. For instance, if a changeset is public, all its ancestors are also public. Lastly, changeset phases should only be changed towards the public phase.

How are phases managed?

For the most part, phases should work transparently. By default, a changeset is created in the draft phase and is moved into the public phase when it is pushed to another repository.

Once changesets become public, extensions like mq and rebase will refuse to operate on them to prevent creating duplicate changesets. Phases can also be manually manipulated with the hg phase command if needed. See hg help -v phase for examples.

To make yours commits secret by default, put this in your configuration file:

[phases]
new-commit = secret

Phases and servers

Normally, all servers are publishing by default. This means:

- all draft changesets that are pulled or cloned appear in phase
public on the client

- all draft changesets that are pushed appear as public on both
client and server

- secret changesets are neither pushed, pulled, or cloned

Sometimes it may be desirable to push and pull changesets in the draft phase to share unfinished work. This can be done by setting a repository to disable publishing in its configuration file:

[phases]
publish = False

See hg help config for more information on configuration files.

Examples

• list changesets in draft or secret phase:

  hg log -r "not public()"
  

• change all secret changesets to draft:

  hg phase --draft "secret()"
  

• forcibly move the current changeset and descendants from public to draft:

  hg phase --force --draft .
  

• show a list of changeset revision and phase:

  hg log --template "{rev} {phase}\n"
  

• resynchronize draft changesets relative to a remote repository:

  hg phase -fd "outgoing(URL)"
  

See hg help phase for more information on manually manipulating phases.

Prefix

There is a single prefix operator:

not x

Changesets not in x. Short form is ! x.

Infix

These are the supported infix operators:

x::y

A DAG range, meaning all changesets that are descendants of x and ancestors of y, including x and y themselves. If the first endpoint is left out, this is equivalent to ancestors(y), if the second is left out it is equivalent to descendants(x).

An alternative syntax is x..y.

x:y

All changesets with revision numbers between x and y, both inclusive. Either endpoint can be left out, they default to 0 and tip.

x and y

The intersection of changesets in x and y. Short form is x & y.

x or y

The union of changesets in x and y. There are two alternative short forms: x | y and x + y.

x - y

Changesets in x but not in y.

x % y

Changesets that are ancestors of x but not ancestors of y (i.e. ::x - ::y). This is shorthand notation for only(x, y) (see below). The second argument is optional and, if left out, is equivalent to only(x).

x^n

The nth parent of x, n == 0, 1, or 2. For n == 0, x; for n == 1, the first parent of each changeset in x; for n == 2, the second parent of changeset in x.

x~n

The nth first ancestor of x; x~0 is x; x~3 is x^^^.

x ## y

Concatenate strings and identifiers into one string.

All other prefix, infix and postfix operators have lower priority than ##. For example, a1 ## a2~2 is equivalent to (a1 ## a2)~2.

For example:

[revsetalias]
issue(a1) = grep(r'\bissue[ :]?' ## a1 ## r'\b|\bbug\(' ## a1 ## r'\)')

``issue(1234)`` is equivalent to
``grep(r'\bissue[ :]?1234\b|\bbug\(1234\)')``
in this case. This matches against all of "issue 1234", "issue:1234",
"issue1234" and "bug(1234)".

Postfix

There is a single postfix operator:

x^

Equivalent to x^1, the first parent of each changeset in x.

Predicates

The following predicates are supported:

adds(pattern)

Changesets that add a file matching pattern.

The pattern without explicit kind like glob: is expected to be relative to the current directory and match against a file or a directory.

all()

All changesets, the same as 0:tip.

ancestor(*changeset)

A greatest common ancestor of the changesets.

Accepts 0 or more changesets. Will return empty list when passed no args. Greatest common ancestor of a single changeset is that changeset.

ancestors(set)

Changesets that are ancestors of a changeset in set.

author(string)

Alias for user(string).

bisect(string)

Changesets marked in the specified bisect status:

• good, bad, skip: csets explicitly marked as good/bad/skip
• goods, bads : csets topologically good/bad
• range : csets taking part in the bisection
• pruned : csets that are goods, bads or skipped
• untested : csets whose fate is yet unknown
• ignored : csets ignored due to DAG topology
• current : the cset currently being bisected

bookmark([name])

The named bookmark or all bookmarks.

If name starts with re:, the remainder of the name is treated as a regular expression. To match a bookmark that actually starts with re:, use the prefix literal:.

branch(string or set)

All changesets belonging to the given branch or the branches of the given changesets.

If string starts with re:, the remainder of the name is treated as a regular expression. To match a branch that actually starts with re:, use the prefix literal:.

branchpoint()

Changesets with more than one child.

bumped()

Mutable changesets marked as successors of public changesets.

Only non-public and non-obsolete changesets can be bumped.

bundle()

Changesets in the bundle.

Bundle must be specified by the -R option.

children(set)

Child changesets of changesets in set.

closed()

Changeset is closed.

contains(pattern)

The revision's manifest contains a file matching pattern (but might not modify it). See hg help patterns for information about file patterns.

The pattern without explicit kind like glob: is expected to be relative to the current directory and match against a file exactly for efficiency.

converted([id])

Changesets converted from the given identifier in the old repository if present, or all converted changesets if no identifier is specified.

date(interval)

Changesets within the interval, see hg help dates.

desc(string)

Search commit message for string. The match is case-insensitive.

descendants(set)

Changesets which are descendants of changesets in set.

destination([set])

Changesets that were created by a graft, transplant or rebase operation, with the given revisions specified as the source. Omitting the optional set is the same as passing all().

divergent()

Final successors of changesets with an alternative set of final successors.

draft()

Changeset in draft phase.

extinct()

Obsolete changesets with obsolete descendants only.

extra(label, [value])

Changesets with the given label in the extra metadata, with the given optional value.

If value starts with re:, the remainder of the value is treated as a regular expression. To match a value that actually starts with re:, use the prefix literal:.

file(pattern)

Changesets affecting files matched by pattern.

For a faster but less accurate result, consider using filelog() instead.

This predicate uses glob: as the default kind of pattern.

filelog(pattern)

Changesets connected to the specified filelog.

For performance reasons, visits only revisions mentioned in the file-level filelog, rather than filtering through all changesets (much faster, but doesn't include deletes or duplicate changes). For a slower, more accurate result, use file().

The pattern without explicit kind like glob: is expected to be relative to the current directory and match against a file exactly for efficiency.

If some linkrev points to revisions filtered by the current repoview, we'll work around it to return a non-filtered value.

first(set, [n])

An alias for limit().

follow([pattern[, startrev]])

An alias for ::. (ancestors of the working directory's first parent). If pattern is specified, the histories of files matching given pattern in the revision given by startrev are followed, including copies.

grep(regex)

Like keyword(string) but accepts a regex. Use grep(r'...') to ensure special escape characters are handled correctly. Unlike keyword(string), the match is case-sensitive.

head()

Changeset is a named branch head.

heads(set)

Members of set with no children in set.

hidden()

Hidden changesets.

id(string)

Revision non-ambiguously specified by the given hex string prefix.

keyword(string)

Search commit message, user name, and names of changed files for string. The match is case-insensitive.

last(set, [n])

Last n members of set, defaulting to 1.

limit(set[, n[, offset]])

First n members of set, defaulting to 1, starting from offset.

matching(revision [, field])

Changesets in which a given set of fields match the set of fields in the selected revision or set.

To match more than one field pass the list of fields to match separated by spaces (e.g. author description).

Valid fields are most regular revision fields and some special fields.

Regular revision fields are description, author, branch, date, files, phase, parents, substate, user and diff. Note that author and user are synonyms. diff refers to the contents of the revision. Two revisions matching their diff will also match their files.

Special fields are summary and metadata: summary matches the first line of the description. metadata is equivalent to matching description user date (i.e. it matches the main metadata fields).

metadata is the default field which is used when no fields are specified. You can match more than one field at a time.

max(set)

Changeset with highest revision number in set.

merge()

Changeset is a merge changeset.

min(set)

Changeset with lowest revision number in set.

modifies(pattern)

Changesets modifying files matched by pattern.

The pattern without explicit kind like glob: is expected to be relative to the current directory and match against a file or a directory.

named(namespace)

The changesets in a given namespace.

If namespace starts with re:, the remainder of the string is treated as a regular expression. To match a namespace that actually starts with re:, use the prefix literal:.

obsolete()

Mutable changeset with a newer version.

only(set, [set])

Changesets that are ancestors of the first set that are not ancestors of any other head in the repo. If a second set is specified, the result is ancestors of the first set that are not ancestors of the second set (i.e. ::<set1> - ::<set2>).

origin([set])

Changesets that were specified as a source for the grafts, transplants or rebases that created the given revisions. Omitting the optional set is the same as passing all(). If a changeset created by these operations is itself specified as a source for one of these operations, only the source changeset for the first operation is selected.

outgoing([path])

Changesets not found in the specified destination repository, or the default push location.

p1([set])

First parent of changesets in set, or the working directory.

p2([set])

Second parent of changesets in set, or the working directory.

parents([set])

The set of all parents for all changesets in set, or the working directory.

present(set)

An empty set, if any revision in set isn't found; otherwise, all revisions in set.

If any of specified revisions is not present in the local repository, the query is normally aborted. But this predicate allows the query to continue even in such cases.

public()

Changeset in public phase.

remote([id [,path]])

Local revision that corresponds to the given identifier in a remote repository, if present. Here, the '.' identifier is a synonym for the current local branch.

removes(pattern)

Changesets which remove files matching pattern.

The pattern without explicit kind like glob: is expected to be relative to the current directory and match against a file or a directory.

rev(number)

Revision with the given numeric identifier.

reverse(set)

Reverse order of set.

roots(set)

Changesets in set with no parent changeset in set.

secret()

Changeset in secret phase.

sort(set[, [-]key... [, ...]])

Sort set by keys. The default sort order is ascending, specify a key as -key to sort in descending order.

The keys can be:

• rev for the revision number,
• branch for the branch name,
• desc for the commit message (description),
• user for user name (author can be used as an alias),
• date for the commit date
• topo for a reverse topographical sort

The topo sort order cannot be combined with other sort keys. This sort takes one optional argument, topo.firstbranch, which takes a revset that specifies what topographical branches to prioritize in the sort.

subrepo([pattern])

Changesets that add, modify or remove the given subrepo. If no subrepo pattern is named, any subrepo changes are returned.

tag([name])

The specified tag by name, or all tagged revisions if no name is given.

If name starts with re:, the remainder of the name is treated as a regular expression. To match a tag that actually starts with re:, use the prefix literal:.

unstable()

Non-obsolete changesets with obsolete ancestors.

user(string)

User name contains string. The match is case-insensitive.

If string starts with re:, the remainder of the string is treated as a regular expression. To match a user that actually contains re:, use the prefix literal:.

Aliases

New predicates (known as "aliases") can be defined, using any combination of existing predicates or other aliases. An alias definition looks like:

<alias> = <definition>

in the revsetalias section of a Mercurial configuration file. Arguments of the form a1, a2, etc. are substituted from the alias into the definition.

For example,

[revsetalias]
h = heads()
d(s) = sort(s, date)
rs(s, k) = reverse(sort(s, k))

defines three aliases, h, d, and rs. rs(0:tip, author) is exactly equivalent to reverse(sort(0:tip, author)).

Equivalents

Command line equivalents for hg log:

-f    ->  ::.
-d x  ->  date(x)
-k x  ->  keyword(x)
-m    ->  merge()
-u x  ->  user(x)
-b x  ->  branch(x)
-P x  ->  !::x
-l x  ->  limit(expr, x)

Examples

Some sample queries:

• Changesets on the default branch:

  hg log -r "branch(default)"
  

• Changesets on the default branch since tag 1.5 (excluding merges):

  hg log -r "branch(default) and 1.5:: and not merge()"
  

• Open branch heads:

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

• Changesets between tags 1.3 and 1.5 mentioning "bug" that affect hgext/*:

  hg log -r "1.3::1.5 and keyword(bug) and file('hgext/*')"
  

• Changesets committed in May 2008, sorted by user:

  hg log -r "sort(date('May 2008'), user)"
  

• Changesets mentioning "bug" or "issue" that are not in a tagged release:

  hg log -r "(keyword(bug) or keyword(issue)) and not ancestors(tag())"
  

Choosing an Interface

Machines have a choice of several methods to interface with Mercurial. These include:

• Executing the hg process
• Querying a HTTP server
• Calling out to a command server

Executing hg processes is very similar to how humans interact with Mercurial in the shell. It should already be familiar to you.

hg serve can be used to start a server. By default, this will start a "hgweb" HTTP server. This HTTP server has support for machine-readable output, such as JSON. For more, see hg help hgweb.

hg serve can also start a "command server." Clients can connect to this server and issue Mercurial commands over a special protocol. For more details on the command server, including links to client libraries, see https://www.mercurial-scm.org/wiki/CommandServer.

hg serve based interfaces (the hgweb and command servers) have the advantage over simple hg process invocations in that they are likely more efficient. This is because there is significant overhead to spawn new Python processes.

Environment Variables

As documented in hg help environment, various environment variables influence the operation of Mercurial. The following are particularly relevant for machines consuming Mercurial:

HGPLAIN

If not set, Mercurial's output could be influenced by configuration settings that impact its encoding, verbose mode, localization, etc.

It is highly recommended for machines to set this variable when invoking hg processes.

HGENCODING

If not set, the locale used by Mercurial will be detected from the environment. If the determined locale does not support display of certain characters, Mercurial may render these character sequences incorrectly (often by using "?" as a placeholder for invalid characters in the current locale).

Explicitly setting this environment variable is a good practice to guarantee consistent results. "utf-8" is a good choice on UNIX-like environments.

HGRCPATH

If not set, Mercurial will inherit config options from config files using the process described in hg help config. This includes inheriting user or system-wide config files.

When utmost control over the Mercurial configuration is desired, the value of HGRCPATH can be set to an explicit file with known good configs. In rare cases, the value can be set to an empty file or the null device (often /dev/null) to bypass loading of any user or system config files. Note that these approaches can have unintended consequences, as the user and system config files often define things like the username and extensions that may be required to interface with a repository.

Consuming Command Output

It is common for machines to need to parse the output of Mercurial commands for relevant data. This section describes the various techniques for doing so.

Other Topics

revsets

Revisions sets is a functional query language for selecting a set of revisions. Think of it as SQL for Mercurial repositories. Revsets are useful for querying repositories for specific data.

See hg help revsets for more.

share extension

The share extension provides functionality for sharing repository data across several working copies. It can even automatically "pool" storage for logically related repositories when cloning.

Configuring the share extension can lead to significant resource utilization reduction, particularly around disk space and the network. This is especially true for continuous integration (CI) environments.

See hg help -e share for more.

Adding a Subrepository

If .hgsub does not exist, create it and add it to the parent repository. Clone or checkout the external projects where you want it to live in the parent repository. Edit .hgsub and add the subrepository entry as described above. At this point, the subrepository is tracked and the next commit will record its state in .hgsubstate and bind it to the committed changeset.

Synchronizing a Subrepository

Subrepos do not automatically track the latest changeset of their sources. Instead, they are updated to the changeset that corresponds with the changeset checked out in the top-level changeset. This is so developers always get a consistent set of compatible code and libraries when they update.

Thus, updating subrepos is a manual process. Simply check out target subrepo at the desired revision, test in the top-level repo, then commit in the parent repository to record the new combination.

Deleting a Subrepository

To remove a subrepository from the parent repository, delete its reference from .hgsub, then remove its files.

Interaction with Mercurial Commands

Remapping Subrepositories Sources

A subrepository source location may change during a project life, invalidating references stored in the parent repository history. To fix this, rewriting rules can be defined in parent repository hgrc file or in Mercurial configuration. See the [subpaths] section in hgrc(5) for more details.

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.

[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

[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

automv

Check for unrecorded moves at commit time (EXPERIMENTAL)

This extension checks at commit/amend time if any of the committed files comes from an unrecorded mv.

The threshold at which a file is considered a move can be set with the automv.similarity config option. This option takes a percentage between 0 (disabled) and 100 (files must be identical), the default is 95.

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 = *
# dirty is *EXPENSIVE* (slow);
# each log entry indicates `+` if the repository is dirty, like :hg:`id`.
dirty = True
# record the source of log messages
logsource = True

[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

hg blackbox [OPTION]...

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+email
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.

censor

erase file content at a given revision

The censor command instructs Mercurial to erase all content of a file at a given revision without updating the changeset hash. This allows existing history to remain valid while preventing future clones/pulls from receiving the erased data.

Typical uses for censor are due to security or legal requirements, including:

* Passwords, private keys, cryptographic material
* Licensed data/code/libraries for which the license has expired
* Personally Identifiable Information or other private data

Censored nodes can interrupt mercurial's typical operation whenever the excised data needs to be materialized. Some commands, like hg cat/hg revert, simply fail when asked to produce censored data. Others, like hg verify and hg update, must be capable of tolerating censored data to continue to function in a meaningful way. Such commands only tolerate censored file revisions if they are allowed by the "censor.policy=ignore" config option.

hg censor -r REV [-t TEXT] [FILE]

chgserver

command server extension for cHg (EXPERIMENTAL)

'S' channel (read/write)

propagate ui.system() request to client

'attachio' command

attach client's stdio passed by sendmsg()

'chdir' command

change current directory

'getpager' command

checks if pager is enabled and which pager should be executed

'setenv' command

replace os.environ completely

'setumask' command

set umask

'validate' command

reload the config and check if the server is up to date

[chgserver]
idletimeout = 3600 # seconds, after which an idle server will exit
skiphash = False   # whether to skip config or env change checks

children

command to display child changesets (DEPRECATED)

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

hg children [-r REV] [FILE]

hg children => hg log -r "children()"
hg children -r REV => hg log -r "children(REV)"

churn

command to display statistics about repository history

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

# 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

<alias email> = <actual email>

clonebundles

advertise pre-generated bundles to seed clones

"clonebundles" is a server-side extension used to advertise the existence of pre-generated, externally hosted bundle files to clients that are cloning so that cloning can be faster, more reliable, and require less resources on the server.

Cloning can be a CPU and I/O intensive operation on servers. Traditionally, the server, in response to a client's request to clone, dynamically generates a bundle containing the entire repository content and sends it to the client. There is no caching on the server and the server will have to redundantly generate the same outgoing bundle in response to each clone request. For servers with large repositories or with high clone volume, the load from clones can make scaling the server challenging and costly.

This extension provides server operators the ability to offload potentially expensive clone load to an external service. Here's how it works.

1. A server operator establishes a mechanism for making bundle files available on a hosting service where Mercurial clients can fetch them.
2. A manifest file listing available bundle URLs and some optional metadata is added to the Mercurial repository on the server.
3. A client initiates a clone against a clone bundles aware server.
4. The client sees the server is advertising clone bundles and fetches the manifest listing available bundles.
5. The client filters and sorts the available bundles based on what it supports and prefers.
6. The client downloads and applies an available bundle from the server-specified URL.
7. The client reconnects to the original server and performs the equivalent of hg pull to retrieve all repository data not in the bundle. (The repository could have been updated between when the bundle was created and when the client started the clone.)

Instead of the server generating full repository bundles for every clone request, it generates full bundles once and they are subsequently reused to bootstrap new clones. The server may still transfer data at clone time. However, this is only data that has been added/changed since the bundle was created. For large, established repositories, this can reduce server load for clones to less than 1% of original.

To work, this extension requires the following of server operators:

• Generating bundle files of repository content (typically periodically, such as once per day).
• A file server that clients have network access to and that Python knows how to talk to through its normal URL handling facility (typically an HTTP server).
• A process for keeping the bundles manifest in sync with available bundle files.

Strictly speaking, using a static file hosting server isn't required: a server operator could use a dynamic service for retrieving bundle data. However, static file hosting services are simple and scalable and should be sufficient for most needs.

Bundle files can be generated with the hg bundle command. Typically hg bundle --all is used to produce a bundle of the entire repository.

hg debugcreatestreamclonebundle can be used to produce a special streaming clone bundle. These are bundle files that are extremely efficient to produce and consume (read: fast). However, they are larger than traditional bundle formats and require that clients support the exact set of repository data store formats in use by the repository that created them. Typically, a newer server can serve data that is compatible with older clients. However, streaming clone bundles don't have this guarantee. Server operators need to be aware that newer versions of Mercurial may produce streaming clone bundles incompatible with older Mercurial versions.

A server operator is responsible for creating a .hg/clonebundles.manifest file containing the list of available bundle files suitable for seeding clones. If this file does not exist, the repository will not advertise the existence of clone bundles when clients connect.

The manifest file contains a newline ( ) delimited list of entries.

Each line in this file defines an available bundle. Lines have the format:

<URL> [<key>=<value>[ <key>=<value>]]

That is, a URL followed by an optional, space-delimited list of key=value pairs describing additional properties of this bundle. Both keys and values are URI encoded.

Keys in UPPERCASE are reserved for use by Mercurial and are defined below. All non-uppercase keys can be used by site installations. An example use for custom properties is to use the datacenter attribute to define which data center a file is hosted in. Clients could then prefer a server in the data center closest to them.

The following reserved keys are currently defined:

BUNDLESPEC

A "bundle specification" string that describes the type of the bundle.

These are string values that are accepted by the "--type" argument of hg bundle.

The values are parsed in strict mode, which means they must be of the "<compression>-<type>" form. See mercurial.exchange.parsebundlespec() for more details.

hg debugbundle --spec can be used to print the bundle specification string for a bundle file. The output of this command can be used verbatim for the value of BUNDLESPEC (it is already escaped).

Clients will automatically filter out specifications that are unknown or unsupported so they won't attempt to download something that likely won't apply.

The actual value doesn't impact client behavior beyond filtering: clients will still sniff the bundle type from the header of downloaded files.

Use of this key is highly recommended, as it allows clients to easily skip unsupported bundles. If this key is not defined, an old client may attempt to apply a bundle that it is incapable of reading.

REQUIRESNI

Whether Server Name Indication (SNI) is required to connect to the URL. SNI allows servers to use multiple certificates on the same IP. It is somewhat common in CDNs and other hosting providers. Older Python versions do not support SNI. Defining this attribute enables clients with older Python versions to filter this entry without experiencing an opaque SSL failure at connection time.

If this is defined, it is important to advertise a non-SNI fallback URL or clients running old Python releases may not be able to clone with the clonebundles facility.

Value should be "true".

Manifests can contain multiple entries. Assuming metadata is defined, clients will filter entries from the manifest that they don't support. The remaining entries are optionally sorted by client preferences (experimental.clonebundleprefers config option). The client then attempts to fetch the bundle at the first URL in the remaining list.

Errors when downloading a bundle will fail the entire clone operation: clients do not automatically fall back to a traditional clone. The reason for this is that if a server is using clone bundles, it is probably doing so because the feature is necessary to help it scale. In other words, there is an assumption that clone load will be offloaded to another service and that the Mercurial server isn't responsible for serving this clone load. If that other service experiences issues and clients start mass falling back to the original Mercurial server, the added clone load could overwhelm the server due to unexpected load and effectively take it offline. Not having clients automatically fall back to cloning from the original server mitigates this scenario.

Because there is no automatic Mercurial server fallback on failure of the bundle hosting service, it is important for server operators to view the bundle hosting service as an extension of the Mercurial server in terms of availability and service level agreements: if the bundle hosting service goes down, so does the ability for clients to clone. Note: clients will see a message informing them how to bypass the clone bundles facility when a failure occurs. So server operators should prepare for some people to follow these instructions when a failure occurs, thus driving more load to the original Mercurial server when the bundle hosting service fails.

color

colorize output from some commands

The color extension colorizes output from several Mercurial commands. For example, the diff command shows additions in green and deletions in red, while the status command shows modified files in magenta. Many other commands have analogous colors. It is possible to customize these colors.

[color]
terminfo.dim = \E[2m

[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.tab =
diff.trailingwhitespace = bold red_background

# Blank so it inherits the style of the surrounding label
changeset.public =
changeset.draft =
changeset.secret =

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

bookmarks.active = green

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

tags.normal = green
tags.local = black bold

rebase.rebased = blue
rebase.remaining = red bold

shelve.age = cyan
shelve.newest = green bold
shelve.name = blue bold

histedit.remaining = red bold

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

[color]
mode = terminfo

[color]
mode = auto
pagermode = ansi

convert

import revisions from foreign VCS repositories into Mercurial

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