summaryrefslogtreecommitdiffstats
path: root/docs/config/README.md
diff options
context:
space:
mode:
authorOhad Lutzky <ohad@lutzky.net>2023-11-02 08:01:09 +0000
committerGitHub <noreply@github.com>2023-11-02 09:01:09 +0100
commit7b851fc30e109213e911eec38460315872f1ae59 (patch)
treeed01b5fb1cd1bbcf69d2c4aa6711ed3c2762a6e6 /docs/config/README.md
parentca5851d155b3b0e15711328561ba5f84ab1c962c (diff)
feat(scanner): add option not to follow symlinks (#5325)
Add follow_symlinks option Settings this to false can fix hanging on symlinks to slow/inaccessible filesystems.
Diffstat (limited to 'docs/config/README.md')
-rw-r--r--docs/config/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index 5dc22dd29..55315d93c 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -219,6 +219,14 @@ This is the list of prompt-wide configuration options.
| `add_newline` | `true` | Inserts blank line between shell prompts. |
| `palette` | `''` | Sets which color palette from `palettes` to use. |
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
+| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
+
+::: tip
+
+If you have symlinks to networked filesystems, consider setting
+`follow_symlinks` to `false`.
+
+:::
### Example