← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/versionedfile.py

  • Committer: Alexander Belchenko
  • Date: 2007-11-19 22:54:30 UTC
  • mfrom: (3006 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3008.
  • Revision ID: bialix@ukr.net-20071119225430-x0ewosrsagis0yno
merge bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/versionedfile.py
420
420
            version_ids,
421
421
            ignore_missing)
422
422
 
423
 
    def iter_lines_added_or_present_in_versions(self, version_ids=None, 
 
423
    def iter_lines_added_or_present_in_versions(self, version_ids=None,
424
424
                                                pb=None):
425
425
        """Iterate over the lines in the versioned file from version_ids.
426
426
 
427
 
        This may return lines from other versions, and does not return the
428
 
        specific version marker at this point. The api may be changed
429
 
        during development to include the version that the versioned file
430
 
        thinks is relevant, but given that such hints are just guesses,
431
 
        its better not to have it if we don't need it.
 
427
        This may return lines from other versions. Each item the returned
 
428
        iterator yields is a tuple of a line and a text version that that line
 
429
        is present in (not introduced in).
 
430
 
 
431
        Ordering of results is in whatever order is most suitable for the
 
432
        underlying storage format.
432
433
 
433
434
        If a progress bar is supplied, it may be used to indicate progress.
434
435
        The caller is responsible for cleaning up progress bars (because this
436
437
 
437
438
        NOTES: Lines are normalised: they will all have \n terminators.
438
439
               Lines are returned in arbitrary order.
 
440
 
 
441
        :return: An iterator over (line, version_id).
439
442
        """
440
443
        raise NotImplementedError(self.iter_lines_added_or_present_in_versions)
441
444