clonebundles: document REQUIREDRAM key stable
authorGregory Szorc <gregory.szorc@gmail.com>
Sun, 26 Jul 2020 12:46:04 -0700
branchstable
changeset 45252 20d110e6eea6
parent 45240 53a6febafc66
child 45253 9b5723784aac
clonebundles: document REQUIREDRAM key This is a follow-up to 72feaeb510b3, which introduced the feature. The key should be documented as part of the format specification inside the extension docstring. Differential Revision: https://phab.mercurial-scm.org/D8838
hgext/clonebundles.py
--- a/hgext/clonebundles.py	Tue Jul 28 10:19:49 2020 -0700
+++ b/hgext/clonebundles.py	Sun Jul 26 12:46:04 2020 -0700
@@ -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.