aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorpipehat <cid@freeshell.org>2020-05-03 16:43:07 +0200
committerBozhidar Batsov <bozhidar.batsov@gmail.com>2020-05-17 08:53:02 +0300
commit0b464f895c90bd2f81d37dcc06bb3f51e7454ce6 (patch)
tree27fe4b8991340ec31fe30ab2a1bed9bbc21ddf6f /doc
parentf650faecf699e4b4659374cf5a949f6927feff3e (diff)
Support for optional comments in .projectile files by customizing projectile-dirconfig-comment-prefix.
Resolves bbatsov/projectile#1522
Diffstat (limited to 'doc')
-rw-r--r--doc/projects.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/projects.md b/doc/projects.md
index 51029b6..3711550 100644
--- a/doc/projects.md
+++ b/doc/projects.md
@@ -326,6 +326,12 @@ When a path is overridden, its contents are still subject to ignore
patterns. To override those files as well, specify their full path
with a bang prefix.
+If you would like to include comment lines in your .projectile file,
+you can customize the variable `projectile-dirconfig-comment-prefix`.
+Assigning it a non-nil character value, e.g. `#`, will cause lines in
+the .projectile file starting with that character to be treated as
+comments instead of patterns.
+
### File-local project root definitions
If you want to override the projectile project root for a specific