Add warning about XDG dirs

This commit is contained in:
Julian Ospald 2021-06-12 22:35:03 +02:00
parent 581108ab65
commit ff32ccfb50
Signed by: hasufell
GPG Key ID: 3786C5262ECB4A3F

View File

@ -123,6 +123,9 @@ Then you can control the locations via XDG environment variables as such:
* `XDG_BIN_HOME`: binaries end up here (default: `~/.local/bin`) * `XDG_BIN_HOME`: binaries end up here (default: `~/.local/bin`)
* `XDG_CONFIG_HOME`: the config file is stored in `ghcup` subdir as `config.yaml` (default: `~/.config`) * `XDG_CONFIG_HOME`: the config file is stored in `ghcup` subdir as `config.yaml` (default: `~/.config`)
**Note that `ghcup` makes some assumptions about structure of files in `XDG_BIN_HOME`. So if you have other tools
installing e.g. stack/cabal/ghc into it, this will likely clash. In that case consider disabling XDG support.**
### Env variables ### Env variables
This is the complete list of env variables that change GHCup behavior: This is the complete list of env variables that change GHCup behavior: