branch: externals/truename-cache
commit 9c11ee4c73b403665a91520f7b2ea7950aefb3e3
Author: Martin Edström <[email protected]>
Commit: Martin Edström <[email protected]>
Fix doc bug
---
README.org | 2 +-
truename-cache.el | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/README.org b/README.org
index d5e1955e31..d2ab55d1dd 100644
--- a/README.org
+++ b/README.org
@@ -65,7 +65,7 @@ While you could simply let
=truename-cache-collect-files-and-attributes= return
Sometimes you do not want a true name, but a name abbreviated with
=abbreviate-file-name=. For one thing, it's just preferable to present such
names to the user, but for another, that's what will match the confusingly
named buffer-local variable =buffer-file-truename= -- the actual truename will
not.
-(Even /more/ confusingly, the function =get-truename-buffer= needs the actual
truename...)
++(Even /more/ confusingly, the function =get-truename-buffer= needs the actual
truename...)+ EDIT: Sorry, I was wrong!
But =abbreviate-file-name= is another thing that can consume much of our
aforementioned 100 millisecond budget, all by itself.
diff --git a/truename-cache.el b/truename-cache.el
index 71f5de569b..25419f8809 100644
--- a/truename-cache.el
+++ b/truename-cache.el
@@ -530,14 +530,14 @@ name handlers to allow, and t means allow all of them:
ABBREV transforms each file name returned.
It can take one of three values:
-- nil :: Return true names that work with `get-truename-buffer'.
+- nil :: Return true names.
- `dir' :: Return non-true names more likely to match instances of
variable `buffer-file-name' and to work with `get-file-buffer'.
Corresponds to `truename-cache-get-dir-abbrev'.
- `full' :: Return non-true names very likely to match instances of
- variable `buffer-file-truename'.
+ variable `buffer-file-truename' and to work with `get-truename-buffer'.
Corresponds to `truename-cache-get-full-abbrev'.
This match is reliable except when the value of LOCAL-NAME-HANDLERS
