##// END OF EJS Templates
bundles: clarify streaming v2 bundle usage...
Mathias De Mare -
r51538:bf7404f2 stable
parent child Browse files
Show More
@@ -79,8 +79,10 b' for most needs.'
79 Bundle files can be generated with the :hg:`bundle` command. Typically
79 Bundle files can be generated with the :hg:`bundle` command. Typically
80 :hg:`bundle --all` is used to produce a bundle of the entire repository.
80 :hg:`bundle --all` is used to produce a bundle of the entire repository.
81
81
82 :hg:`debugcreatestreamclonebundle` can be used to produce a special
82 The bundlespec option `stream` (see :hg:`help bundlespec`)
83 *streaming clonebundle*. These are bundle files that are extremely efficient
83 can be used to produce a special *streaming clonebundle*, typically using
84 :hg:`bundle --all --type="none-streamv2"`.
85 These are bundle files that are extremely efficient
84 to produce and consume (read: fast). However, they are larger than
86 to produce and consume (read: fast). However, they are larger than
85 traditional bundle formats and require that clients support the exact set
87 traditional bundle formats and require that clients support the exact set
86 of repository data store formats in use by the repository that created them.
88 of repository data store formats in use by the repository that created them.
@@ -67,6 +67,10 b' The following bundle <compression> engin'
67
67
68 .. bundlecompressionmarker
68 .. bundlecompressionmarker
69
69
70 The compression engines can be prepended with ``stream`` to create a streaming bundle.
71 These are bundles that are extremely efficient to produce and consume,
72 but do not have guaranteed compatibility with older clients.
73
70 Available Options
74 Available Options
71 =================
75 =================
72
76
@@ -89,7 +93,6 b' phases'
89 revbranchcache
93 revbranchcache
90 Include the "tags-fnodes" cache inside the bundle.
94 Include the "tags-fnodes" cache inside the bundle.
91
95
92
93 tagsfnodescache
96 tagsfnodescache
94 Include the "tags-fnodes" cache inside the bundle.
97 Include the "tags-fnodes" cache inside the bundle.
95
98
@@ -109,3 +112,10 b' Examples'
109
112
110 ``zstd-v1``
113 ``zstd-v1``
111 This errors because ``zstd`` is not supported for ``v1`` types.
114 This errors because ``zstd`` is not supported for ``v1`` types.
115
116 ``none-streamv2``
117 Produce a ``v2`` streaming bundle with no compression.
118
119 ``zstd-v2;obsolescence=true;phases=true``
120 Produce a ``v2`` bundle with zstandard compression which includes
121 obsolescence markers and phases.
General Comments 0
You need to be logged in to leave comments. Login now