[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/projectile 7d414ea342 2/2: [Docs] Mention projectile-root-
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/projectile 7d414ea342 2/2: [Docs] Mention projectile-root-marked |
Date: |
Mon, 14 Nov 2022 01:59:20 -0500 (EST) |
branch: elpa/projectile
commit 7d414ea3421689a766383b03e566c5399419c566
Author: Bozhidar Batsov <bozhidar@batsov.dev>
Commit: Bozhidar Batsov <bozhidar@batsov.dev>
[Docs] Mention projectile-root-marked
---
doc/modules/ROOT/pages/projects.adoc | 3 +++
1 file changed, 3 insertions(+)
diff --git a/doc/modules/ROOT/pages/projects.adoc
b/doc/modules/ROOT/pages/projects.adoc
index 2db20e74c1..c39beaca67 100644
--- a/doc/modules/ROOT/pages/projects.adoc
+++ b/doc/modules/ROOT/pages/projects.adoc
@@ -549,6 +549,7 @@ Let's take a closer look at
`projectile-project-root-functions`:
----
(defcustom projectile-project-root-functions
'(projectile-root-local
+ projectile-root-marked
projectile-root-bottom-up
projectile-root-top-down
projectile-root-top-down-recurring)
@@ -563,6 +564,8 @@ precedence with respect to project detection. Let's examine
the defaults:
* `projectile-root-local` looks for project path set via the buffer-local
variable `projectile-project-root`. Typically you'd set this variable via
`.dir-locals.el` and it will take precedence over everything else.
+* `projectile-root-marked` looks for `.projectile` (or whatever you've set as
the value of `projectile-dirconfig-file`). The idea is that normally if you
have a `.projectile` file you'd like it to override the normal project root
discovery logic.
+
* `projectile-root-bottom-up` will start looking for a project marker
file/folder(e.g. `.projectile`, `.hg`, `.git`) from the current folder (a.k.a.
`default-directory` in Emacs lingo) up the directory tree. It will return the
first match it discovers. The assumption is pretty simple - the root marker
appear only once, at the root folder of a project. If a root marker appear in
several nested folders (e.g. you've got nested git projects), the bottom-most
(closest to the current dir) matc [...]
* `projectile-root-top-down` is similar, but it will return the top-most
(farthest from the current directory) match. It's configurable via
`projectile-project-root-files` and all project manifest markers like
`pom.xml`, `Gemfile`, `project.clj`, etc go there.