mercurial/helptext/bundlespec.txt
branchstable
changeset 50375 bf7404f2e22d
parent 49442 23dd636852b8
equal deleted inserted replaced
50374:05d429fe84ed 50375:bf7404f2e22d
    65 
    65 
    66 The following bundle <compression> engines can be used:
    66 The following bundle <compression> engines can be used:
    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 
    73 The following options exist:
    77 The following options exist:
    74 
    78 
    87     Include phase information relevant to the bundled changesets.
    91     Include phase information relevant to the bundled changesets.
    88 
    92 
    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 
    96 
    99 
    97 Examples
   100 Examples
   107     Produce a ``v2`` bundle with zstandard compression using default
   110     Produce a ``v2`` bundle with zstandard compression using default
   108     settings.
   111     settings.
   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.