branch: externals/orderless
commit 7d704c0537ccdeea31f98448bdff8254c0cf8a9e
Author: Daniel Mendler <[email protected]>
Commit: Daniel Mendler <[email protected]>
README: Add partial-completion and basic overrides for files
---
README.org | 21 ++++++++++++++-------
orderless.texi | 19 +++++++++++++------
2 files changed, 27 insertions(+), 13 deletions(-)
diff --git a/README.org b/README.org
index 2f83c4cace..4d6670a404 100644
--- a/README.org
+++ b/README.org
@@ -62,21 +62,28 @@ If you use ELPA or MELPA, the easiest way to install
=orderless= is via
#+begin_src emacs-lisp
(use-package orderless
:ensure t
- :custom (completion-styles '(orderless basic)))
+ :custom
+ (completion-styles '(orderless basic))
+ (completion-category-overrides '((file (styles basic
partial-completion)))))
#+end_src
Alternatively, put =orderless.el= somewhere on your =load-path=, and use
the following configuration:
#+begin_src emacs-lisp
-(require 'orderless)
-(setq completion-styles '(orderless basic))
+ (require 'orderless)
+ (setq completion-styles '(orderless basic)
+ completion-category-overrides '((file (styles basic
partial-completion))))
#+end_src
-The =basic= completion style is specified as fallback in addition to
-=orderless= in order to ensure that completion commands which rely on
-dynamic completion tables, e.g., ~completion-table-dynamic~ or
-~completion-table-in-turn~, work correctly.
+The =basic= completion style is specified as fallback in addition to
=orderless= in
+order to ensure that completion commands which rely on dynamic completion
+tables, e.g., ~completion-table-dynamic~ or ~completion-table-in-turn~, work
+correctly. Furthermore the =basic= completion style is needed by Tramp hostname
+completion for the =file= completion category in the
+=completion-category-overrides=. In addition, the =partial-completion= style
allows
+you to use wildcards for file completion and partial paths, e.g., ~/u/l/s~ for
+~/usr/share/local~.
Bug reports are highly welcome and appreciated!
diff --git a/orderless.texi b/orderless.texi
index c1481666f4..732562e83b 100644
--- a/orderless.texi
+++ b/orderless.texi
@@ -111,7 +111,9 @@ If you use ELPA or MELPA, the easiest way to install
@samp{orderless} is via
@lisp
(use-package orderless
:ensure t
- :custom (completion-styles '(orderless basic)))
+ :custom
+ (completion-styles '(orderless basic))
+ (completion-category-overrides '((file (styles basic partial-completion)))))
@end lisp
Alternatively, put @samp{orderless.el} somewhere on your @samp{load-path}, and
use
@@ -119,13 +121,18 @@ the following configuration:
@lisp
(require 'orderless)
-(setq completion-styles '(orderless basic))
+(setq completion-styles '(orderless basic)
+ completion-category-overrides '((file (styles basic
partial-completion))))
@end lisp
-The @samp{basic} completion style is specified as fallback in addition to
-@samp{orderless} in order to ensure that completion commands which rely on
-dynamic completion tables, e.g., @code{completion-table-dynamic} or
-@code{completion-table-in-turn}, work correctly.
+The @samp{basic} completion style is specified as fallback in addition to
@samp{orderless} in
+order to ensure that completion commands which rely on dynamic completion
+tables, e.g., @code{completion-table-dynamic} or
@code{completion-table-in-turn}, work
+correctly. Furthermore the @samp{basic} completion style is needed by Tramp
hostname
+completion for the @samp{file} completion category in the
+@samp{completion-category-overrides}. In addition, the
@samp{partial-completion} style allows
+you to use wildcards for file completion and partial paths, e.g.,
@code{/u/l/s} for
+@code{/usr/share/local}.
Bug reports are highly welcome and appreciated!
