]> code.delx.au - gnu-emacs-elpa/blob - README.md
Improve documentation (Refs #1)
[gnu-emacs-elpa] / README.md
1 About
2 =====
3
4 `diff-hl-mode` highlights uncommitted changes on the left fringe of the buffer
5 window, allows you to jump between them, and revert them selectively.
6
7 For the usage instructions and the list of commands, see the header comment.
8
9 Tested with Git, Mercurial, and Bazaar. May work with other VC backends, too.
10
11 Screenshot
12 =====
13
14 [![Foo](http://i.imgur.com/bC8dBs.png)](http://i.imgur.com/bC8dB.png)
15
16 Notes
17 =====
18
19 * Since it uses the corresponding VC diff command, it's only accurate when the
20 buffer is in saved state. Highlighting changes "on the fly" might be better,
21 maybe we can do something similar to `highlight-markup-buffers` with a hidden
22 buffer containing the unmodified copy.
23
24 * Out of modes providing similar functionality, `highlight-changes-mode` is the
25 closest I could find. Angry Fruit Salad aside, it may be fine for writing
26 prose, but think it's pretty much useless for version-controlled files.