diff options
| author | Bozhidar Batsov <bozhidar@batsov.dev> | 2021-11-25 16:22:34 +0200 |
|---|---|---|
| committer | Bozhidar Batsov <bozhidar@batsov.dev> | 2021-11-25 16:22:34 +0200 |
| commit | d31860b7d37cf6a3e735062a2618c6b9f514a309 (patch) | |
| tree | cf71500c64ea910388c4082e69c2dfde9a5a4902 /doc | |
| parent | 45d217a921006f2daeecd9c7da1b788d6aab5b96 (diff) | |
[Docs] Add some more explanations about projectile-completion-system
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/modules/ROOT/pages/configuration.adoc | 19 | ||||
| -rw-r--r-- | doc/modules/ROOT/pages/usage.adoc | 2 |
2 files changed, 16 insertions, 5 deletions
diff --git a/doc/modules/ROOT/pages/configuration.adoc b/doc/modules/ROOT/pages/configuration.adoc index fd61195..f17daa3 100644 --- a/doc/modules/ROOT/pages/configuration.adoc +++ b/doc/modules/ROOT/pages/configuration.adoc @@ -364,18 +364,29 @@ top-level directory. == Completion Options +Projectile supports all major minibuffer completion packages that +exist today. Normally it will just detect what you're using (e.g. `ivy`), +but you can force a particular completion system via the variable +`projectile-completion-system`. + +NOTE: Historically `projectile-completion-system` defaulted to `ido`, +but this was changed in version 2.3. You may need to enable `ido-mode` +in your Emacs configuration if updating from an older version of Projectile. + === Auto (default) By default Projectile detects the completion system in use, based on the mode variables `ido-mode`, `ivy-mode` and `helm-mode`. If none of those is activated, the `default` completion system is used. -Unless for some reason you want to use a different completion system for Projectile than for the -rest of Emacs, you'll probably don't want to select a particular completion system manually. +Unless for some reason you want to use a different completion system for +Projectile than for the rest of Emacs (e.g. you normally use `icomplete-mode`, +but want to use `ido-mode` with Projectile), you'll probably don't want to +select a particular completion system manually. === Basic (Emacs's default) -If you don't like `ido` and `ivy` you can use regular completion (based on `completing-read`): +Select this option if you want to use Emacs's standard completion (based on `completing-read`): [source,elisp] ---- @@ -386,7 +397,7 @@ TIP: You might want to combine default completion with `icomplete-mode` for opti Emacs 27 added `fido-mode` to `icomplete`. If you are using `fido-mode`, Projectile will -use the `default` completion system. The same holds for `selectrum` which also relies +use the `default` completion system. The same holds for `selectrum` and `vertico` which also rely on the `default` completion system. === Ido diff --git a/doc/modules/ROOT/pages/usage.adoc b/doc/modules/ROOT/pages/usage.adoc index 354ee98..ac1b8e6 100644 --- a/doc/modules/ROOT/pages/usage.adoc +++ b/doc/modules/ROOT/pages/usage.adoc @@ -36,7 +36,7 @@ discovery using `M-x projectile-discover-projects-in-search-path`. === Minibuffer Completion While Projectile works fine with Emacs's default minibuffer completion system you're highly encouraged to use some -powerful alternative like `ido`, `ivy` or `selectrum`. +powerful alternative like `ido`, `ivy`, `selectrum` or `vertico`. TIP: If you're going to use the `ido` completion it's **highly** recommended that you install the optional https://github.com/lewang/flx[flx-ido package], which provides a much more powerful |
