Rev 2949: Make the docstring for _find_file_ids_from_xml_inventory_lines explicit about the use filter_ids is put to. in http://people.ubuntu.com/~robertc/baz2.0/pack

[Robert Collins]

At http://people.ubuntu.com/~robertc/baz2.0/pack

------------------------------------------------------------
revno: 2949
revision-id:robertc at robertcollins.net-20071028234731-17kxx1yqlzuw1rof
parent: robertc at robertcollins.net-20071028190205-j7669ntq0jj7s5fl
committer: Robert Collins <robertc at robertcollins.net>
branch nick: pack
timestamp: Mon 2007-10-29 10:47:31 +1100
message:
  Make the docstring for _find_file_ids_from_xml_inventory_lines explicit about the use filter_ids is put to.
modified:
  bzrlib/repository.py           rev_storage.py-20051111201905-119e9401e46257e3
=== modified file 'bzrlib/repository.py'
--- a/bzrlib/repository.py	2007-10-26 08:56:09 +0000
+++ b/bzrlib/repository.py	2007-10-28 23:47:31 +0000
@@ -1058,7 +1058,10 @@
         This performs the translation of xml lines to revision ids.
 
         :param line_iterator: An iterator of lines
-        :param revision_ids: The revision ids to filter for.
+        :param revision_ids: The revision ids to filter for. This should be a
+            set or other type which supports efficient __contains__ lookups, as
+            the revision id from each parsed line will be looked up in the
+            revision_ids filter.
         :return: a dictionary mapping altered file-ids to an iterable of
         revision_ids. Each altered file-ids has the exact revision_ids that
         altered it listed explicitly.