Mercurial > hg
view mercurial/help/bundlespec.txt @ 38737:913ca175c4ae
aggressivemergedelta: document rename and move to `revlog` section
The config does not follow our naming guideline and "Aggressive" is probably a
word to keep away from users.
The option does not truly fit in the `format` section. It can be turned on and
off for existing repository without much consequence regarding compatibility.
A new `revlog` option is created to control behavior related to revlog writing
and reading. We can see multiple other config options that could be migrated
there.
* format.maxchainlen
* experimental.mmapindexthreshold
* experimental.sparse-read.density-threshold (in an updated form)
* experimental.sparse-read.min-gap-size (in an updated form)
In addition, we can foresee at least a couple of sparse-revlog related option
coming too (to reduce delta chain length and increase snapshot reuse)
These two extra options might fit there too. Unless we want to create a
section dedicated to caches and performance.
* format.chunkcachesize
* format.manifestcachesize
For now, we only migrate `optimize-delta-parent-choice` since it is getting
out of experimental. It is too close to the release to move the other one. In
addition, we still lack proper the prioritization of alias that would help
renaming them without bad consequence for users.
(Not fully happy about the `revlog` name but could not find better).
author | Boris Feld <boris.feld@octobus.net> |
---|---|
date | Thu, 19 Jul 2018 10:35:29 +0200 |
parents | 01280ec5f840 |
children |
line wrap: on
line source
Mercurial supports generating standalone "bundle" files that hold repository data. These "bundles" are typically saved locally and used later or exchanged between different repositories, possibly on different machines. Example commands using bundles are :hg:`bundle` and :hg:`unbundle`. Generation of bundle files is controlled by a "bundle specification" ("bundlespec") string. This string tells the bundle generation process how to create the bundle. A "bundlespec" string is composed of the following elements: type A string denoting the bundle format to use. compression Denotes the compression engine to use compressing the raw bundle data. parameters Arbitrary key-value parameters to further control bundle generation. A "bundlespec" string has the following formats: <type> The literal bundle format string is used. <compression>-<type> The compression engine and format are delimited by a hyphen (``-``). Optional parameters follow the ``<type>``. Parameters are URI escaped ``key=value`` pairs. Each pair is delimited by a semicolon (``;``). The first parameter begins after a ``;`` immediately following the ``<type>`` value. Available Types =============== The following bundle <type> strings are available: v1 Produces a legacy "changegroup" version 1 bundle. This format is compatible with nearly all Mercurial clients because it is the oldest. However, it has some limitations, which is why it is no longer the default for new repositories. ``v1`` bundles can be used with modern repositories using the "generaldelta" storage format. However, it may take longer to produce the bundle and the resulting bundle may be significantly larger than a ``v2`` bundle. ``v1`` bundles can only use the ``gzip``, ``bzip2``, and ``none`` compression formats. v2 Produces a version 2 bundle. Version 2 bundles are an extensible format that can store additional repository data (such as bookmarks and phases information) and they can store data more efficiently, resulting in smaller bundles. Version 2 bundles can also use modern compression engines, such as ``zstd``, making them faster to compress and often smaller. Available Compression Engines ============================= The following bundle <compression> engines can be used: .. bundlecompressionmarker Examples ======== ``v2`` Produce a ``v2`` bundle using default options, including compression. ``none-v1`` Produce a ``v1`` bundle with no compression. ``zstd-v2`` Produce a ``v2`` bundle with zstandard compression using default settings. ``zstd-v1`` This errors because ``zstd`` is not supported for ``v1`` types.