diff options
| author | Bozhidar Batsov <bozhidar@batsov.dev> | 2022-10-27 19:28:13 +0300 |
|---|---|---|
| committer | Bozhidar Batsov <bozhidar@batsov.dev> | 2022-10-27 19:28:13 +0300 |
| commit | 0515f1b647be953183336074cffd02497c7f86b9 (patch) | |
| tree | a37d2ee2fd5abf3ebce853e83fabaa249b944b01 | |
| parent | 73e5da8d979901a653f616c4544d53810f7c9fca (diff) | |
Extend the project.el integration docs
| -rw-r--r-- | doc/modules/ROOT/pages/usage.adoc | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/modules/ROOT/pages/usage.adoc b/doc/modules/ROOT/pages/usage.adoc index 63922d5..a383b39 100644 --- a/doc/modules/ROOT/pages/usage.adoc +++ b/doc/modules/ROOT/pages/usage.adoc @@ -391,9 +391,16 @@ Starting with version 2.7 Projectile bundles some integration with project lookup function (`projectile-project-root`) and project file lookup function (`projectile-project-files`). +TIP: You can read more about the integration https://github.com/bbatsov/projectile/issues/1591[here]. + That's useful as some packages (e.g. `eglot`) support natively only `project.el`'s API for project discovery. Fortunately, `project.el` makes it easy to install additional project lookup functions and that's exactly what Projectile does. -TIP: You can read more about the integration https://github.com/bbatsov/projectile/issues/1591[here]. +The popular `xref` package also relies on `project.el` to infers the project +for use commands like `xref-find-references` (kbd:[M-?]), so it's useful to teach it +about Projectile's project discovery logic. + +TIP: Projectile provides its own alternative to `xref-find-references` that's named +`projectile-find-references` (kbd:[s-p ?] or kbd:[s-p s-x]) and is using `xref` internally. |