ok/jj
1
0
Fork 0
forked from mirrors/jj
Code Pull requests Activity

docs: explicitly list the platform-specific config paths

Browse source 
The value table is borrowed from the upstream dirs library documenation:
- https://docs.rs/dirs/5.0.0/dirs/fn.config_dir.html
This commit is contained in:
Aaron Bull Schaefer 2023-04-12 12:56:59 -07:00
parent a3973cc53f
commit ba9ecea269
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/config.md
View file

@ -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