Skip to content

Commit c826ebe

Browse files
committed
Add documentation.
1 parent 5747c68 commit c826ebe

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# libxdiff: java port
2+
3+
This is a line-for-line port of the subset of LibXDiff which relates to sliding within-line diffs to account for brackets, quotes, etc.
4+
5+
The heuristics used to develop the weights are available at [`mhagger/diff-slider-tools`](https://github.com/mhagger/diff-slider-tools).
6+
7+
The exact lines translated are [lines 438-677](https://github.com/git/git/blob/791ad494835ac544d9e91573f3a65aeb97d126ed/xdiff/xdiffi.c#L438-L677) of the `xdiffi.c` file as it existed in `git/git` on August 17 2018. As of Oct 20 2020, none of the changes in upstream have affected the lines we care about.
8+
9+
# Changelog
10+
11+
## [Unreleased]
12+
13+
Originally translated to java on August 30 2019, but it sat dormant on a local branch for too long.
14+
15+
<!-- END CHANGELOG -->
16+
17+
# Acknowledgements
18+
19+
- Thanks [Davide Libenzi](https://github.com/davidel) for writing the part of LibXDiff which we use.
20+
- Thanks to [Michael Haggerty](https://github.com/mhagger) for developing the heuristic weightings.

0 commit comments

Comments
 (0)