Patchwork D8838: clonebundles: document REQUIREDRAM key

login
register
mail settings
Submitter phabricator
Date July 26, 2020, 7:46 p.m.
Message ID <differential-rev-PHID-DREV-kv536zgix4snyshumnrm-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/46912/
State Superseded
Headers show

Comments

phabricator - July 26, 2020, 7:46 p.m.
indygreg created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

REVISION SUMMARY
  This is a follow-up to 72feaeb510b3 <https://phab.mercurial-scm.org/rHG72feaeb510b3502f14773e5ac2d06862e66012d4>, which introduced the feature. The
  key should be documented as part of the format specification inside the
  extension docstring.

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D8838

AFFECTED FILES
  hgext/clonebundles.py

CHANGE DETAILS




To: indygreg, #hg-reviewers
Cc: mercurial-patches, mercurial-devel

Patch

diff --git a/hgext/clonebundles.py b/hgext/clonebundles.py
--- a/hgext/clonebundles.py
+++ b/hgext/clonebundles.py
@@ -156,6 +156,14 @@ 
 
    Value should be "true".
 
+REQUIREDRAM
+   Value specifies expected memory requirements to decode the payload.
+   Values can have suffixes for common bytes sizes. e.g. "64MB".
+
+   This key is often used with zstd-compressed bundles using a high
+   compression level / window size, which can require 100+ MB of memory
+   to decode.
+
 heads
    Used for pull bundles. This contains the ``;`` separated changeset
    hashes of the heads of the bundle content.