Merge commit '7fa7f099c7008d521dbbb57a1546f11535544536' from diff-hl

[gnu-emacs-elpa] / packages / diff-hl / README.md

diff --git a/packages/diff-hl/README.md b/packages/diff-hl/README.md
index 325f53ea570c349cbb6f346eafedf7f4106ef82c..ab8c9d81e25031b5a87fcc172033b2651a8892ed 100644 (file)
--- a/packages/diff-hl/README.md
+++ b/packages/diff-hl/README.md
@@ -15,6 +15,8 @@ The package also contains auxiliary modes:
 * `diff-hl-margin-mode` changes the highlighting function to\r
   use the margin instead of the fringe.\r
 * `diff-hl-amend-mode` shifts the reference revision back by one.\r
 * `diff-hl-margin-mode` changes the highlighting function to\r
   use the margin instead of the fringe.\r
 * `diff-hl-amend-mode` shifts the reference revision back by one.\r

+* `diff-hl-flydiff-mode` implements highlighting changes on the fly.\r
+  It requires Emacs 24.4 or newer.\r

 \r
 Check out the Commentary section in each respective file for the usage\r
 instructions.\r
 \r
 Check out the Commentary section in each respective file for the usage\r
 instructions.\r


@@ -46,10 +48,9 @@ Emacs 24+. On OS X, Emacs 24.3 or higher is recommended.
 Notes\r
 =====\r
 \r
 Notes\r
 =====\r
 \r

-* Since it uses the corresponding VC diff command, it's only accurate when the\r
-  buffer is in saved state. Highlighting changes "on the fly" might be better,\r
-  maybe we can do something similar to `highlight-markup-buffers` with a hidden\r
-  buffer containing the unmodified copy.\r
+* By default `diff-hl-mode` uses the corresponding VC diff command, so\r
+  it's only accurate when the buffer is in saved state. Check out\r
+  `diff-hl-flydiff-mode`, it aims to handle unsaved buffers as well.\r

 \r
 * We conflict with other modes when they put indicators on the fringe,\r
   such as [Flycheck](https://github.com/flycheck/flycheck). This is\r
 \r
 * We conflict with other modes when they put indicators on the fringe,\r
   such as [Flycheck](https://github.com/flycheck/flycheck). This is\r


@@ -63,6 +64,9 @@ Notes
 \r
 * Frame-local and buffer-local values of `line-spacing` are not supported.\r
 \r
 \r
 * Frame-local and buffer-local values of `line-spacing` are not supported.\r
 \r

+* Fringe width up to 16 works best (because we can't define a bitmap\r
+  with width above that number).\r
+\r

 * [emacs-git-gutter](https://github.com/syohex/emacs-git-gutter) shows\r
   indicators in the margin by default, allows you to customize how the\r
   indicators look more easily, and has a "stage hunk" command.\r
 * [emacs-git-gutter](https://github.com/syohex/emacs-git-gutter) shows\r
   indicators in the margin by default, allows you to customize how the\r
   indicators look more easily, and has a "stage hunk" command.\r


@@ -87,4 +91,4 @@ Magit
 -----\r
 \r
 If you have a recent enough version installed, it defines\r
 -----\r
 \r
 If you have a recent enough version installed, it defines\r

-`magit-revert-buffer-hook`, which we use.\r
+`magit-revert-buffer-hook` (or `magit-not-reverted-hook`), which we use.\r