[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master 1558064 35/42: Reword the recent README changes
From: |
Dmitry Gutov |
Subject: |
[elpa] master 1558064 35/42: Reword the recent README changes |
Date: |
Wed, 09 Sep 2015 19:03:46 +0000 |
branch: master
commit 15580640b3078405455faf0228a13eed3212f188
Author: Dmitry Gutov <address@hidden>
Commit: Dmitry Gutov <address@hidden>
Reword the recent README changes
---
README.md | 7 ++++++-
1 files changed, 6 insertions(+), 1 deletions(-)
diff --git a/README.md b/README.md
index 20274bb..ab8c9d8 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,8 @@ The package also contains auxiliary modes:
* `diff-hl-margin-mode` changes the highlighting function to
use the margin instead of the fringe.
* `diff-hl-amend-mode` shifts the reference revision back by one.
-* `diff-hl-flydiff-mode` enables diffing unsaved changes
+* `diff-hl-flydiff-mode` implements highlighting changes on the fly.
+ It requires Emacs 24.4 or newer.
Check out the Commentary section in each respective file for the usage
instructions.
@@ -47,6 +48,10 @@ Emacs 24+. On OS X, Emacs 24.3 or higher is recommended.
Notes
=====
+* By default `diff-hl-mode` uses the corresponding VC diff command, so
+ it's only accurate when the buffer is in saved state. Check out
+ `diff-hl-flydiff-mode`, it aims to handle unsaved buffers as well.
+
* We conflict with other modes when they put indicators on the fringe,
such as [Flycheck](https://github.com/flycheck/flycheck). This is
rarely a significant problem, since if you're using such a mode,
- [elpa] master 3ab3aae 29/42: Fix *another* usage of "ignored", (continued)
- [elpa] master 3ab3aae 29/42: Fix *another* usage of "ignored", Dmitry Gutov, 2015/09/09
- [elpa] master 2992efd 31/42: Simplify diff-hl-flydiff/modified-p advice, Dmitry Gutov, 2015/09/09
- [elpa] master 6ab3ebe 30/42: Stop duplicating code in diff-hl-changes, Dmitry Gutov, 2015/09/09
- [elpa] master 2209370 27/42: Ensure working revisions are never stale, Dmitry Gutov, 2015/09/09
- [elpa] master 15aa2b8 26/42: Fix usage of "ignored", Dmitry Gutov, 2015/09/09
- [elpa] master 2d40373 34/42: Update diff-hl-flydiff/vc-git-mode-line-string as per Emacs master, Dmitry Gutov, 2015/09/09
- [elpa] master a16b225 38/42: One fewer version check, Dmitry Gutov, 2015/09/09
- [elpa] master f300548 33/42: Merge pull request #50 from PythonNut/master, Dmitry Gutov, 2015/09/09
- [elpa] master 7428f4a 37/42: Reduce warnings during byte-compilation; don't error b-c in <24.4, Dmitry Gutov, 2015/09/09
- [elpa] master 418dbc7 32/42: Update docs to reflect new diff-hl-flydiff-mode, Dmitry Gutov, 2015/09/09
- [elpa] master 1558064 35/42: Reword the recent README changes,
Dmitry Gutov <=
- [elpa] master 8d313db 36/42: Use --strip-trailing-cr, Dmitry Gutov, 2015/09/09
- [elpa] master 5068da4 39/42: Reindent, Dmitry Gutov, 2015/09/09
- [elpa] master 7fa7f09 41/42: Bump the version, Dmitry Gutov, 2015/09/09
- [elpa] master e576ee2 40/42: Make diff-hl-flydiff-delay customizable, Dmitry Gutov, 2015/09/09
- [elpa] master a454a24 42/42: Merge commit '7fa7f099c7008d521dbbb57a1546f11535544536' from diff-hl, Dmitry Gutov, 2015/09/09