docs(env): minor improvements in environment variables doc #14676
Conversation
rustbot
added
A-documenting-cargo-itself
weihanglo
changed the title
| compiling the package (not when running binaries or tests). | ||
| on the current directory and the default workspace members. | ||
| This variable will not be set when building dependencies, | ||
| unless a dependency is also a workspace member. |
There was a problem hiding this comment.
I'm concerned that this statement isn't entirely true. In many (most?) cases, it won't be set for workspace member dependencies. For example in cargo's own workspace, it won't be set for any of its dependencies when doing cargo run.
I think to make this more accurate, perhaps change it to something like this?
| unless a dependency is also a workspace member. | |
| unless a dependency is also a workspace member that was also selected on the command-line. |
However, as noted in the issue, what is "selected on the command-line" is sometimes not intuitive.
There was a problem hiding this comment.
I just want to highlight that there is a bug in how cargo cache's this behavior, which is described in #14678. I don't think that needs to change anything here, but indicates that the answer to when it is set is "buggy".
There was a problem hiding this comment.
Thank you. That is more accurate. Updated!
I think one of the problems here is that the paragraph wasn't well arranged. There is no paragraph or newline there. We may really need to give each variable a heading.
|
Thanks! @bors r+ |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
What does this PR try to resolve?
Minor improvements in environment variables doc.
Fixes #10956
Fixes #13294
How should we test and review this PR?
Additional information