aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBozhidar Batsov <bozhidar@batsov.dev>2025-02-03 11:15:02 +0200
committerBozhidar Batsov <bozhidar@batsov.dev>2025-02-03 11:15:02 +0200
commite6c0f5f236b2e60fcf7f8d090fb3e2af0096d4ff (patch)
treeaf7f7e01e8e91070c6a7416b2c1669c7c05a4fd7 /doc
parent9979f835e818fe2389cc97f2694fedcd174d1c41 (diff)
Introduce projectile-auto-cleanup-known-projects
Diffstat (limited to 'doc')
-rw-r--r--doc/modules/ROOT/pages/usage.adoc15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/modules/ROOT/pages/usage.adoc b/doc/modules/ROOT/pages/usage.adoc
index 1aa1602..5ae1084 100644
--- a/doc/modules/ROOT/pages/usage.adoc
+++ b/doc/modules/ROOT/pages/usage.adoc
@@ -70,6 +70,21 @@ You can suppress the auto-discovery of projects on startup by setting
`projectile-auto-discover` to `nil`. You can manually trigger the project
discovery using `M-x projectile-discover-projects-in-search-path`.
+=== Removal of missing projects
+
+From time to time you'll have projects in your list of known projects that are no longer
+around. (e.g. they were removed or renamed) You can either trigger the command
+`projectile-cleanup-known-projects` manually or set the variable
+`projectile-auto-cleanup-known-projects` to `t` to remove such projects automatically.
+
+[source,elisp]
+----
+(setq projectile-cleanup-known-projects nil)
+----
+
+TIP: If you're a heavy TRAMP user it's probably not a good idea to auto-discover
+and cleanup projects, as the file operations are slower there.
+
=== Minibuffer Completion
While Projectile works fine with Emacs's default minibuffer completion system you're highly encouraged to use some