config docs: document valid fsmonitor values

I was wondering how to disable the watchman in a repo if it's enabled in
the user config.
This commit is contained in:
Ilya Grigoriev 2024-04-10 22:29:50 -07:00
parent 37be542ebf
commit 383711fcd8
2 changed files with 13 additions and 0 deletions

View file

@ -155,6 +155,16 @@
} }
} }
}, },
"core": {
"type": "object",
"properties": {
"fsmonitor": {
"type": "string",
"enum": ["none", "watchman"],
"description": "Whether to use an external filesystem monitor, useful for large repos"
}
}
},
"colors": { "colors": {
"type": "object", "type": "object",
"description": "Mapping from jj formatter labels to colors", "description": "Mapping from jj formatter labels to colors",

View file

@ -718,6 +718,9 @@ In large repositories, it may be beneficial to use a "filesystem monitor" to
track changes to the working copy. This allows `jj` to take working copy track changes to the working copy. This allows `jj` to take working copy
snapshots without having to rescan the entire working copy. snapshots without having to rescan the entire working copy.
This is governed by the `core.fsmonitor` option. Currently, the valid values are
`"none"` or `"watchman"`.
### Watchman ### Watchman
To configure the Watchman filesystem monitor, set To configure the Watchman filesystem monitor, set