From ca2cb30337ef42196147c632752944b6a070c7be Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Sun, 20 Dec 2020 13:40:07 -0600 Subject: [PATCH] cmd: fux config file paths --- content/docs/command-reference/config.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/content/docs/command-reference/config.md b/content/docs/command-reference/config.md index 44bf7fba48..ce3fc46bc5 100644 --- a/content/docs/command-reference/config.md +++ b/content/docs/command-reference/config.md @@ -38,18 +38,21 @@ instead, to set (or override) secrets: The `--global` and `--system` flags are also available to set config options for multiple projects and users, respectively: -| Flag | Priority | Mac location | Linux location | Windows location | -| ---------- | -------- | ---------------------------------------- | -------------------------- | --------------------------------------------------------- | -| `--global` | 3 | `$HOME/Library/Application\ Support/dvc` | `$HOME/.config/dvc/config` | `%LocalAppData%\iterative\dvc\config` | -| `--system` | 4 | `/Library/Application\ Support/dvc` | `/etc/dvc/config` | `%AllUsersProfile%\Application Data\iterative\dvc\config` | - - + +| Flag | Priority | Mac location | Linux location (typical\*) | Windows location | +| ---------- | -------- | -------------------------------------- | -------------------------- | --------------------------------------------------------- | +| `--global` | 3 | `$HOME/Library/Preferences/dvc/config` | `$HOME/.config/dvc/config` | `%LocalAppData%\iterative\dvc\config` | +| `--system` | 4 | `/Library/Preferences/dvc/config` | `/etc/xdg/dvc/config` | `%AllUsersProfile%\Application Data\iterative\dvc\config` | + +> \* For Linux, the global `dvc/config` may be found in `$XDG_CONFIG_HOME`, and +> the system-wide one in `$XDG_CONFIG_DIRS[0]`, if those env vars are defined. + ## Command options (flags) - `-u`, `--unset` - remove a specified config option from a config file. @@ -64,7 +67,8 @@ multiple projects and users, respectively: - `--system` - modify a system config file (e.g. `/etc/dvc/config`) instead of `.dvc/config`. Useful to apply config options to all the projects (all users) - in the machine. + in the machine. May require superuser access e.g. + `sudo dvc config --system ...` (Linux). - `-l`, `--list` - lists all defined config values.