Mercurial

https://www.mercurial-scm.org/doc/hg.1.html
Admin
Mercurial is a distributed revision control system. The `hg` command provides its command-line...
Tokens:110,445
Snippets:744
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Mercurial Bundle Creation Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Illustrates common and specific examples of creating Mercurial bundles using different types, compression, and options, including error cases.

```APIDOC
v2:
  Description: Produce a v2 bundle using default options, including compression.
none-v1:
  Description: Produce a v1 bundle with no compression.
zstd-v2:
  Description: Produce a v2 bundle with zstandard compression using default settings.
zstd-v1:
  Description: This errors because zstd is not supported for v1 types.
none-streamv2:
  Description: Produce a v2 streaming bundle with no compression.
zstd-v2;obsolescence=true;phases=true:
  Description: Produce a v2 bundle with zstandard compression which includes obsolescence markers and phases.
```

--------------------------------

### Mercurial Default Changeset Template Example

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

An example of a default changeset template string, demonstrating how to reference node, root, and bug details for display.

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

--------------------------------

### Mercurial Command-line Flag Bundling Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Examples demonstrating how to bundle multiple short command-line flags together in Mercurial, including cases where a bundled flag takes a value.

```Shell
hg commit -ei
```

```Shell
hg commit -im 'Message'
```

--------------------------------

### Start Mercurial Server for Zeroconf Discovery

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Command to start a Mercurial server instance within a repository. This allows the repository to be discovered on the local network via DNS-SD when the zeroconf extension is enabled.

```Shell
cd test
hg serve
```

--------------------------------

### Mercurial hgweb Web Substitution Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

Illustrates practical examples of defining web substitution filters within the `[websub]` section of Mercurial's hgweb configuration. These examples demonstrate how to convert issue references into clickable links and transform markdown-like syntax into HTML.

```Mercurial Configuration
[websub]
issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
italic = s/\b_(\S+)_\b/<i>\1<\/i>/
bold = s/\*\b(\S+)\b\*\/<b>\1<\/b>/
```

--------------------------------

### Mercurial Archive Command Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Practical examples demonstrating how to use `hg archive` to create a zip file for a specific release and a tarball excluding certain files.

```bash
hg archive -r 1.0 project-1.0.zip
```

```bash
hg archive project.tar.gz -X ".hg*"
```

--------------------------------

### Mercurial `hg add` Command Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Practical examples demonstrating how to use the `hg add` command to stage new or specific files for commit in a Mercurial repository, showing the status changes before and after adding.

```bash
$ ls
foo.c
$ hg status
? foo.c
$ hg add
adding foo.c
$ hg status
A foo.c
```

```bash
$ ls
bar.c  foo.c
$ hg status
? bar.c
? foo.c
$ hg add bar.c
$ hg status
A bar.c
? foo.c
```

--------------------------------

### Mercurial Auth Section Configuration Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

Illustrates practical examples of configuring authentication entries in Mercurial's `[auth]` section, showing how to define prefixes, usernames, passwords, client certificates, and supported schemes for different hosts.

```Mercurial Config
foo.prefix = hg.intevation.de/mercurial
foo.username = foo
foo.password = bar
foo.schemes = http https

bar.prefix = secure.example.org
bar.key = path/to/file.key
bar.cert = path/to/file.cert
bar.schemes = https
```

--------------------------------

### Mercurial: `hg files` Command Usage Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Practical examples demonstrating various ways to use `hg files` for listing files, filtering by patterns, using templates, and integrating with other shell commands like `xargs` and `grep`.

```Shell
hg files .
```

```Shell
hg files -vr .
```

```Shell
hg files -I "**/README"
```

```Shell
hg files "set:binary()"
```

```Shell
hg files "set:grep('bob')"
```

```Shell
hg files -0 | xargs -0 grep foo
```

--------------------------------

### Example Mercurial Template Section Definition

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Illustrates how to define a complete template string within the `[templates]` section of a Mercurial configuration file, showing a date formatting example for `nodedate`.

```Mercurial Configuration
[templates]
nodedate = "{node|short}: {date(date, "%Y-%m-%d")}\n"
```

--------------------------------

### Mercurial `hg email` Command Usage Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Provides various practical examples of the `hg email` command, demonstrating how to send specific revisions, outgoing changes, changes related to bookmarks, and how to create bundles or mbox files.

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

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

hg email -B feature       # send all ancestors of feature bookmark

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

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

--------------------------------

### Mercurial Sparse Checkout Configuration Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This snippet demonstrates examples of sparse configuration files used in Mercurial. These files define which files and directories to include or exclude in a sparse checkout, improving performance by limiting the working directory's contents. The examples show basic include patterns and how to use `[include]` and `[exclude]` sections.

```Mercurial Config
# frontend.sparse
frontend/**
tools/**

# backend.sparse
backend/**
tools/**
```

```Mercurial Config
[include]
backend/**
tools/**

[exclude]
tools/tests/**
```

--------------------------------

### Mercurial `hg status` Command Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Practical examples demonstrating various uses of the `hg status` command, including showing changes relative to a changeset, filtering by patterns, showing copies, and generating NUL-separated lists.

```CLI
hg status --rev 9353
```

```CLI
hg status re:
```

```CLI
hg status --copies --change 9353
```

```CLI
hg status -an0
```

```CLI
hg status -v -t mardu
```

--------------------------------

### Mercurial ACL Hook Example Configuration

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Provides an example configuration snippet for integrating the `acl` hook into Mercurial's `[hooks]` section, demonstrating how to enable it for pre-transaction commit checks.

```Config
[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,
```

--------------------------------

### Mercurial File Predicate Usage Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Practical examples demonstrating how to use Mercurial file predicates with `hg` commands for various file selection and manipulation tasks.

```Shell
hg status -A "set:binary()"
```

```Shell
hg forget "set:hgignore() and not ignored()"
```

```Shell
hg files "set:grep(magic) and not binary()"
```

```Shell
hg files "set:**.c and not encoding('UTF-8')"
```

```Shell
hg revert "set:copied() and binary() and size('>1M')"
```

```Shell
hg revert "set:revs('wdir()', added())"
```

```Shell
hg remove "set: listfile:foo.lst and (**a* or **b*)"
```

--------------------------------

### Mercurial Email Configuration Example (INI)

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

Illustrates how to configure email settings in a Mercurial hgrc file, specifying the 'from' address, 'method' for sending, and preferred 'charsets'. This example demonstrates a typical setup for sending emails via an external sendmail program.

```INI
[email]
from = Joseph User <joe.user@example.com>
method = /usr/sbin/sendmail
# charsets for western Europeans
# us-ascii, utf-8 omitted, as they are tried first and last
charsets = iso-8859-1, iso-8859-15, windows-1252
```

--------------------------------

### Example Mercurial Tweak Defaults Configuration

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

An example configuration block demonstrating the settings applied when the `tweakdefaults` option is enabled in Mercurial, affecting UI behavior and command defaults.

```INI
[ui]
# The rollback command is dangerous. As a rule, don't use it.
rollback = False
# Make `hg status` report copy information
statuscopies = yes
# Prefer curses UIs when available. Revert to plain-text with `text`.
interface = curses
# Make compatible commands emit cwd-relative paths by default.
relative-paths = yes

[commands]
# Grep working directory by default.
grep.all-files = True
# Refuse to perform an `hg update` that would cause a file content merge
update.check = noconflict
```

--------------------------------

### Mercurial Bisect Command Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Illustrates various use cases for the 'hg bisect' command, including starting a bisection, marking revisions as good/bad/skipped, resetting the state, and using automatic bisection with a command. It also shows how to query bisection state using 'hg log'.

```bash
hg bisect --bad 34
hg bisect --good 12
```

```bash
hg bisect --good
```

```bash
hg bisect --bad
```

```bash
hg bisect --skip
```

```bash
hg bisect --skip 23
```

```bash
hg bisect --skip "!( file('path:foo') & file('path:bar') )"
```

```bash
hg bisect --reset
```

```bash
hg bisect --reset
hg bisect --bad 34
hg bisect --good 12
hg bisect --command "make && make tests"
```

```bash
hg log -r "bisect(pruned)"
```

```bash
hg log -r "bisect(current)"
```

```bash
hg log -r "bisect(range)"
```

```bash
hg log --graph -r "bisect(range)"
```

--------------------------------

### Example: Configuring Mercurial Pager

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

A configuration example showing how to set the external tool used as a pager and define commands for which the pager should be ignored.

```Mercurial Config
[pager]
pager = less -FRX
ignore = version, help, update
```

--------------------------------

### Mercurial: Example of Short-Form Release Notes Section

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This example shows how a section with only short-form release notes appears in the generated output file. Short-form notes omit a title and are rendered as a bullet list.

```APIDOC
Section
=======

* Release note 1
* Release note 2
```

--------------------------------

### Mercurial Graph View Configuration Example

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

Provides an example of how to configure the Mercurial web graph view. It demonstrates setting the width and color for the 'default' branch, making it stand out.

```Mercurial Config
[graph]
# 2px width
default.width = 2
# red color
default.color = FF0000
```

--------------------------------

### Example Mercurial Template Alias Definitions

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Provides concrete examples of defining symbol and function aliases within the `[templatealias]` section of a Mercurial configuration file, demonstrating argument substitution for functions like `leftpad`.

```Mercurial Configuration
[templatealias]
r = rev
rn = "{r}:{node|short}"
leftpad(s, w) = pad(s, w, ' ', True)
```

--------------------------------

### Example: Defining a Custom HTML Merge Tool

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

An example configuration snippet demonstrating how to define a new external tool named 'myHtmlTool' within Mercurial, specifying its arguments, registry key, and priority.

```Mercurial Config
myHtmlTool.args = -m $local $other $base $output
myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
myHtmlTool.priority = 1
```

--------------------------------

### Mercurial `hg log` Revset Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

These examples demonstrate practical applications of Mercurial revset predicates with the `hg log` command to perform various changeset queries and filtering operations.

```Shell
hg log -r "branch(default)"
```

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

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

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

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

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

```Shell
hg update :@
```

```Shell
hg diff -r 1.3::1.5
```

--------------------------------

### Mercurial: transplant Example - Branch and All Revisions

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

An example demonstrating how to use `hg transplant` with the `--branch` and `--all` options to apply all changes up to a specified revision onto the current working directory.

```Shell
hg transplant --branch REV --all
```

--------------------------------

### Mercurial Extensions Configuration Examples (INI)

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

Provides various examples for configuring Mercurial extensions in the hgrc file. This includes basic extension enabling, enforcing that an extension must be loaded, and applying default settings to multiple extensions.

```INI
[extensions]
# (the churn extension will get loaded from Mercurial's path)
churn =
# (this extension will get loaded from the file specified)
myfeature = ~/.hgext/myfeature.py
```

```INI
[extensions]
myfeature = ~/.hgext/myfeature.py
myfeature:required = yes
```

```INI
[extensions]
*:required = yes
myfeature = ~/.hgext/myfeature.py
rebase=
```

--------------------------------

### Mercurial EOL Extension: Example .hgeol Configuration

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This example demonstrates a typical '.hgeol' configuration file for the Mercurial EOL extension. It defines line ending conversion rules for various file types using glob patterns in the '[patterns]' section and specifies the repository's native line ending storage in the '[repository]' section.

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

[repository]
native = LF
```

--------------------------------

### Basic hgrc Configuration Example

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

Demonstrates the fundamental INI-file structure of Mercurial's hgrc configuration files, including a 'ui' section with typical settings for username and verbosity.

```INI
[ui]
username = Firstname Lastname <firstname.lastname@example.net>
verbose = True
```

--------------------------------

### Mercurial notify Extension Configuration Example

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This snippet provides a configuration example for the `notify` extension in Mercurial. It demonstrates how to set up hooks in the `[hooks]` section of the Mercurial configuration to send email notifications for incoming or changegroup events.

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

--------------------------------

### Mercurial: Show Incoming Changes with Patches (hg incoming)

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Example demonstrating how to display incoming changesets along with their corresponding patches and full descriptions using the `hg incoming` command.

```hg
hg incoming -vp
```

--------------------------------

### Example of Tool Priority Configuration in hg fix

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This example demonstrates how to use the ':priority' suboption to control the execution order of multiple fixer tools. Tools with higher priority values run first. Here, 'sort' is configured to run before 'head' on 'numbers.txt' files, ensuring that 'sort' (priority 2) processes the file before 'head' (priority 1) limits the output to 10 lines.

```INI
[fix]
sort:command = sort -n
head:command = head -n 10
sort:pattern = numbers.txt
head:pattern = numbers.txt
sort:priority = 2
head:priority = 1
```

--------------------------------

### Example .hgignore File with Mixed Syntaxes

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgignore.5

This example demonstrates a practical .hgignore file, showcasing how to combine and switch between 'glob' and 'regexp' syntaxes. It includes patterns for ignoring common build artifacts like compiled Python (.pyc) and Emacs (.elc) files using glob, and a specific directory (.pc/) using regular expressions. This illustrates how to manage different types of ignore rules within a single file.

```Mercurial Ignore Syntax
# use glob syntax.
syntax: glob

*.elc
*.pyc
*~

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

--------------------------------

### Mercurial hg log Command Usage Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Practical examples demonstrating various ways to use the 'hg log' command for different history viewing scenarios, including verbose output, filtering, and custom formatting.

```Shell
hg log -v
```

```Shell
hg log -f
```

```Shell
hg log -l 10 -b .
```

```Shell
hg log --removed file.c
```

```Shell
hg log -Mp lib/
```

```Shell
hg log -k bug --template "{rev}\n"
```

```Shell
hg log -r . --template "{node}\n"
```

```Shell
hg log -T list
```

```Shell
hg log -r "a21ccf and ancestor(1.9)"
```

```Shell
hg log -k alice -d "may 2008 to jul 2008"
```

```Shell
hg log -r "last(tagged())::" --template "{desc|firstline}\n"
```

```Shell
hg log -L file.c,13:23
```

```Shell
hg log -L file.c,13:23 -L main.c,2:6 -p
```

--------------------------------

### Mercurial: Example of Long-Form Release Notes Section

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This example demonstrates the structure of a section containing long-form release notes. Long-form notes include a title, creating sub-sections within the main section.

```APIDOC
Section
=======

Note 1 Title
------------

Description of the first long-form note.

Note 2 Title
------------

Description of the second long-form note.
```

--------------------------------

### Example Mercurial Host Security Minimum Protocol Configuration

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

This example demonstrates how to set a global minimum TLS protocol version while allowing a specific host to use an older, less secure protocol. It shows how to configure `minimumprotocol` globally to `tls1.2` and then override it for `hg.example.com` to `tls1.1`.

```INI
[hostsecurity]
minimumprotocol = tls1.2
hg.example.com:minimumprotocol = tls1.1
```

--------------------------------

### Mercurial Listfile Pattern Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

These examples demonstrate how Mercurial can read file patterns from an external text file. `listfile:` expects patterns separated by line feeds, while `listfile0:` expects null-delimited patterns.

```Mercurial Pattern Language
listfile:list.txt  read list from list.txt with one file pattern per line
listfile0:list.txt read list from list.txt with null byte delimiters
```

--------------------------------

### Example Mercurial Repository History for histedit

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

An example of a Mercurial repository's commit history, presented in a log format. This history serves as the initial state for demonstrating the interactive history editing capabilities of the `histedit` extension.

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

--------------------------------

### Install Mercurial Rust Extensions via pip

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This set of commands outlines the process for installing Mercurial with its Rust extensions using pip. It explicitly removes cached versions and forces a source build by using `--no-binary mercurial` and `--config-settings --global-option=--rust`, ensuring Rust support is included. This process may take some time due to compilation.

```bash
$ pip cache remove mercurial
$ pip install mercurial -v \
      --config-settings --global-option=--rust \
      --no-binary mercurial --force
```

--------------------------------

### Mercurial hg diff Example: Compare Revision to Parents

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This example provides multiple methods to compare a specific revision against its parent(s). It shows the shorthand `-c` option, as well as explicit `--from` and `--to` arguments using revset syntax to target the first or second parent of a given revision.

```Shell
hg diff -c 9353
hg diff --from 9353^ --to 9353
hg diff --from 9353^2 --to 9353
```

--------------------------------

### Example Mercurial Host Security Per-Host Configurations

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

This code snippet provides practical examples of configuring per-host security settings in Mercurial's `[hostsecurity]` section. It demonstrates how to specify `fingerprints` for different hosts using SHA256 and SHA1 algorithms, and how to define a custom `verifycertsfile` for a specific domain.

```INI
[hostsecurity]
hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
hg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2
foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
```

--------------------------------

### Create Lightweight Local Mercurial Clone

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Example of creating a local clone of a Mercurial repository, useful for feature branches or temporary work.

```Shell
hg clone project/ project-feature/
```

--------------------------------

### Mercurial logtoprocess Extension Configuration

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Example configuration for the `logtoprocess` extension, showing how to log command exceptions to a file. This script runs asynchronously and receives log messages as environment variables.

```Configuration
[logtoprocess]
commandexception = echo "$MSG1" > /var/log/mercurial_exceptions.log
```

--------------------------------

### Mercurial Glob Pattern Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

These examples illustrate the use of glob patterns in Mercurial for flexible file matching. It shows how to use `glob:` for current directory-rooted patterns, `rootglob:` for repository root-rooted patterns, and the `*`, `**` (any string across path separators), and `{a,b}` (OR) extensions.

```Mercurial Pattern Language
glob:*.c       any name ending in ".c" in the current directory
*.c            any name ending in ".c" in the current directory
**.c           any name ending in ".c" in any subdirectory of the
               current directory including itself.
foo/*          any file in directory foo
foo/**         any file in directory foo plus all its subdirectories,
               recursively
foo/*.c        any name ending in ".c" in the directory foo
foo/**.c       any name ending in ".c" in any subdirectory of foo
               including itself.
rootglob:*.c   any name ending in ".c" in the root of the repository
```

--------------------------------

### Mercurial hg diff Example: Get Change Stats by Date

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This example shows how to obtain a summary of changes (diffstat-style) relative to a specific date. It uses the `--stat` option and the `date()` revset function within the `--from` argument.

```Shell
hg diff --stat --from "date('may 2')"
```

--------------------------------

### Initialize Mercurial Queue Repository (qinit)

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

The `hg qinit` command initializes a new queue repository. By default, the repository is unversioned. The `-c` or `--create-repo` option allows creating a separate nested repository for patches, making it versioned. This command is deprecated; for versioned repositories, `hg init --mq` should be used instead.

```Shell
hg qinit [-c]
```

```APIDOC
qinit:
  -c, --create-repo:
    description: create queue repository
```

--------------------------------

### Mercurial Template: Filter by Description Start

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Example of using `startswith` to filter commit messages, displaying only those whose first line of description begins with 'template'.

```Shell
$ hg log --template "{startswith('template', firstline(desc))}\n"
```

--------------------------------

### Example Mercurial .hgignore File

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This example demonstrates a typical .hgignore file, showcasing the use of both 'glob' and 'regexp' pattern syntaxes. It ignores compiled Python and Emacs files using glob, then switches to regexp to ignore a specific directory.

```Mercurial Ignore Syntax
# use glob syntax.
syntax: glob

*.elc
*.pyc
*~

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

--------------------------------

### Mercurial Command: hg githelp - Git Command Mapping

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Provides examples and documentation for the `hg githelp` command, which attempts to map Git commands to their Mercurial equivalents. It shows how to use the command and its aliases, along with an example of mapping `git checkout master` to `hg update master`.

```shell
$ hg githelp -- git checkout master
hg update master
```

```shell
hg githelp
```

```APIDOC
Usage: hg githelp -- <git command>
aliases: git
```

--------------------------------

### Mercurial histedit Example: Dropping a Revision

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Demonstrates how to use `hg histedit -r` to start an interactive session and then modify the editor content to drop a specific revision from the history.

```shell
hg histedit -r 3
```

```text
pick 5339bf82f0ca 3 Zworgle the foobar
pick 8ef592ce7cc4 4 Bedazzle the zerlog
pick 0a9639fcda9d 5 Morgify the cromulancy
```

```text
drop 5339bf82f0ca 3 Zworgle the foobar
pick 8ef592ce7cc4 4 Bedazzle the zerlog
pick 0a9639fcda9d 5 Morgify the cromulancy
```

--------------------------------

### Configure Mercurial Bugzilla Hook with XMLRPC

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Example configuration for the Mercurial Bugzilla hook using XMLRPC. It specifies the Bugzilla URL, user credentials, and a template for comments. This setup is suitable for integrating with a Bugzilla instance via its XMLRPC API.

```Mercurial Config
[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
```

--------------------------------

### Mercurial Hooks Configuration Example

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

Illustrates how to configure various hooks in Mercurial's `.hg/hgrc` file. It shows examples for updating the working directory after changesets, disabling site-wide hooks, defining custom incoming hooks, setting hook priorities, and controlling the `HGPLAIN` environment variable for specific hooks.

```Mercurial Config
[hooks]
# update working directory after adding changesets
changegroup.update = hg update
# do not use the site-wide hook
incoming =
incoming.email = /my/email/hook
incoming.autobuild = /my/build/hook
# force autobuild hook to run before other incoming hooks
priority.incoming.autobuild = 1
###  control HGPLAIN setting when running autobuild hook
# HGPLAIN always set (default from Mercurial 5.7)
incoming.autobuild:run-with-plain = yes
# HGPLAIN never set
incoming.autobuild:run-with-plain = no
# HGPLAIN inherited from environment (default before Mercurial 5.7)
incoming.autobuild:run-with-plain = auto
```

--------------------------------

### Mercurial: Migrating `hg children` to `hg log`

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Provides examples for migrating `hg children` command usage to the recommended `hg log` command with `children()` revset.

```shell
hg children => hg log -r "children(.)"
hg children -r REV => hg log -r "children(REV)"
```

--------------------------------

### Configure Mercurial Bugzilla Hook with MySQL

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Example configuration for integrating the Mercurial Bugzilla hook directly with a local MySQL database. It specifies the database host, credentials, Bugzilla version, and directory. This method is used when Bugzilla is installed locally and direct database access is preferred.

```Mercurial Config
[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
```

--------------------------------

### Mercurial: hg serve Command Options Reference

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Detailed documentation of all available command-line options for the `hg serve` command, including their purpose, arguments, and default values. This section covers logging, network configuration, security, and advanced settings for server operation.

```APIDOC
hg serve Options:
-A, --accesslog <FILE>: name of access log file to write to
-d, --daemon: run server in background
--daemon-postexec <VALUE[+]>: used internally by daemon mode
-E, --errorlog <FILE>: name of error log file to write to
-p, --port <PORT>: port to listen on (default: 8000)
-a, --address <ADDR>: address to listen on (default: all interfaces)
--prefix <PREFIX>: prefix path to serve from (default: server root)
-n, --name <NAME>: name to show in web pages (default: working directory)
--web-conf <FILE>: name of the hgweb config file (see 'hg help hgweb')
--webdir-conf <FILE>: name of the hgweb config file (DEPRECATED)
--pid-file <FILE>: name of file to write process ID to
--stdio: for remote clients (ADVANCED)
--cmdserver <MODE>: for remote clients (ADVANCED)
-t, --templates <TEMPLATE>: web templates to use
--style <STYLE>: template style to use
-6, --ipv6: use IPv6 instead of IPv4
--certificate <FILE>: SSL certificate file
--print-url: start and print only the URL
-S, --subrepos: recurse into subrepositories
[+] marked option can be specified multiple times
```

--------------------------------

### get(dict_obj, key)

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Gets an attribute or key from an object. Useful for complex types where direct access might be ambiguous.

```APIDOC
get(dict_obj, key):
  Description: Gets an attribute or key from an object. Useful for complex types where direct access might be ambiguous.
  Parameters:
    dict_obj: The dictionary or object to query.
    key: The key or attribute name to retrieve.
  Returns: The value associated with the key.
```

--------------------------------

### Mercurial: Start Stand-alone Web Server with hg serve

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Provides the basic command-line syntax for initiating a local HTTP server for Mercurial repositories. This server allows ad-hoc sharing and browsing of repositories but lacks built-in access control.

```Shell
hg serve [OPTION]...
```

--------------------------------

### Mercurial Hooks: `tonative` Feature Example

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

Provides an example of a hook definition within the `[hooks]` section. This specific example is used in the documentation to illustrate how to enable the `tonative` feature, which allows Unix-like syntax expansion in hook commands by adding a `tonative.` prefix to the hook name and setting it to `True`.

```Mercurial Config
[hooks]
incoming.autobuild = /my/build/hook
```

--------------------------------

### Configure Perforce Source Conversion Options

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

API documentation for 'convert.p4' options used when importing from a Perforce source. These options control encoding and the starting revision for the conversion process.

```APIDOC
Perforce Source Options:
  convert.p4.encoding:
    Description: specify the encoding to use when decoding standard output of the Perforce command line tool. The default is default system encoding.
  convert.p4.startrev:
    Description: specify initial Perforce revision (a Perforce changelist number).
```

--------------------------------

### API Endpoint: /help[/{topic}]

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Renders help documentation, similar to the 'hg help' command. If a specific topic is provided, that help topic will be rendered; otherwise, an index of available help topics will be displayed. It renders either the 'help' or 'helptopics' template.

```APIDOC
/help[/{topic}]
  Description: Render help documentation (roughly equivalent to hg help).
  Path Parameters:
    topic (optional): The specific help topic. If not defined, an index of available help topics will be rendered.
  Templates Rendered: help (for a topic), helptopics (for the index of help topics)
```

--------------------------------

### Mercurial Command-line Boolean Flag Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Examples illustrating how to specify boolean command-line flags in Mercurial, including setting them to true or explicitly to false.

```Shell
hg commit --interactive
```

```Shell
hg commit --no-interactive
```

--------------------------------

### Mercurial CLI Synopsis

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Describes the general command-line syntax for the `hg` command, showing how commands, options, and arguments are structured for execution.

```APIDOC
hg *command* [*option*]... [*argument*]...
```

--------------------------------

### Mercurial: Initialize a New Repository (hg init)

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This command initializes a new Mercurial repository in the specified directory. If no directory is provided, the current directory is used. It supports specifying an SSH URL as a destination and returns 0 on success.

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

Options:
  -e, --ssh <CMD>: specify ssh command to use
  --remotecmd <CMD>: specify hg command to run on the remote side
  --insecure: do not verify server certificate (ignoring web.cacerts config)
```

--------------------------------

### Convert Mercurial Repository with Subrepositories

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Example shell commands demonstrating how to convert a Mercurial repository that contains subrepositories. This process requires initializing a new repository and converting each subrepository individually before converting the main repository, ensuring proper handling of .hgsubstate.

```Shell
# so convert knows the type when it sees a non empty destination
hg init converted

hg convert orig/sub1 converted/sub1
hg convert orig/sub2 converted/sub2
hg convert orig converted
```

--------------------------------

### Mercurial Extension: schemes Configuration and Usage

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Explains the `schemes` extension, which allows defining shortcuts for repository URLs. It demonstrates how to create simple and templated schemes, and lists default schemes provided by the extension. It also shows how to use these schemes with `hg clone`.

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

```Mercurial CLI
hg clone py://trunk/
```

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

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

--------------------------------

### Mercurial: Display Help (`hg help`)

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Provides documentation for the `hg help` command, which is used to retrieve help information for Mercurial topics, extensions, or commands. It details how to get a general overview of commands or specific help based on filters like extensions, commands, or keywords.

```APIDOC
Command: hg help [-eck] [-s PLATFORM] [TOPIC]
Description: Show help for a given topic or a help overview.

Arguments:
  [TOPIC]: Given a topic, extension, or command name, print help for that topic.
           With no arguments, print a list of commands with short help messages.

Options:
  -e, --extension: show only help for extensions
  -c, --command: show only help for commands
  -k, --keyword: show topics matching keyword
  -s, --system <PLATFORM[+]>: show help for specific platform(s)

Return: 0 if successful.
```

--------------------------------

### Mercurial Histedit: Extended History Example

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Shows an extended Mercurial history, demonstrating additional commits added after an initial histedit operation, used for further examples like applying `--outgoing`.

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

--------------------------------

### Basic Configuration Section with Key-Value Pairs

Source: https://www.mercurial-scm.org/doc/hg.1.html/hgrc.5

Demonstrates a basic configuration section `[spam]` with key-value pairs. It shows how values can span multiple lines using indentation and how empty values are handled, with leading whitespace removed from values.

```Configuration
[spam]
eggs=ham
green=
   eggs
```

--------------------------------

### Mercurial hg push Command Options Reference

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Detailed reference for all available options of the `hg push` command, including their short and long forms, and descriptions of their functionality and usage.

```APIDOC
hg push Options:
  -f, --force:
    Description: force push
  -r, --rev <REV[+]>:
    Description: a changeset intended to be included in the destination
  -B, --bookmark <BOOKMARK[+]>:
    Description: bookmark to push
  --all-bookmarks:
    Description: push all bookmarks (EXPERIMENTAL)
  -b, --branch <BRANCH[+]>:
    Description: a specific branch you would like to push
  --new-branch:
    Description: allow pushing a new branch
  --pushvars <VALUE[+]>:
    Description: variables that can be sent to server (ADVANCED)
  --publish:
    Description: push the changeset as public (EXPERIMENTAL)
  -e, --ssh <CMD>:
    Description: specify ssh command to use
  --remotecmd <CMD>:
    Description: specify hg command to run on the remote side
  --insecure:
    Description: do not verify server certificate (ignoring web.cacerts config)
```

--------------------------------

### Mercurial: `hg releasenotes` Command Options

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This section details the command-line options available for `hg releasenotes`, including their short and long forms, and a description of their functionality.

```APIDOC
Options:
-r, --rev <REV>
  revisions to process for release notes
-c, --check
  checks for validity of admonitions (if any)
-l, --list
  list the available admonitions with their title
```

--------------------------------

### Access Mercurial Bundlespec Documentation

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Provides the command to view detailed help documentation for the `bundlespec` option stream, which is relevant for understanding special streaming clonebundles.

```Shell
hg help bundlespec
```

--------------------------------

### Mercurial Regular Expression Pattern Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This snippet provides an example of using Perl/Python regular expressions for file pattern matching in Mercurial. The `re:` prefix indicates a regular expression, which is anchored at the root of the repository.

```Mercurial Pattern Language
re:.*\.c$      any name ending in ".c", anywhere in the repository
```

--------------------------------

### Mercurial Graft Example: Continue After Conflicts

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This example demonstrates how to resume an interrupted 'hg graft' operation after manually resolving merge conflicts. It's crucial for completing a graft process when automatic merging fails.

```Mercurial CLI
hg graft -c
```

--------------------------------

### Mercurial qclone Command API Reference

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Detailed API documentation for the `hg qclone` command, which allows cloning a main repository and its associated patch repository simultaneously. It outlines the command syntax, arguments, and available options for controlling the cloning process, including pull protocol, update behavior, compression, source patch repository location, SSH command, remote command, and certificate verification.

```APIDOC
hg qclone
  Description: clone main and patch repository at same time
  Syntax: hg qclone [OPTION]... SOURCE [DEST]
  Return: 0 on success
  Options:
    --pull: use pull protocol to copy metadata
    -U, --noupdate: do not update the new working directories
    --uncompressed: use uncompressed transfer (fast over LAN)
    -p, --patches <REPO>: location of source patch repository
    -e, --ssh <CMD>: specify ssh command to use
    --remotecmd <CMD>: specify hg command to run on the remote side
    --insecure: do not verify server certificate (ignoring web.cacerts config)
```

--------------------------------

### Mercurial: Print keywordmaps configuration and expansion example

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

The `hg kwdemo` command displays current, custom, or default keyword template maps and their expansions. It allows extending the current configuration by specifying maps as arguments or sourcing an external hgrc file with `-f/--rcfile`. The `-d/--default` option disables the current configuration to show defaults. Refer to `hg help templates` for template and filter information.

```APIDOC
hg kwdemo [-d] [-f RCFILE] [TEMPLATEMAP]...

Options:
-d, --default: show default keyword template maps
-f, --rcfile <FILE>: read maps from rcfile
```

--------------------------------

### Mercurial: `hg churn` Usage Examples

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Illustrates various ways to use the `hg churn` command to display repository activity, including grouping by author, daily activity, monthly activity, and yearly changes.

```shell
# 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

# display count of lines changed in a time range
hg churn -d "2020-04 to 2020-09"
```

--------------------------------

### Mercurial hg diff Example: Compare File to Parent

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This example demonstrates the simplest use of `hg diff` to compare a specific file in the current working directory against its immediate parent revision. This is the default behavior when no revisions are specified.

```Shell
hg diff foo.c
```

--------------------------------

### Example Mercurial Revset Aliases

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This example demonstrates how to define custom revset aliases in the `[revsetalias]` section of a Mercurial configuration file. It shows aliases for common queries like 'heads', sorting by date, and reversing a sorted set.

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

--------------------------------

### Mercurial CLI Global Options

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

Lists global command-line options available for the `hg` command, detailing their short and long forms, and providing a brief explanation of their purpose and behavior, including options for output control, configuration, and debugging.

```APIDOC
-R, --repository <REPO>
    repository root directory or name of overlay bundle file
--cwd <DIR>
    change working directory
-y, --noninteractive
    do not prompt, automatically pick the first choice for all prompts
-q, --quiet
    suppress output
-v, --verbose
    enable additional output
--color <TYPE>
    when to colorize (boolean, always, auto, never, or debug)
--config <CONFIG[+]>
    set/override config option (use 'section.name=value')
--config-file <HGRC[+]>
    load config file to set/override config options
--debug
    enable debugging output
--debugger
    start debugger
--encoding <ENCODE>
    set the charset encoding (default: UTF-8)
--encodingmode <MODE>
    set the charset encoding mode (default: strict)
--traceback
    always print a traceback on exception
--time
    time how long the command takes
--profile
    print command execution profile
--version
    output version information and exit
-h, --help
    display help and exit
--hidden
    consider hidden changesets
--pager <TYPE>
    when to paginate (boolean, always, auto, or never) (default: auto)
```

--------------------------------

### Mercurial Graft Example: Backport Merge Result

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This example demonstrates how to backport the result of a merge operation as a single commit using 'hg graft' with the '--base' option. It's useful for simplifying history when integrating complex changes.

```Mercurial CLI
hg graft -r 123 --base 123^
```

--------------------------------

### Mercurial: `hg files` Command Line Options

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

API documentation for the available options of the `hg files` command, including revision specification, null-terminated output, pattern matching, and template usage.

```APIDOC
-r, --rev <REV>: search the repository as it is in REV
-0, --print0: end filenames with NUL, for use with xargs
-I, --include <PATTERN[+]>: include names matching the given patterns
-X, --exclude <PATTERN[+]>: exclude names matching the given patterns
-T, --template <TEMPLATE>: display with template
-S, --subrepos: recurse into subrepositories
```

--------------------------------

### Mercurial Graft Example: Copy Single Change and Edit

Source: https://www.mercurial-scm.org/doc/hg.1.html/hg.1

This example shows how to copy a single changeset to the stable branch using 'hg graft' and then invoke an editor to modify its commit message. It demonstrates a common workflow for backporting and refining changes.

```Mercurial CLI
hg update stable
hg graft --edit 9393
```
Tokens:
Raw