comparison mercurial/copies.py @ 30185:e2bfe2d52d7a

copies: move variable document from checkcopies to mergecopies

It appears that 'mergecopies' is the function consuming these data so we move
the documentation there.

30184:7321c6b0c9fd

    m1 = c1.manifest()
    m2 = c2.manifest()
    ma = ca.manifest()

    # see _checkcopies documentation below for these dicts
    diverge = {} # divergence data is shared
    data1 = {'copy': {},
             'fullcopy': {},
             'diverge': diverge,
            }

    f = the filename to check (as in m1)
    m1 = the source manifest
    m2 = the destination manifest
    base = the changectx used as a merge base
    limit = the rev number to not search beyond
    data = dictionary of dictionary to store copy data. The keys are:
    - diverge = record all diverges in this dict
    - copy = record all non-divergent copies in this dict
    - fullcopy = record all copies in this dict

    note: limit is only an optimization, and there is no guarantee that
    irrelevant revisions will not be limited
    there is no easy way to make this algorithm stop in a guaranteed way
    once it "goes behind a certain revision".

30185:e2bfe2d52d7a

    m1 = c1.manifest()
    m2 = c2.manifest()
    ma = ca.manifest()

    # gather data from _checkcopies:
    # - diverge = record all diverges in this dict
    # - copy = record all non-divergent copies in this dict
    # - fullcopy = record all copies in this dict
    diverge = {} # divergence data is shared
    data1 = {'copy': {},
             'fullcopy': {},
             'diverge': diverge,
            }

    f = the filename to check (as in m1)
    m1 = the source manifest
    m2 = the destination manifest
    base = the changectx used as a merge base
    limit = the rev number to not search beyond
    data = dictionary of dictionary to store copy data. (see mergecopies)

    note: limit is only an optimization, and there is no guarantee that
    irrelevant revisions will not be limited
    there is no easy way to make this algorithm stop in a guaranteed way
    once it "goes behind a certain revision".