From afe1559b0fe53db1db0a567109b467d41441aff5 Mon Sep 17 00:00:00 2001 From: Dipsy Date: Tue, 6 Feb 2024 23:34:37 +0100 Subject: [PATCH] adapt documentation to load-workspace-config enum setting --- book/src/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/src/configuration.md b/book/src/configuration.md index 9c61ad8d3..6ebb5f0bb 100644 --- a/book/src/configuration.md +++ b/book/src/configuration.md @@ -30,7 +30,7 @@ You can use a custom configuration file by specifying it with the `-c` or Additionally, you can reload the configuration file by sending the USR1 signal to the Helix process on Unix operating systems, such as by using the command `pkill -USR1 hx`. -Finally, you can have a `config.toml` local to a project by putting it under a `.helix` directory in your repository and adding `workspace-config = true` to the top of your configuration directory `config.toml`. +Finally, you can have a `config.toml` local to a project by putting it under a `.helix` directory in your repository and adding `load-workspace-config = "always"` to the top of your configuration directory `config.toml`. Its settings will be merged with the configuration directory `config.toml` and the built-in configuration. Enabling workspace configs is a potential security risk. A project from an untrusted sources may e.g. contain a `.helix/config.toml` that overrides the `editor.shell` parameter to execute malicious code on your machine.