exchange: document filterclonebundleentries
authorGregory Szorc <gregory.szorc@gmail.com>
Wed, 14 Oct 2015 10:03:26 -0700
changeset 26687 6a854f558926
parent 26686 3e7f675628ad
child 26688 7394536338bb
exchange: document filterclonebundleentries
mercurial/exchange.py
--- a/mercurial/exchange.py	Wed Oct 14 10:58:35 2015 -0700
+++ b/mercurial/exchange.py	Wed Oct 14 10:03:26 2015 -0700
@@ -1677,6 +1677,15 @@
     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')