Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add [env] section to reference #9297

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions src/doc/src/reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,11 @@ verbose = false # whether cargo provides verbose output
color = 'auto' # whether cargo colorizes output
progress.when = 'auto' # whether cargo shows progress bar
progress.width = 80 # width of progress bar

[env]
FOO = "…" # set FOO to value
BAR = { value = "…", relative = true } # set FOO as relative path
BAZ = { value = "…", force = true } # overwrite FOO
```

### Environment variables
Expand Down Expand Up @@ -918,6 +923,30 @@ Controls whether or not progress bar is shown in the terminal. Possible values:

Sets the width for progress bar.

#### `[env]`

The `[env]` section sets additional environment variables for program invocations done
by `cargo`.

##### `env.<name>`
* Type: string or map
* Default: none

Sets environment variable `<name>`. Variables have optional `force` and `relative` flags:

* `force` (boolean): The variable can override an existing environment variable.
* `relative` (boolean): The variable represents a path relative to the location of the
directory that contains the `.cargo/` directory that contains the `config.toml` file.
A relative variable will have an absolute path prepended to it before setting it in the
environment.

```toml
[env]
FOO = "foo"
PATH_TO_SOME_TOOL = { value = "bin/tool", relative = true }
USERNAME = { value = "test_user", force = true }
```

[`cargo bench`]: ../commands/cargo-bench.md
[`cargo login`]: ../commands/cargo-login.md
[`cargo new`]: ../commands/cargo-new.md
Expand Down