Update documentation for --env
compilation flag
This commit is contained in:
parent
32f5db9890
commit
bd984ddcc1
1 changed files with 19 additions and 1 deletions
|
@ -5,7 +5,10 @@ The tracking issue for this feature is: [#118372](https://github.com/rust-lang/r
|
|||
------------------------
|
||||
|
||||
This option flag allows to specify environment variables value at compile time to be
|
||||
used by `env!` and `option_env!` macros.
|
||||
used by `env!` and `option_env!` macros. It also impacts `tracked_env::var` function
|
||||
from the `proc_macro` crate.
|
||||
|
||||
This information will be stored in the dep-info files.
|
||||
|
||||
When retrieving an environment variable value, the one specified by `--env` will take
|
||||
precedence. For example, if you want have `PATH=a` in your environment and pass:
|
||||
|
@ -20,6 +23,21 @@ Then you will have:
|
|||
assert_eq!(env!("PATH"), "env");
|
||||
```
|
||||
|
||||
It will trigger a new compilation if any of the `--env` argument value is different.
|
||||
So if you first passed:
|
||||
|
||||
```bash
|
||||
--env A=B --env X=12
|
||||
```
|
||||
|
||||
and then on next compilation:
|
||||
|
||||
```bash
|
||||
--env A=B
|
||||
```
|
||||
|
||||
`X` value is different (not set) so the code will be re-compiled.
|
||||
|
||||
Please note that on Windows, environment variables are case insensitive but case
|
||||
preserving whereas `rustc`'s environment variables are case sensitive. For example,
|
||||
having `Path` in your environment (case insensitive) is different than using
|
||||
|
|
Loading…
Add table
Reference in a new issue