# HG changeset patch
# User Gregory Szorc <gregory.szorc@gmail.com>
# Date 2020-07-26 19:46:04
# Node ID 20d110e6eea6f37f83c873ec97e0fb5c9fa109ef
# Parent  53a6febafc664c255ad80f0f75c98be8a4403625

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

diff --git a/hgext/clonebundles.py b/hgext/clonebundles.py
--- a/hgext/clonebundles.py
+++ b/hgext/clonebundles.py
@@ -156,6 +156,14 @@ REQUIRESNI
 
    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.