From ba9ecea269e25ffac8baf59a167057b365d21c1f Mon Sep 17 00:00:00 2001 From: Aaron Bull Schaefer Date: Wed, 12 Apr 2023 12:56:59 -0700 Subject: [PATCH] docs: explicitly list the platform-specific config paths The value table is borrowed from the upstream dirs library documenation: - https://docs.rs/dirs/5.0.0/dirs/fn.config_dir.html --- docs/config.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/config.md b/docs/config.md index 8e8e9f95e..afa0a96e9 100644 --- a/docs/config.md +++ b/docs/config.md @@ -400,11 +400,14 @@ deleted if you push the branch with `jj git push --branch` or `jj git push # Alternative ways to specify configuration settings -Instead of `~/.jjconfig.toml`, the config settings can be located at -`$XDG_CONFIG_HOME/jj/config.toml` as per the [XDG specification]. It is an error -for both of these files to exist. +Instead of `~/.jjconfig.toml`, the config settings can be located under +a platform-specific directory. It is an error for both of these files to exist. -[XDG specification]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html +| Platform | Value | Example | +| :------- | :------------------------------------------------- | :-------------------------------------------------------- | +| Linux | `$XDG_CONFIG_HOME/jj/config.toml` | `/home/alice/.config/jj/config.toml` | +| macOS | `$HOME/Library/Application Support/jj/config.toml` | `/Users/Alice/Library/Application Support/jj/config.toml` | +| Windows | `{FOLDERID_RoamingAppData}\jj\config.toml` | `C:\Users\Alice\AppData\Roaming\jj\config.toml` | The location of the `jj` config file can also be overridden with the `JJ_CONFIG` environment variable. If it is not empty, it should contain the path