[doc] add note about empty environment variables for missing manifest keys #9053
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @alexcrichton (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
|
@bors: r+ Thanks! |
|
📌 Commit 48cd236 has been approved by |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
Update cargo 10 commits in 329895f5b52a358e5d9ecb26215708b5cb31d906..a73e5b7d567c3036b296fc6b33ed52c5edcd882e 2021-01-06 00:01:52 +0000 to 2021-01-12 23:45:39 +0000 - Sort available binaries when multiple (rust-lang/cargo#9066) - Fix misspelling of environment variable (rust-lang/cargo#9067) - Remove statement that opt-level 0 turns on debug (rust-lang/cargo#9070) - Fix `links` vars showing up for testing packages (rust-lang/cargo#9065) - Fix unit_for computation on proc-macros in shared workspace. (rust-lang/cargo#9059) - Document `could not find the github team` error on `cargo owner --add` (rust-lang/cargo#9000) - Unstable section of cargo/config.toml takes bools (rust-lang/cargo#9057) - [doc] add note about empty environment variables for missing manifest keys (rust-lang/cargo#9053) - another round of clippy lint fixes (rust-lang/cargo#9051) - Updated display message of cargo metadata --help (rust-lang/cargo#9050)
This is a small addition to the cargo book.
In the section about the environment variables cargo sets to provide information about a crate, there's no mention about the value of those environment variables is if the key isn't present in the manifest.
As can be seen here¹, the values default to the empty string (instead of, say, not being present), so this change just adds a sentence in the book to clarify that.
If the terminology could be improved or there's a better place for this to be included, I'm happy to change it :)
¹ To be clear, I did also play around with this and found that the environment variables were empty. The code reference was more to double-check that the behavior I saw was a consistent pattern.