[PATCH 2 of 6 clone bundles] exchange: document filterclonebundleentries

Gregory Szorc gregory.szorc at gmail.com
Wed Oct 14 13:07:54 CDT 2015


# HG changeset patch
# User Gregory Szorc <gregory.szorc at gmail.com>
# Date 1444842206 25200
#      Wed Oct 14 10:03:26 2015 -0700
# Node ID a46e2def3ea9bea154939c0ce56a0e47a25b2180
# Parent  2a84ef46763f9e6d1fcc71348ea179fef144f869
exchange: document filterclonebundleentries

diff --git a/mercurial/exchange.py b/mercurial/exchange.py
--- a/mercurial/exchange.py
+++ b/mercurial/exchange.py
@@ -1676,8 +1676,17 @@ def parseclonebundlesmanifest(repo, s):
 
     return m
 
 def filterclonebundleentries(repo, entries):
+    """Remove incompatible clone bundle manifest entries.
+
+    Accepts a list of entries parsed with ``parseclonebundlesmanifest``
+    and returns a new list consisting of only the entries that this client
+    should be able to apply.
+
+    There is no guarantee we'll be able to apply all returned entries because
+    the metadata we use to filter on may be missing or wrong.
+    """
     newentries = []
     for entry in entries:
         spec = entry.get('BUNDLESPEC')
         if spec:


More information about the Mercurial-devel mailing list