aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@batsov.com>2020-11-27 18:43:40 +0200
committerBozhidar Batsov <bozhidar@batsov.com>2020-11-27 18:43:40 +0200
commitd1cfad008b1719a6bee17fbe9479db414c0dc5d9 (patch)
tree5cbd700623fb1c9eee4edce41d7c39c3d6b365bd /doc
parent45b0481adca89c9b23e7771e513c65a5cf27d0a8 (diff)
[Docs] Expand a bit on project detection
Diffstat (limited to 'doc')
-rw-r--r--doc/modules/ROOT/pages/projects.adoc13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/modules/ROOT/pages/projects.adoc b/doc/modules/ROOT/pages/projects.adoc
index 2ba3fa3..f1aabb7 100644
--- a/doc/modules/ROOT/pages/projects.adoc
+++ b/doc/modules/ROOT/pages/projects.adoc
@@ -6,6 +6,19 @@ One of the main goals of Projectile is to operate on a wide range of project typ
without the need for any configuration. To achieve this it contains a lot of
project detection logic and project type specific logic.
+Broadly speaking, Projectile identifies projects like this:
+
+* Directories under version control (e.g. a Git repo)
+* Directories that contain some project description file (e.g. a `Gemfile` for Ruby projects)
+* Directories that contain the special `.projectile` file
+
+While Projectile aims to recognize most project types out-of-the-box, it's also extremely
+flexible configuration-wise, and you can easily alter the project detection logic.
+
+TIP: If you'd like to override the default project detection functions you should
+check out `projectile-project-root-files-functions`. We'll discuss how to tweak in more
+details later in the documentation.
+
=== Version Control Systems
Projectile considers most version-controlled repos to be