This is an archive of the discontinued Mercurial Phabricator instance.

Differential D409

copies: add more details to the documentation of mergecopies()
ClosedPublic

Authored by pulkit on Aug 15 2017, 3:44 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG42ad7cc645a4: copies: add more details to the documentation of mergecopies()
Summary

This documentation is very helpful for any developer to understand what
copytracing is and what the function does. Since this is the main function of
doing copytracing, I have also included bits about copytracing in it.

This additions are picked from a doc by Stash@Fb. So thanks to him.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

pulkit created this revision.Aug 15 2017, 3:44 PM
durin42 accepted this revision.Aug 15 2017, 5:12 PM
This revision is now accepted and ready to land.Aug 15 2017, 5:12 PM
Closed by commit rHG42ad7cc645a4: copies: add more details to the documentation of mergecopies() (authored by pulkit). · Explain WhyAug 15 2017, 5:32 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/copies.py (22 lines)

Diff 950

mercurial/copies.py

if ic[0] in copyto: if ic[0] in copyto:
diverge[f] = [copyto[ic[0]], ic[1]] diverge[f] = [copyto[ic[0]], ic[1]]
else: else:
remainder[f] = ic remainder[f] = ic
return remainder return remainder
def mergecopies(repo, c1, c2, base): def mergecopies(repo, c1, c2, base):
""" """
The basic algorithm for copytracing. Copytracing is used in commands like
rebase, merge, unshelve, etc to merge files that were moved/ copied in one
merge parent and modified in another. For example:
o ---> 4 another commit
|
| o ---> 3 commit that modifies a.txt
| /
o / ---> 2 commit that moves a.txt to b.txt
|/
o ---> 1 merge base
If we try to rebase revision 3 on revision 4, since there is no a.txt in
revision 4, and if user have copytrace disabled, we prints the following
message:
```other changed <file> which local deleted```
If copytrace is enabled, this function finds all the new files that were
added from merge base up to the top commit (here 4), and for each file it
checks if this file was copied from another file (a.txt in the above case).
Find moves and copies between context c1 and c2 that are relevant Find moves and copies between context c1 and c2 that are relevant
for merging. 'base' will be used as the merge base. for merging. 'base' will be used as the merge base.
Returns five dicts: "copy", "movewithdir", "diverge", "renamedelete" and Returns five dicts: "copy", "movewithdir", "diverge", "renamedelete" and
"dirmove". "dirmove".
"copy" is a mapping from destination name -> source name, "copy" is a mapping from destination name -> source name,
where source is in c1 and destination is in c2 or vice-versa. where source is in c1 and destination is in c2 or vice-versa.