comparison mercurial/help/internals/bundles.txt @ 36451:1fa35ca345a5

internals: document bundle2 format It seems like a good idea to have thorough documentation of the bundle2 data format, including the format of each part and the capabilities. The added documentation is far from complete. For example, we don't fully capture the semantics of each capability and part. But a start is better than nothing, which was pretty much where we were before. Differential Revision: https://phab.mercurial-scm.org/D2298
author Gregory Szorc <gregory.szorc@gmail.com>
date Sat, 17 Feb 2018 11:19:52 -0700
parents aba2bb2a6d0f
children
comparison
equal deleted inserted replaced
36450:d478c8cd89d1 36451:1fa35ca345a5
61 data and capabilities, beyond changegroup data (which was the only data 61 data and capabilities, beyond changegroup data (which was the only data
62 supported by ``HG10`` bundles. 62 supported by ``HG10`` bundles.
63 63
64 ``HG20`` is currently the only defined bundle2 version. 64 ``HG20`` is currently the only defined bundle2 version.
65 65
66 The ``HG20`` format is not yet documented here. See the inline comments 66 The ``HG20`` format is documented at :hg:`help internals.bundle2`.
67 in ``mercurial/exchange.py`` for now.
68 67
69 Initial ``HG20`` support was added in Mercurial 3.0 (released May 68 Initial ``HG20`` support was added in Mercurial 3.0 (released May
70 2014). However, bundle2 bundles were hidden behind an experimental flag 69 2014). However, bundle2 bundles were hidden behind an experimental flag
71 until version 3.5 (released August 2015), when they were enabled in the 70 until version 3.5 (released August 2015), when they were enabled in the
72 wire protocol. Various commands (including ``hg bundle``) did not 71 wire protocol. Various commands (including ``hg bundle``) did not